supported

Usage

npx supported <path/to/node_module>
npx supported <[array/of/node_modules]>

Optional Flags

The --current-date (-c) flag enables a form of limited time travel, and attempts to run the tools internal date calculations based on a specified date, rather then the current date.

Some examples:

• --current-date="March 31, 2011" runs the tool as if it was March 31, 2021
• --current-date="-3 weeks" runs the tool as if it was 3 weeks ago
• --current-date="3 weeks" runs the tool as if it was 3 weeks from now

The date micro-syntax is described as:

Anything that new Date(input) parses, or if that fails it will assume to be a relative duration starting today parsed by parse-duration@^1.0.0's own micro-syntax.

--config-file

The --config-file(-f) enables to provide a path to the config file with the configurations mentioned here.

// config.json
{
  "custom": [
    {
      "dependencies": ["es6-promise", "rsvp"],
      "effectiveReleaseDate": "Dec 10 2022",
      "upgradeBudget": {
        "major": 4,
        "minor": 4,
        "patch": 4
      }
    }
  ]
}

As a node module

const { processPolicies } = require('supported');
const projectPaths = ['test/fixtures/unsupported-project', 'test/fixtures/supported-project' ];
const jsonResult = await processPolicies(projectPaths);
const projectPaths_2 = 'test/fixtures/unsupported-project';
const jsonResult_2 = await processPolicies(projectPaths_2);

Contributing

Clone the project, make changes and run the tests

git clone git@github.com:stefanpenner/supported.git
cd supported
yarn
yarn test

You can test against the local test fixtures

yarn start:registry
bin/supported tests/fixtures/supported-project
bin/supported tests/fixtures/supported-project tests/fixtures/unsupported-project

supported Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[0.7.0] - 2022-10-04

• Support yarn3 lockfiles

[0.6.3] - 2021-01-07

Bugfixes

• Include ember-source as part of the ember LTS checks (previously only checked ember-cli)
• Fix the LTS check algorithm to not count active lts versions as expired
• Fix LTS warning to accurately report info on unsupported versions. Previously we were showing the intended LTS version end date as the deprecation date.
• Fix LTS warning message to say that the oldest valid version is required, rather than saying the latest LTS version is always required.

[0.6.2] - 2021-01-05

• Updated the LTS configs

[0.6.1] - 2021-10-26

Bugfixes

• Fix some issues with the ignorePrereleases

[0.6.0] - 2021-7-26

Breaking

• End of support dates are now always rounded to the end of the quarter

[0.5.0] - 2021-7-22

Added

• Added support for effectiveReleaseDate in primary policy
• Added support for passing configuration to run()

Breaking

• Dropped support for Node 10, which is no longer LTS
• processPolicies() 5th argument now takes the exact shape defined in CONFIGURATION.md, rather than the previous policies argument and ignoredDependencies argument.

[0.4.0] - 2021-7-22

Added

• Add configuration file feature
• Add ignorePrereleases feature to handle proprietary npm repositories #34
• Improve CI tool UX #18