atom/docs/upgrading/upgrading-your-package.md

Upgrading your package to 1.0 APIs

Atom is rapidly approaching 1.0. Much of the effort leading up to the 1.0 has been cleaning up APIs in an attempt to future proof, and make a more pleasant experience developing packages.

This document will guide you through the large bits of upgrading your package to work with 1.0 APIs.

TL;DR

We've set deprecation messages and errors in strategic places to help make sure you dont miss anything. You should be able to get 95% of the way to an updated package just by fixing errors and deprecations. There are a couple of things you need to do to enable all these errors and deprecations.

Use atom-space-pen-views

Add the atom-space-pen-views module to your package's package.json file's dependencies:

{
  "dependencies": {
    "atom-space-pen-views": "^0.21"
  }
}

Then run apm install in your package directory.

Require views from atom-space-pen-views

Anywhere you are requiring one of the following from atom you need to require them from atom-space-pen-views instead.

// require these from 'atom-space-pen-views' rather than 'atom'
$
$$
$$$
View
TextEditorView
ScrollView
SelectListView

So this:

# Old way
{$, TextEditorView, View, GitRepository} = require 'atom'

Would be replaced with this:

# New way
{GitRepository} = require 'atom'
{$, TextEditorView, View} = require 'atom-space-pen-views'

Run specs and test your package

You wrote specs, right!? Here's where they shine. Run them with cmd-shift-P, and search for run package specs. It will show all the deprecation messages and errors.

Examples

We have upgraded all the core packages. Please see this issue for a link to all the upgrade PRs.

Deprecations

All of the methods in core that have changes will emit deprecation messages when called. These messages are shown in two places: your package specs, and in Deprecation Cop.

Specs

Just run your specs, and all the deprecations will be displayed in yellow.

TODO: image of deprecations in specs

TODO: Comand line spec deprecation image?

Deprecation Cop

Run an atom window in dev mode (atom -d) with your package loaded, and open Deprecation Cop (search for deprecation in the command palette).

TODO: image of deprecations in DepCop

View Changes

Previous to 1.0, views in packages were baked into Atom core. These views were based on jQuery and space-pen. They looked something like this:

# The old way: getting views from atom
{$, TextEditorView, View} = require 'atom'

module.exports =
class SomeView extends View
  @content: ->
    @div class: 'find-and-replace', =>
      @div class: 'block', =>
        @subview 'myEditor', new TextEditorView(mini: true)
  #...

Requiring atom used to provide the following view helpers:

$
$$
$$$
View
TextEditorView
ScrollView
SelectListView

The New

Atom no longer provides these view helpers baked in. Atom core is now 'view agnostic'. The preexisting view system is available from two npm packages: space-pen, and atom-space-pen-views

space-pen now provides

$
$$
$$$
View

atom-space-pen-views now provides all of space-pen, plus Atom specific views:

// Passed through from space-pen
$
$$
$$$
View

// Atom specific views
TextEditorView
ScrollView
SelectListView

Adding the module dependencies

To use the new views, you need to specify the atom-space-pen-views module in your package's package.json file's dependencies:

{
  "dependencies": {
    "atom-space-pen-views": "^0.21"
  }
}

space-pen bundles jQuery. If you do not need space-pen or any of the views, you can require jQuery directly.

{
  "dependencies": {
    "jquery": "^2"
  }
}

Converting your views

Sometimes it is as simple as converting the requires at the top of each view page. In the case of our above example, you can just convert them to the following:

{$, View} = require 'space-pen'
{TextEditorView} = require 'atom-space-pen-views'

If you are using the lifecycle hooks, you will need to update code as well.

Upgrading to space-pen's TextEditorView

You should not need to change anything to use the new TextEditorView! See the docs for more info.

Upgrading to space-pen's ScrollView

See the docs for all the options.

Upgrading to space-pen's SelectListView

Your SelectListView might look something like this:

class CommandPaletteView extends SelectListView
  initialize: ->
    super
    @addClass('command-palette overlay from-top')
    atom.workspaceView.command 'command-palette:toggle', => @toggle()

  confirmed: ({name, jQuery}) ->
    @cancel()
    # do something with the result

  toggle: ->
    if @hasParent()
      @cancel()
    else
      @attach()

  attach: ->
    @storeFocusedElement()

    items = # build items
    @setItems(items)

    atom.workspaceView.append(this)
    @focusFilterEditor()

  confirmed: ({name, jQuery}) ->
    @cancel()

This attaches and detaches itself from the dom when toggled, canceling magically detaches it from the DOM, and it uses the classes overlay and from-top.

Using the new APIs it should look like this:

class CommandPaletteView extends SelectListView
  initialize: ->
    super
    # no more need for the `overlay` and `from-top` classes
    @addClass('command-palette')
    atom.workspaceView.command 'command-palette:toggle', => @toggle()

  # You need to implement the `cancelled` method and hide.
  cancelled: ->
    @hide()

  confirmed: ({name, jQuery}) ->
    @cancel()
    # do something with the result

  toggle: ->
    # Toggling now checks panel visibility,
    # and hides / shows rather than attaching to / detaching from the DOM.
    if @panel?.isVisible()
      @cancel()
    else
      @show()

  show: ->
    # Now you will add your select list as a modal panel to the workspace
    @panel ?= atom.workspace.addModalPanel(item: this)
    @panel.show()

    @storeFocusedElement()

    items = # build items
    @setItems(items)

    @focusFilterEditor()

  hide: ->
    @panel?.hide()

See the SelectListView docs for all the options. And check out the conversion of CommandPaletteView as a real-world example.

Specs

TODO: come up with patterns for converting away from using workspaceView and editorViews everywhere.