Merge pull request #1824 from atom/cj-warn-deprecations

Add deprecation warnings

package.json

@@ -27,6 +27,7 @@
     "fstream": "0.1.24",
     "fuzzaldrin": "~1.1",
     "git-utils": "^1.2.2",
+    "grim": "0.6.0",
     "guid": "0.0.10",
     "jasmine-tagged": "^1.1.1",
     "keytar": "1.x",

src/atom.coffee

@@ -8,6 +8,7 @@ screen = require 'screen'
 shell = require 'shell'
 
 _ = require 'underscore-plus'
+{deprecated} = require 'grim'
 {Model} = require 'theorist'
 fs = require 'fs-plus'
 
@@ -180,9 +181,11 @@ class Atom extends Model
 
   # Deprecated: Callers should be converted to use atom.deserializers
   registerRepresentationClass: ->
+    deprecated("Callers should be converted to use atom.deserializers")
 
   # Deprecated: Callers should be converted to use atom.deserializers
   registerRepresentationClasses: ->
+    deprecated("Callers should be converted to use atom.deserializers")
 
   setBodyPlatformClass: ->
     document.body.classList.add("platform-#{process.platform}")

src/editor.coffee

@@ -2,6 +2,7 @@ _ = require 'underscore-plus'
 path = require 'path'
 Serializable = require 'serializable'
 Delegator = require 'delegato'
+{deprecate} = require 'grim'
 {Model} = require 'theorist'
 {Point, Range} = require 'text-buffer'
 LanguageMode = require './language-mode'
@@ -998,6 +999,7 @@ class Editor extends Model
 
   # Deprecated: Use {::duplicateLines} instead.
   duplicateLine: ->
+    deprecate("Use Editor::duplicateLines() instead")
     @duplicateLines()
 
   mutateSelectedText: (fn) ->
@@ -1765,4 +1767,5 @@ class Editor extends Model
 
   # Deprecated: Call {::joinLines} instead.
   joinLine: ->
+    deprecate("Use Editor::joinLines() instead")
     @joinLines()

src/pane-container-view.coffee

@@ -1,3 +1,4 @@
+{deprecate} = require 'grim'
 Delegator = require 'delegato'
 {$, View} = require './space-pen-extensions'
 PaneView = require './pane-view'
@@ -146,4 +147,5 @@ class PaneContainerView extends View
 
   # Deprecated
   getPanes: ->
+    deprecate("Use PaneContainerView::getPaneViews() instead")
     @getPaneViews()

src/pane-view.coffee

@@ -1,5 +1,6 @@
 {$, View} = require './space-pen-extensions'
 Delegator = require 'delegato'
+{deprecate} = require 'grim'
 PropertyAccessors = require 'property-accessors'
 
 Pane = require './pane'
@@ -81,22 +82,34 @@ class PaneView extends View
     @command 'pane:close-other-items', => @destroyInactiveItems()
 
   # Deprecated: Use ::destroyItem
-  removeItem: (item) -> @destroyItem(item)
+  removeItem: (item) ->
+    deprecate("Use PaneView::destroyItem instead")
+    @destroyItem(item)
 
   # Deprecated: Use ::activateItem
-  showItem: (item) -> @activateItem(item)
+  showItem: (item) ->
+    deprecate("Use PaneView::activateItem instead")
+    @activateItem(item)
 
   # Deprecated: Use ::activateItemForUri
-  showItemForUri: (item) -> @activateItemForUri(item)
+  showItemForUri: (item) ->
+    deprecate("Use PaneView::activateItemForUri instead")
+    @activateItemForUri(item)
 
   # Deprecated: Use ::activateItemAtIndex
-  showItemAtIndex: (index) -> @activateItemAtIndex(index)
+  showItemAtIndex: (index) ->
+    deprecate("Use PaneView::activateItemAtIndex instead")
+    @activateItemAtIndex(index)
 
   # Deprecated: Use ::activateNextItem
-  showNextItem: -> @activateNextItem()
+  showNextItem: ->
+    deprecate("Use PaneView::destroyItem instead")
+    @activateNextItem()
 
   # Deprecated: Use ::activatePreviousItem
-  showPreviousItem: -> @activatePreviousItem()
+  showPreviousItem: ->
+    deprecate("Use PaneView::activatePreviousItem instead")
+    @activatePreviousItem()
 
   afterAttach: (onDom) ->
     @focus() if @model.focused and onDom

src/project.coffee

@@ -4,6 +4,7 @@ url = require 'url'
 _ = require 'underscore-plus'
 fs = require 'fs-plus'
 Q = require 'q'
+{deprecate} = require 'grim'
 {Model} = require 'theorist'
 {Emitter, Subscriber} = require 'emissary'
 Serializable = require 'serializable'
@@ -127,6 +128,7 @@ class Project extends Model
 
   # Deprecated
   openSync: (filePath, options={}) ->
