clippy

Clippy for your atom.

Simon Bartlett

751

2

0.5.0

MIT

GitHub

This package provides the following services:

Clippy

Clippy (and friends) for your Atom.

Clippy and friends

Using Clippy from your Atom package

You can use the Clippy service in your own Atom packages. This requires that the user has the Clippy package installed.

In your package.json file add the following:

  "consumedServices": {
    "clippy": {
      "versions": {
        "^1.0.0": "consumeClippyService"
      }
    }
  }

Then in your plugin code add a consumeClippyService method (also returning a disposable):

{Disposable} = require 'atom'

clippy = null

module.exports =
  consumeClippyService: (service) ->
    clippy = service
    new Disposable -> clippy = null

  activate: ->
    atom.commands.add 'atom-workspace', 'hello', ->
      if clippy
        clippy.speak 'Hello world'

The clippy service object provides the following (more to come):

You can refer to the Raptorize package for a working example.

For more detailed documentation, refer to the Atom documentation.

Special Thanks