Rename Workspace::registerOpener to ::addOpener for consistency

This commit is contained in:
Nathan Sobo
2014-09-30 17:09:35 -06:00
parent 0242e1c4ef
commit 70a804bdb4
3 changed files with 11 additions and 11 deletions

View File

@@ -220,8 +220,8 @@ describe "Workspace", ->
it "returns the resource returned by the custom opener", ->
fooOpener = (pathToOpen, options) -> { foo: pathToOpen, options } if pathToOpen?.match(/\.foo/)
barOpener = (pathToOpen) -> { bar: pathToOpen } if pathToOpen?.match(/^bar:\/\//)
workspace.registerOpener(fooOpener)
workspace.registerOpener(barOpener)
workspace.addOpener(fooOpener)
workspace.addOpener(barOpener)
waitsForPromise ->
pathToOpen = atom.project.resolve('a.foo')

View File

@@ -345,12 +345,12 @@ class Project extends Model
# Deprecated: delegate
registerOpener: (opener) ->
deprecate("Use Workspace::registerOpener instead")
deprecate("Use Workspace::addOpener instead")
atom.workspace.registerOpener(opener)
# Deprecated: delegate
unregisterOpener: (opener) ->
deprecate("Use Workspace::unregisterOpener instead")
deprecate("Call .dispose() on the Disposable returned from ::addOpener instead")
atom.workspace.unregisterOpener(opener)
# Deprecated: delegate

View File

@@ -44,7 +44,7 @@ class Workspace extends Model
@paneContainer ?= new PaneContainer({@viewRegistry})
@paneContainer.onDidDestroyPaneItem(@onPaneItemDestroyed)
@registerOpener (filePath) =>
@addOpener (filePath) =>
switch filePath
when 'atom://.atom/stylesheet'
@open(atom.themes.getUserStylesheetPath())
@@ -349,8 +349,6 @@ class Workspace extends Model
if uri = @destroyedItemUris.pop()
@openSync(uri)
# TODO: make ::registerOpener() return a disposable
# Public: Register an opener for a uri.
#
# An {TextEditor} will be used if no openers return a value.
@@ -358,7 +356,7 @@ class Workspace extends Model
# ## Examples
#
# ```coffee
# atom.project.registerOpener (uri) ->
# atom.project.addOpener (uri) ->
# if path.extname(uri) is '.toml'
# return new TomlEditor(uri)
# ```
@@ -367,13 +365,15 @@ class Workspace extends Model
#
# Returns a {Disposable} on which `.dispose()` can be called to remove the
# opener.
registerOpener: (opener) ->
addOpener: (opener) ->
@openers.push(opener)
new Disposable => _.remove(@openers, opener)
registerOpener: (opener) ->
Grim.deprecate("Call Workspace::addOpener instead")
@addOpener(opener)
# Unregister an opener registered with {::registerOpener}.
unregisterOpener: (opener) ->
Grim.deprecate("Call .dispose() on the Disposable returned from ::registerOpener instead")
Grim.deprecate("Call .dispose() on the Disposable returned from ::addOpener instead")
_.remove(@openers, opener)
getOpeners: ->