Merge pull request #7128 from electron/api-breakage-list

Document what APIs will break in Electron 2.0

atom/browser/api/atom_api_web_contents.cc

@@ -948,6 +948,8 @@ void WebContents::OpenDevTools(mate::Arguments* args) {
     mate::Dictionary options;
     if (args->GetNext(&options)) {
       options.Get("mode", &state);
+
+      // TODO(kevinsawicki) Remove in 2.0
       options.Get("detach", &detach);
       if (state.empty() && detach)
         state = "detach";

docs/tutorial/planned-breaking-changes.md

@@ -0,0 +1,78 @@
+# Planned Breaking API Changes
+
+The following list includes the APIs that will be removed in Electron 2.0.
+
+There is no timetable for when this release will occur but deprecation
+warnings will be added at least 90 days beforehand.
+
+## `BrowserWindow`
+
+```js
+// Deprecated
+let optionsA = {webPreferences: {blinkFeatures: ''}}
+let windowA = new BrowserWindow(optionsA)
+// Replace with
+let optionsB = {webPreferences: {enableBlinkFeatures: ''}}
+let windowB = new BrowserWindow(optionsB)
+```
+
+## `clipboard`
+
+```js
+// Deprecated
+clipboard.readRtf()
+// Replace with
+clipboard.readRTF()
+
+// Deprecated
+clipboard.writeRtf()
+// Replace with
+clipboard.writeRTF()
+
+// Deprecated
+clipboard.readHtml()
+// Replace with
+clipboard.readHTML()
+
+// Deprecated
+clipboard.writeHtml()
+// Replace with
+clipboard.writeHTML()
+```
+
+## `nativeImage`
+
+```js
+// Deprecated
+nativeImage.toPng()
+// Replace with
+nativeImage.toPNG()
+
+// Deprecated
+nativeImage.toJpeg()
+// Replace with
+nativeImage.toJPEG()
+```
+
+## `Tray`
+
+```js
+// Deprecated
+tray.setHighlightMode(true)
+// Replace with
+tray.setHighlightMode('on')
+
+// Deprecated
+tray.setHighlightMode(false)
+// Replace with
+tray.setHighlightMode('off')
+```
+
+## `webContents`
+
+```js
+// Deprecated
+webContents.openDevTools({detach: true})
+// Replace with
+webContents.openDevTools({mode: 'detach'})
+```