Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 1.93 KB

symlinking-updaters.md

File metadata and controls

75 lines (48 loc) · 1.93 KB
Raw

Symlinking updaters

While developing updaters, you might find it useful to symlink them to global node_modules so that Update's CLI will find them and run them, as if they had been installed from npm using npm install --global.

The following example shows you to do this.

Example

1. Create an updater project

Create a new project named updater-aaa. You can expedite this using generate or Google's Yeoman or however you prefer.

2. Add index.js

In index.js, add the following code:

// -- index.js --
module.exports = function(app) {
  app.task('default', function(cb) {
    console.log('updater', app.name, '> task', this.name);
    cb();
  });
};
  • app.name will display the name of the updater being run
  • this.name will display the name of the task being run

(Also make sure the index.js is listed in the main property in package.json, so that node's require() system finds the file)

3. Symlink

Next, we need to symlink the module to global node_modules, so that updater-aaa is discoverable by Update's CLI.

From the root of the updater-aaa project, run the following command:

$ npm link

4. Run

To test that updater-aaa was symlinked properly, run the following command:

$ update aaa

You should see something like the following in the terminal

updater updater-aaa > task default

If not, review the steps and make sure you did everything described. If you still can't get it working please create an issue so we can look into it.

Next steps

If you'd like to see how multiple updaters can work together, repeat the same steps described above to create and symlink updater-bbb and updater-ccc.

Then run:

update aaa bbb ccc

Related

Docs