+    deprecate("Use Project::open instead")
     filePath = @resolve(filePath)
     @buildEditorForBuffer(@bufferForPathSync(filePath), options)
 
@@ -177,6 +179,7 @@ class Project extends Model
 
   # DEPRECATED
   buildBufferSync: (absoluteFilePath) ->
+    deprecate("Use Project::buildBuffer instead")
     buffer = new TextBuffer({filePath: absoluteFilePath})
     @addBuffer(buffer)
     buffer.loadSync()
@@ -317,17 +320,21 @@ class Project extends Model
 
   # Deprecated: delegate
   registerOpener: (opener) ->
+    deprecate("Use Workspace::registerOpener instead")
     @openers.push(opener)
 
   # Deprecated: delegate
   unregisterOpener: (opener) ->
+    deprecate("Use Workspace::unregisterOpener instead")
     _.remove(@openers, opener)
 
   # Deprecated: delegate
   eachEditor: (callback) ->
+    deprecate("Use Workspace::eachEditor instead")
     callback(editor) for editor in @getEditors()
     @on 'editor-created', (editor) -> callback(editor)
 
   # Deprecated: delegate
   getEditors: ->
+    deprecate("Use Workspace::getEditors instead")
     new Array(@editors...)

src/syntax.coffee

@@ -1,4 +1,5 @@
 _ = require 'underscore-plus'
+{deprecate} = require 'grim'
 {specificity} = require 'clear-cut'
 {Subscriber} = require 'emissary'
 {GrammarRegistry, ScopeSelector} = require 'first-mate'
@@ -35,7 +36,9 @@ class Syntax extends GrammarRegistry
   createToken: (value, scopes) -> new Token({value, scopes})
 
   # Deprecated: Used by settings-view to display snippets for packages
-  @::accessor 'scopedProperties', -> @propertyStore.propertySets
+  @::accessor 'scopedProperties', ->
+    deprecate("Use Syntax::getProperty instead")
+    @propertyStore.propertySets
 
   addProperties: (args...) ->
     name = args.shift() if args.length > 2

src/workspace-view.coffee

@@ -3,6 +3,7 @@ path = require 'path'
 Q = require 'q'
 _ = require 'underscore-plus'
 Delegator = require 'delegato'
+{deprecate, logDeprecationWarnings} = require 'grim'
 scrollbarStyle = require 'scrollbar-style'
 {$, $$, View} = require './space-pen-extensions'
 fs = require 'fs-plus'
@@ -140,8 +141,8 @@ class WorkspaceView extends View
     @command 'window:focus-pane-on-left', => @focusPaneViewOnLeft()
     @command 'window:focus-pane-on-right', => @focusPaneViewOnRight()
     @command 'window:save-all', => @saveAll()
-    @command 'window:toggle-invisibles', =>
-      atom.config.toggle("editor.showInvisibles")
+    @command 'window:toggle-invisibles', -> atom.config.toggle("editor.showInvisibles")
+    @command 'window:log-deprecation-warnings', -> logDeprecationWarnings()
 
     @command 'window:toggle-auto-indent', =>
       atom.config.toggle("editor.autoIndent")
@@ -334,16 +335,20 @@ class WorkspaceView extends View
 
   # Deprecated
   eachPane: (callback) ->
+    deprecate("Use WorkspaceView::eachPaneView instead")
     @eachPaneView(callback)
 
   # Deprecated
   getPanes: ->
+    deprecate("Use WorkspaceView::getPaneViews instead")
     @getPaneViews()
 
   # Deprecated
   getActivePane: ->
+    deprecate("Use WorkspaceView::getActivePaneView instead")
     @getActivePaneView()
 
   # Deprecated: Call {Workspace::getActivePaneItem} instead.
   getActivePaneItem: ->
+    deprecate("Use Workspace::getActivePaneItem instead")
     @model.activePaneItem

src/workspace.coffee

@@ -1,3 +1,4 @@
+{deprecate} = require 'grim'
 {remove, last} = require 'underscore-plus'
 {join} = require 'path'
 {Model} = require 'theorist'
@@ -114,6 +115,8 @@ class Workspace extends Model
   #   :activatePane - A {Boolean} indicating whether to call {Pane::activate} on
   #                   the containing pane. Defaults to `true`.
   openSync: (uri='', options={}) ->
+    deprecate("Don't use the `changeFocus` option") if options.changeFocus?
+
     {initialLine} = options
     # TODO: Remove deprecated changeFocus option
     activatePane = options.activatePane ? options.changeFocus ? true

vendor/apm

@@ -1 +1 @@
-Subproject commit 8c4957c489f2aa0ebd0446647bfc4e69227970d8
+Subproject commit 2ce1206e6720c133fd2acf53bebeb9b37de2b65a