node-support v0.0.0-development

node-support

List the Node.js versions supported by the package/repository

Usage (command line)

$ npx node-support [path]

Prints the supported Node.js versions for the package at the specified path. When the path is not a git repository - tries to read the git repository from package.json and tries to detect the versions listed in the repository as well.

When path is omitted, tries to detect the versions for cwd.

$ npx node-support [package name]

Prints supported Node.js versions for the package from the registry.

$ npx node-support [repository git URL]

Prints supported Node.js versions for the package at the git URL.

Usage (library)

const result = await require('node-support').detect({ path });

path should be a folder in the local file system. When the path is not a git repository - tries to read the git repository from package.json and tries to detect the versions listed in the repository as well.

const result = await require('node-support').detect({ package });

package is a string name for the package in the registry.

const result = await require('node-support').detect({ repository });

repository is a URL for a git repository.

Result

• Throws if the path / repository does not have a package.json
• Throws if package does not exist in the registry

Otherwise returns an object with:

const result = {

    // the "name" field of the `package.json`
    name: "package-name",    
    
    // the "version" field of the `package.json` when used with `path` / `repository`,
    // the `latest` dist-tag version when used with `package`
    version: "0.0.0",

    // the current time when the result is returned
    timestamp: 1577115956099,

    // git commit hash of the repository HEAD at the time of scanning
    // will be left out when no git repository detected
    commit: "2de28c8c4ab8ac998d403509123736929131908c",

    // will be left out when not present in the `package.json`
    // a copy of the `engines.node` field from the `package.json` if present
    engines: ">=x.y.z", 

    // will be left out when `.travis.yml` file is not present
    travis: {
        // the list of versions as detected by inspecting `node_js` / `matrix` configuration
        // will be an empty array when no versions are detected or the project is not a Node.js project
        // will contain "latest" when `language: node_js` specified, but no explicit versions detected
        raw: ["8", "10", "lts/*"],

        // raw version specifiers and keywords resolved to exact Node.js versions
        resolved: ["8.17.0", "10.18.0", "12.14.0"]
    }
}