{"id":16429941,"url":"https://github.com/smarlhens/npm-check-engines","last_synced_at":"2025-07-31T05:10:02.532Z","repository":{"id":36993881,"uuid":"497585648","full_name":"smarlhens/npm-check-engines","owner":"smarlhens","description":"Compute package engines constraint to the most restrictive range version used by your dependencies.","archived":false,"fork":false,"pushed_at":"2025-07-29T06:39:58.000Z","size":1611,"stargazers_count":1,"open_issues_count":7,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-29T08:48:48.607Z","etag":null,"topics":["check","engines","nce","node","nodejs","npm","npm-check-engines","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@smarlhens/npm-check-engines","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smarlhens.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-29T12:34:43.000Z","updated_at":"2023-10-02T09:19:23.000Z","dependencies_parsed_at":"2023-12-30T01:46:55.427Z","dependency_job_id":"a34ffaf9-f8a5-428b-80ba-3ab1f51d4a8f","html_url":"https://github.com/smarlhens/npm-check-engines","commit_stats":{"total_commits":236,"total_committers":6,"mean_commits":"39.333333333333336","dds":0.4491525423728814,"last_synced_commit":"056fd37c340309e7e801ed277f5171ff81cc0b95"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/smarlhens/npm-check-engines","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fnpm-check-engines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fnpm-check-engines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fnpm-check-engines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fnpm-check-engines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smarlhens","download_url":"https://codeload.github.com/smarlhens/npm-check-engines/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fnpm-check-engines/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267989051,"owners_count":24177020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["check","engines","nce","node","nodejs","npm","npm-check-engines","typescript"],"created_at":"2024-10-11T08:24:59.737Z","updated_at":"2025-07-31T05:10:02.510Z","avatar_url":"https://github.com/smarlhens.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NPM check engines\n\n[![CodeQL](https://github.com/smarlhens/npm-check-engines/workflows/codeql/badge.svg)](https://github.com/smarlhens/npm-check-engines/actions/workflows/codeql.yml)\n[![GitHub CI](https://github.com/smarlhens/npm-check-engines/workflows/ci/badge.svg)](https://github.com/smarlhens/npm-check-engines/actions/workflows/ci.yml)\n![node-current (scoped)](https://img.shields.io/node/v/@smarlhens/npm-check-engines)\n[![GitHub license](https://img.shields.io/github/license/smarlhens/npm-check-engines)](https://github.com/smarlhens/npm-check-engines)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n\n**npm-check-engines upgrades your package.json node engines constraint to the most restrictive used by your dependencies.**\n\n---\n\n## Table of Contents\n\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [CLI](#cli)\n  - [Node](#node)\n- [CLI Options](#cli-options)\n- [Debug](#debug)\n- [Thanks](#thanks)\n\n---\n\n## Prerequisites\n\n- [Node.JS](https://nodejs.org/en/download/) **version ^18.12.0 || ^20.0.0**\n\n---\n\n## Installation\n\nInstall globally:\n\n```sh\nnpm install -g @smarlhens/npm-check-engines\n```\n\nOr run with [npx](https://docs.npmjs.com/cli/v8/commands/npx):\n\n```sh\nnpx @smarlhens/npm-check-engines\n```\n\n---\n\n## Usage\n\n### CLI\n\nShow the most restrictive constraint (**opinionated**) of the node engine for the project in the current directory based on the npm `package-lock.json` file:\n\n```sh\n$ nce\n✔ Computed engines range constraints:\n\n node  *  →  ^14.17.0 || ^16.10.0 || \u003e=17.0.0\n\nRun nce -u to upgrade package.json.\n```\n\nUpgrade a project's `package.json` file:\n\n```sh\n$ nce -u\n✔ Computed engines range constraints:\n\n node  *  →  ^14.17.0 || ^16.10.0 || \u003e=17.0.0\n```\n\n### Node\n\n```typescript\nimport { checkEnginesFromString, validatePackageJson, validatePackageLock } from '@smarlhens/npm-check-engines';\n\nlet packageJsonString = ''; // load content of package.json as stringified JSON\nlet packageLockString = ''; // load content of package-lock.json as stringified JSON\n\nvalidatePackageJson({ packageJsonString }); // can throw Errors if unexpected format\nvalidatePackageLock({ packageLockString }); // can throw Errors if unexpected format\n\n// packageJson is the content of your package.json with updated engines\n// packageLock is the content of your package-lock.json with updated engines of the root project in packages\n// enginesRangeToSet contains changes if you want to display them\nconst { enginesRangeToSet, packageJson, packageLock } = checkEnginesFromString({\n  packageJsonString,\n  packageLockString,\n});\nconsole.log(packageJson);\nconsole.log(packageLock);\nconsole.log(\n  enginesRangeToSet\n    .map(({ engine, range, rangeToSet }) =\u003e `${engine} range \"${range}\" replaced by \"${rangeToSet}\"`)\n    .join('\\n'),\n);\n```\n\n---\n\n## CLI Options\n\n```text\nUsage: nce [options]\n\nOptions:\n  -q, --quiet    Enable quiet mode.                                             [boolean] [default: false]\n  -d, --debug    Enable debug mode. Can be used with environment variable DEBUG=nce.\n                                                                                [boolean] [default: false]\n  -v, --verbose  A little more detailed than the default output.                [boolean] [default: false]\n  -e, --engines  Select engines to check. Default will check all engines defined.                  [array]\n  -u, --update   Update engines in package.json and package-lock.json.          [boolean] [default: false]\n      --enableEngineStrict  Enable engine strict.                               [boolean] [default: false]\n      --help     Show help                                                                       [boolean]\n      --version  Show version number                                                             [boolean]\n\nExamples:\n  nce                 Check package-lock.json file in current working directory.\n\n© 2023 Samuel MARLHENS\n```\n\n---\n\n## Debug\n\n```sh\n$ DEBUG=* nce -d\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003eoutput with debug\u003c/summary\u003e\n\n```text\n[STARTED] Checking npm package engines range constraints in package-lock.json...\n[STARTED] Reading package-lock.json...\n[SUCCESS] Reading package-lock.json...\n[STARTED] Reading package.json...\n[SUCCESS] Reading package.json...\n[STARTED] Validating package-lock.json...\n[SUCCESS] Validating package-lock.json...\n[STARTED] Validating package.json...\n[SUCCESS] Validating package.json...\n[STARTED] Compute engines range constraints...\n  nce:node Package  has no constraints for current engine +0ms\n  nce:node Final computed engine range constraint: * +1ms\n  nce:node Package  has no engines +0ms\n  nce:node Compare: * and \u003e=6.9.0 +1ms\n  nce:node Range \u003e=6.9.0 is a subset of * +1ms\n  nce:node New most restrictive range: \u003e=6.9.0 +0ms\n  nce:node Compare: \u003e=6.9.0 and \u003e=12.22.0 +0ms\n  nce:node Range \u003e=12.22.0 is a subset of \u003e=6.9.0 +0ms\n  nce:node New most restrictive range: \u003e=12.22.0 +0ms\n  nce:node Ignored range: * +0ms\n  nce:node Compare: \u003e=12.22.0 and \u003e=7.0.0 +1ms\n  nce:node Range \u003e=12.22.0 is a subset of \u003e=7.0.0 +0ms\n  nce:node Package node_modules/noengines has no engines +0ms\n  nce:node Compare: \u003e=12.22.0 and \u003e=12.13.0 \u003c13.0.0-0||\u003e=14.15.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 +1ms\n  nce:node Applying minimal version 12.22.0 to both ranges. +0ms\n  nce:node Compare: \u003e=12.22.0 and \u003e=12.22.0 \u003c13.0.0-0||\u003e=14.15.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 +1ms\n  nce:node Range \u003e=12.22.0 \u003c13.0.0-0||\u003e=14.15.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 is a subset of \u003e=12.22.0 +0ms\n  nce:node New most restrictive range: \u003e=12.22.0 \u003c13.0.0-0||\u003e=14.15.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 +0ms\n  nce:node Compare: \u003e=12.22.0 \u003c13.0.0-0||\u003e=14.15.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 and \u003e=16.0.0||\u003e=14.17.0 \u003c15.0.0-0 +1ms\n  nce:node Applying minimal version 14.17.0 to both ranges. +0ms\n  nce:node Compare: \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 and \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.0.0 +0ms\n  nce:node Range \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 is a subset of \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.0.0 +0ms\n  nce:node New most restrictive range: \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 +1ms\n  nce:node Final computed engine range constraint: \u003e=14.17.0 \u003c15.0.0-0||\u003e=16.10.0 \u003c17.0.0-0||\u003e=17.0.0 +0ms\n  nce:npm Package  has no constraints for current engine +0ms\n  nce:npm Final computed engine range constraint: * +0ms\n  nce:npm Package  has no engines +0ms\n  nce:npm Package node_modules/foo has no constraints for current engine +0ms\n  nce:npm Compare: * and \u003e=6.0.0 +1ms\n  nce:npm Range \u003e=6.0.0 is a subset of * +0ms\n  nce:npm New most restrictive range: \u003e=6.0.0 +0ms\n  nce:npm Package node_modules/all has no constraints for current engine +0ms\n  nce:npm Package node_modules/arr has no constraints for current engine +0ms\n  nce:npm Package node_modules/noengines has no engines +0ms\n  nce:npm Package node_modules/complex1 has no constraints for current engine +0ms\n  nce:npm Package node_modules/complex2 has no constraints for current engine +0ms\n  nce:npm Final computed engine range constraint: \u003e=6.0.0 +0ms\n  nce:yarn Package  has no constraints for current engine +0ms\n  nce:yarn Final computed engine range constraint: * +0ms\n  nce:yarn Package  has no engines +0ms\n  nce:yarn Package node_modules/foo has no constraints for current engine +1ms\n  nce:yarn Compare: * and \u003e=1.22.4 \u003c2.0.0-0 +0ms\n  nce:yarn Range \u003e=1.22.4 \u003c2.0.0-0 is a subset of * +0ms\n  nce:yarn New most restrictive range: \u003e=1.22.4 \u003c2.0.0-0 +0ms\n  nce:yarn Package node_modules/all has no constraints for current engine +0ms\n  nce:yarn Package node_modules/arr has no constraints for current engine +0ms\n  nce:yarn Package node_modules/noengines has no engines +0ms\n  nce:yarn Package node_modules/complex1 has no constraints for current engine +0ms\n  nce:yarn Package node_modules/complex2 has no constraints for current engine +0ms\n  nce:yarn Final computed engine range constraint: \u003e=1.22.4 \u003c2.0.0-0 +0ms\n[SUCCESS] Compute engines range constraints...\n[STARTED] Output computed engines range constraints...\n  nce:node Simplified computed engine range constraint: ^14.17.0 || ^16.10.0 || \u003e=17.0.0 +0ms\n  nce:npm Simplified computed engine range constraint: \u003e=6.0.0 +0ms\n  nce:yarn Simplified computed engine range constraint: ^1.22.4 +0ms\n[TITLE] Computed engines range constraints:\n[TITLE]\n[TITLE]  node  *  →  ^14.17.0 || ^16.10.0 || \u003e=17.0.0\n[TITLE]  npm   *  →  \u003e=6.0.0\n[TITLE]  yarn  *  →  ^1.22.4\n[TITLE]\n[TITLE] Run nce -d -u to upgrade package.json.\n[SUCCESS] Output computed engines range constraints...\n[STARTED] Enabling engine-strict using .npmrc...\n[SKIPPED] Enabling engine-strict is disabled by default.\n[STARTED] Updating package.json...\n[SKIPPED] Update is disabled by default.\n[SUCCESS] Computed engines range constraints:\n[SUCCESS]\n[SUCCESS]  node  *  →  ^14.17.0 || ^16.10.0 || \u003e=17.0.0\n[SUCCESS]  npm   *  →  \u003e=6.0.0\n[SUCCESS]  yarn  *  →  ^1.22.4\n[SUCCESS]\n[SUCCESS] Run nce -d -u to upgrade package.json.\n```\n\n\u003c/details\u003e\n\n---\n\n## Thanks\n\nThis project is heavily inspired by the following awesome project: [npm-check-updates](https://github.com/raineorshine/npm-check-updates).\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarlhens%2Fnpm-check-engines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmarlhens%2Fnpm-check-engines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarlhens%2Fnpm-check-engines/lists"}