# supported

> ## Usage

Latest version **0.7.5** (published 2023-08-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install supported
pnpm add supported
yarn add supported
bun add supported
```

Provides the command `supported`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.5 |
| Published | 2023-08-30 |
| First published | 2021-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 12.* \|\| 14.* \|\| >= 15 |
| Dependencies | 26 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Stefan Penner |
| Maintainers | asakusuma, stefanpenner, suchitadoshi1987, snrai |

## Links

- npm: https://www.npmjs.com/package/supported
- Repository: https://github.com/supportedjs/supported
- Issues: https://github.com/supportedjs/supported/issues
- npm.io page: https://npm.io/package/supported

## Dependencies (26)

- [ajv](https://npm.io/package/ajv.md) ^8.6.0
- [ini](https://npm.io/package/ini.md) ^1.3.7
- [koa](https://npm.io/package/koa.md) ^2.13.0
- [ora](https://npm.io/package/ora.md) ^5.1.0
- [meow](https://npm.io/package/meow.md) ^8.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [debug](https://npm.io/package/debug.md) ^4.3.1
- [execa](https://npm.io/package/execa.md) ^5.0.0
- [moment](https://npm.io/package/moment.md) ^2.29.1
- [semver](https://npm.io/package/semver.md) ^7.3.4
- [p-queue](https://npm.io/package/p-queue.md) ^6.6.2
- [json2csv](https://npm.io/package/json2csv.md) ^5.0.6
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.4
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^6.0.0
- [resolve-path](https://npm.io/package/resolve-path.md) ^1.4.0
- [terminal-link](https://npm.io/package/terminal-link.md) ^2.1.1
- [camelcase-keys](https://npm.io/package/camelcase-keys.md) ^6.2.2
- [minipass-fetch](https://npm.io/package/minipass-fetch.md) ^1.3.2
- [parse-duration](https://npm.io/package/parse-duration.md) ^1.0.0
- [npm-package-arg](https://npm.io/package/npm-package-arg.md) ^8.1.0
- [@yarnpkg/parsers](https://npm.io/package/@yarnpkg/parsers.md) ^2.5.1
- [chai-as-promised](https://npm.io/package/chai-as-promised.md) ^7.1.1
- [@yarnpkg/lockfile](https://npm.io/package/@yarnpkg/lockfile.md) ^1.1.0
- [npm-registry-fetch](https://npm.io/package/npm-registry-fetch.md) ^9.0.0
- [parse-package-name](https://npm.io/package/parse-package-name.md) ^1.0.0
- [promise.allsettled](https://npm.io/package/promise.allsettled.md) ^1.0.4

## Recent versions

- 0.7.5 (latest) — 2023-08-30
- 0.7.4 — 2023-03-24
- 0.7.3 — 2022-12-13
- 0.7.2 — 2022-10-21
- 0.7.1 — 2022-10-06
- 0.7.0 — 2022-10-04
- 0.6.7 — 2022-10-04
- 0.6.6 — 2022-05-16
- 0.6.5 — 2022-04-20
- 0.6.4 — 2022-01-08
- 0.6.3 — 2022-01-07
- 0.6.2 — 2022-01-05
- 0.6.1 — 2021-10-27
- 0.6.0 — 2021-07-27
- 0.5.0 — 2021-07-23
- … 11 more at https://npm.io/package/supported/versions

## README

# supported [![CI](https://github.com/supportedjs/supported/workflows/CI/badge.svg)](https://github.com/stefanpenner/supported/actions/workflows/ci.yml)

## Usage

```sh
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](https://github.com/jkroso/parse-duration#available-unit-types-are).

##### --config-file
The `--config-file`(`-f`) enables to provide a path to the config file with the configurations mentioned [here](./CONFIGURATION.md).
```
// config.json
{
  "custom": [
    {
      "dependencies": ["es6-promise", "rsvp"],
      "effectiveReleaseDate": "Dec 10 2022",
      "upgradeBudget": {
        "major": 4,
        "minor": 4,
        "patch": 4
      }
    }
  ]
}
```
### As a node module


```js
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
```bash
git clone git@github.com:stefanpenner/supported.git
cd supported
yarn
yarn test
```
You can test against the local test fixtures
```bash
yarn start:registry
bin/supported tests/fixtures/supported-project
bin/supported tests/fixtures/supported-project tests/fixtures/unsupported-project
```

---
_Source: https://npm.io/package/supported · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._