Publishing a package to npm

Once we have defined our package's metadata, publishing it to npm is very straightforward:

  • If you do not already have an npm account, create one by running npm adduser and specifying a username and password
  • Log in using npm login
  • In the root folder of the package, run npm publish

That's all we need to do! Our package will now appear in the global npm repository. We can make use of it by (in a new folder) running npm install autotoc and writing the following simple demo script as given in demo.js:

'use strict';
const autotoc = require('autotoc');
autotoc('http://hgc.io')
    .then(autotoc.consolePrinter, err => console.log(err));

Running node demo.js at the command line produces the following output:

Running automated clients on ...

Get Learning Node.js for .NET Developers now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.