Repository files navigation

When an author releases an Open Source package there are many different levelsof support they may intend to provide. TheNode.js Package Maintenance Working Groupis working to proposea spec to help package authors declare their intended support goals. This package providessome tooling around working with the format proposed.

This repository is managed by thePackage Maintenance Working Group, seeGovernance.

A command line tool is provided which supports the following commands:

• show - show the support info for the package tree.
• validate - validate support info for a package, to be used by amaintainer before publishing.
• create - setup a support declaration for a package.

These commands support the following options:

• --canonical - prefer canonical data over package support datathat may be available locally. Default isfalse.
• --fetch - if local support data is not available or --canonicalis specified, fetch the support data from the remote canonicallocation when needed. Default isfalse
• --base-path - directory root within which the tool can read/validatepackage support files. The default is the directory from which thepackage.json for the top level package was read.

More details and explanation of the use cases for thesecommands is provided incommand line usage.

The simplest way to run the tool is to simply run:

npx @pkgjs/support show

npx @pkgjs/support validate

npx @pkgjs/support create