Quick use¶

Examples of basic migration to pkg-js-tools:
Switch test and install to pkg-js-tools

How it works¶

pkg-js-tools provides hooks for these steps:

Technically, it adds --buildsystem=nodejs to the corresponding dh_auto_<step>
command.

Important note. Here:

See Group Sources Tutorial

for more about embedding components.

Details:

Automatically detect some additional components¶

Starting from 0.12.0, dh-sequence-nodejs automatically reads lerna.conf and
reads "packages" field to find additional components.

Starting from 0.12.7, it does the same when package.json has a "workspaces"
field.

This auto-detection automatically drops "test" and "tests" directories. You
can override this behavior using debian/additional_components.

If a component should not be considered, insert its name preceded by a "!" in
debian/nodejs/additional_components.

To disable this feature, use dh-sequence-nodejs-no-lerna.

Algorithm to determine files to install¶

pkg-js-tools tries to reproduce npm(1) behavior: it reads package.json
and/or .npmignore files to determine files to install except that it drops
licenses, *.md, doc*, example*, test*, makefiles,...`.

This behavior is overridden if:

pkg-js-tools files¶

To install a component in another directory, set its files in
debian/install.

Example:

...
Testsuite: autopkgtest-pkg-nodejs
Build-Depends: dh-sequence-nodejs
...

mocha -R spec

See also pkg-js-autopkgtest README.

Multiple binary packages¶

When debian/control provides more than one binary package, dh_auto_install
populates a debian/tmp and dh_install install files in each package. In
this case, you must write a debian/<package>.install for each binary
package. Each line with only one argument is related to debian/tmp.
Examples:

Links¶

Since path is not fixed for arch-dependent package, you must write
debian/nodejs/links:

# debian/nodejs/links
foo/bin/cli.js  /usr/bin/foo

With a arch independent package, pkg-js-tools transforms this into:

/usr/share/nodejs/foo/bin/cli.js    /usr/bin/foo

and for a arch dependent package, it uses DEB_GNU_ARCH. Example with amd64:

/usr/lib/x86_64-linux-gnu/foo/bin/cli.js  /usr/bin/foo

All fields that does not start with / are prefixed with the good nodejs path

Component docs¶

Starting from version 0.13.0, pkg-js-tools provides dh_nodejs_autodocs.
This tool automatically install README.md, CONTRIBUTING.md,... for each
root component in its /usr/share/doc/node-<name> directory. And if no
debian/*docs is found, it does the same for the main component. To use it:

override_dh_installdocs:


 dh_installdocs


 dh_nodejs_autodocs

.eslint* files¶

pkg-js-tools auto installer always removes .eslint* files unless it
is explicitly specified in debian/nodejs/**/files or
debian/nodejs/**/install.

Having different test between build and autopkgtest¶

When debian/nodejs/test exists, this file is used during build test instead
of debian/tests/pkg-js/test. This permits one to have a different test. You can
also overwrite dh_auto_test step in debian/rules:

override_dh_auto_test:


      # No test during build (test needs Internet)

Autopkgtest additional test packages or test restrictions¶

autodep8 allows one to add additional packages during autopkgtest (and/or
additional restrictions) by using a debian/tests/autopkgtest-pkg-nodejs.conf
file:

extra_depends=mocha, npm
extra-restrictions=needs-internet