audit-age

audit-age

A Node.js CLI and equivalent JS API to audit the age of installed production npm packages.

Installation

Note

Installation isn’t required to use the CLI command audit-age with npx.

To install audit-age with npm, run:

npm install audit-age --save-dev

Then, use either the CLI command audit-age or the function auditAge.

Requirements

Supported runtime environments:

• Node.js versions ^14.17.0 || ^16.0.0 || >= 18.0.0.

Projects must configure TypeScript to use types from the ECMAScript modules that have a // @ts-check comment:

• compilerOptions.allowJs should be true.
• compilerOptions.maxNodeModuleJsDepth should be reasonably large, e.g. 10.
• compilerOptions.module should be "node16" or "nodenext".

CLI

Command audit-age

Audits the age of installed production npm packages.

It implements the function auditAge.

Examples

Using npx in a package directory with installed dependencies:

npx audit-age

Exports

The npm package audit-age features optimal JavaScript module design. It doesn’t have a main index module, so use deep imports from the ECMAScript modules that are exported via the package.json field exports:

• auditAge.mjs

Changelog

3.0.0

Major

• Updated Node.js support to ^14.17.0 || ^16.0.0 || >= 18.0.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.
• Use the node: URL scheme for Node.js builtin module imports.
• Migrated from the Node.js builtin module fs to node:fs/promises.

Patch

• Updated dependencies.
• Updated jsconfig.json:
  • Set compilerOptions.maxNodeModuleJsDepth to 10.
  • Set compilerOptions.module to nodenext.
• Updated ESLint config.
• Updated GitHub Actions CI config:
  • Run tests with Node.js v14, v16, v18.
  • Updated actions/checkout to v3.
  • Updated actions/setup-node to v3.
• Tweaked the package bin field.
• Replaced TypeScript Record types with index signatures.
• Renamed the snapshot import to assertSnapshot in tests.
• Revamped the readme:
  • Removed the badges.
  • Added a “Requirements” section.
  • Added information about TypeScript config and optimal JavaScript module design.