{"id":22281690,"url":"https://github.com/lifion/lifion-verify-deps","last_synced_at":"2025-07-28T20:31:18.788Z","repository":{"id":33559273,"uuid":"157601789","full_name":"lifion/lifion-verify-deps","owner":"lifion","description":"Checks that installed NPM modules are the latest currently available version.","archived":false,"fork":false,"pushed_at":"2023-07-17T15:58:39.000Z","size":2595,"stargazers_count":3,"open_issues_count":8,"forks_count":1,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2024-12-01T10:24:03.332Z","etag":null,"topics":["check","dependencies","installed","lifion","update","upgrade","verify","version"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lifion.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-14T19:43:36.000Z","updated_at":"2023-04-05T21:08:15.000Z","dependencies_parsed_at":"2023-01-15T01:26:02.967Z","dependency_job_id":null,"html_url":"https://github.com/lifion/lifion-verify-deps","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lifion%2Flifion-verify-deps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lifion%2Flifion-verify-deps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lifion%2Flifion-verify-deps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lifion%2Flifion-verify-deps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lifion","download_url":"https://codeload.github.com/lifion/lifion-verify-deps/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227953333,"owners_count":17846488,"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","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","dependencies","installed","lifion","update","upgrade","verify","version"],"created_at":"2024-12-03T16:20:37.285Z","updated_at":"2024-12-03T16:20:38.100Z","avatar_url":"https://github.com/lifion.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lifion-verify-deps\n\nVerifies that installed NPM modules are the latest currently available version.\n\n## Getting Started\n\nTo install the module:\n\n```sh\nnpm install lifion-verify-deps --global\n```\n\nTo run command:\n\n```sh\nlifion-verify-deps\n```\n\nTo use as module:\n\n```sh\nconst verifyDeps = require('lifion-verify-deps');\n\nverifyDeps({ dir: './path-to/project-directory' })\n  .then(() =\u003e /* all installed packages up to date */)\n  .catch((err) =\u003e /* there are packages to be updated */)\n```\n\n## API Reference\n\n\n* [lifion-verify-deps](#module_lifion-verify-deps)\n    * [verifyDeps([options])](#exp_module_lifion-verify-deps--verifyDeps) ⏏\n        * [~isValidNpmPackageName(name)](#module_lifion-verify-deps--verifyDeps..isValidNpmPackageName)\n        * [~getLatestVersions(name)](#module_lifion-verify-deps--verifyDeps..getLatestVersions) ⇒ \u003ccode\u003ePromise.\u0026lt;Array.\u0026lt;string\u0026gt;\u0026gt;\u003c/code\u003e\n        * [~getLatestTag(name)](#module_lifion-verify-deps--verifyDeps..getLatestTag) ⇒ \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e\n        * [~getLatestVersion(name, wanted)](#module_lifion-verify-deps--verifyDeps..getLatestVersion) ⇒ \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e\n        * [~getInstalledVersion(currentDir, name, logger)](#module_lifion-verify-deps--verifyDeps..getInstalledVersion) ⇒ \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003enull\u003c/code\u003e\n        * [~pushPkgs(params)](#module_lifion-verify-deps--verifyDeps..pushPkgs) ⇒ \u003ccode\u003eArray.\u0026lt;Promise.\u0026lt;PackageStatus\u0026gt;\u0026gt;\u003c/code\u003e\n        * [~getPkgIds(filteredPkgs)](#module_lifion-verify-deps--verifyDeps..getPkgIds) ⇒ \u003ccode\u003estring\u003c/code\u003e\n        * [~removeLockedDependencies(deps)](#module_lifion-verify-deps--verifyDeps..removeLockedDependencies) ⇒ \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e \\| \u003ccode\u003eObject\u003c/code\u003e\n\n\u003ca name=\"exp_module_lifion-verify-deps--verifyDeps\"\u003e\u003c/a\u003e\n\n### verifyDeps([options]) ⏏\nVerifies the dependencies listed in the package.json of the given directory.\n\n**Kind**: Exported function  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e |  | Optional parameters. |\n| [options.autoUpgrade] | \u003ccode\u003eboolean\u003c/code\u003e | \u003ccode\u003efalse\u003c/code\u003e | Automatically upgrade all suggested dependencies. |\n| [options.dir] | \u003ccode\u003estring\u003c/code\u003e |  | The path where to look for the package.json file. |\n| [options.logger] | [\u003ccode\u003eLogger\u003c/code\u003e](#Logger) |  | A logger instance, with a similar API as the console object. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..isValidNpmPackageName\"\u003e\u003c/a\u003e\n\n#### verifyDeps~isValidNpmPackageName(name)\nValidates package name.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Throws**:\n\n- \u003ccode\u003eError\u003c/code\u003e - Package name is invalid.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | \u003ccode\u003estring\u003c/code\u003e | Package name. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..getLatestVersions\"\u003e\u003c/a\u003e\n\n#### verifyDeps~getLatestVersions(name) ⇒ \u003ccode\u003ePromise.\u0026lt;Array.\u0026lt;string\u0026gt;\u0026gt;\u003c/code\u003e\nGets available versions for provided package name.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003ePromise.\u0026lt;Array.\u0026lt;string\u0026gt;\u0026gt;\u003c/code\u003e - - List of available versions.  \n**Throws**:\n\n- \u003ccode\u003eError\u003c/code\u003e - Output failed JSON parse.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | \u003ccode\u003estring\u003c/code\u003e | Package name. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..getLatestTag\"\u003e\u003c/a\u003e\n\n#### verifyDeps~getLatestTag(name) ⇒ \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e\nGets latest tag from provided package name.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e - - Return latest version, if latest tag exists.  \n**Throws**:\n\n- \u003ccode\u003eError\u003c/code\u003e - Output failed JSON parse.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | \u003ccode\u003estring\u003c/code\u003e | Package name. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..getLatestVersion\"\u003e\u003c/a\u003e\n\n#### verifyDeps~getLatestVersion(name, wanted) ⇒ \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e\nFinds valid upgrade version of the provided package name.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003ePromise.\u0026lt;string\u0026gt;\u003c/code\u003e - - Valid upgrade version.  \n**Throws**:\n\n- \u003ccode\u003eError\u003c/code\u003e - Outdated version in package.json, version was likely unpublished.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | \u003ccode\u003estring\u003c/code\u003e | Package name. |\n| wanted | \u003ccode\u003estring\u003c/code\u003e | Package version. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..getInstalledVersion\"\u003e\u003c/a\u003e\n\n#### verifyDeps~getInstalledVersion(currentDir, name, logger) ⇒ \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003enull\u003c/code\u003e\nGets currently installed version for provided package name.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003enull\u003c/code\u003e - - Installed version or null if not installed.  \n**Throws**:\n\n- \u003ccode\u003eError\u003c/code\u003e - Unable to find installed versions, try installing node modules by running `npm i`.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| currentDir | \u003ccode\u003estring\u003c/code\u003e | Path to package.json directory. |\n| name | \u003ccode\u003estring\u003c/code\u003e | Package name. |\n| logger | [\u003ccode\u003eLogger\u003c/code\u003e](#Logger) | Logger flag. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..pushPkgs\"\u003e\u003c/a\u003e\n\n#### verifyDeps~pushPkgs(params) ⇒ \u003ccode\u003eArray.\u0026lt;Promise.\u0026lt;PackageStatus\u0026gt;\u0026gt;\u003c/code\u003e\nBuilds list of packages to update.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003eArray.\u0026lt;Promise.\u0026lt;PackageStatus\u0026gt;\u0026gt;\u003c/code\u003e - - NPM package state.  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | \u003ccode\u003eObject\u003c/code\u003e | Object with parameters. |\n| params.deps | \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e | List of dependencies. |\n| params.dir | \u003ccode\u003estring\u003c/code\u003e | Directory location. |\n| params.logger | [\u003ccode\u003eLogger\u003c/code\u003e](#Logger) | Logging tool. |\n| params.type | \u003ccode\u003estring\u003c/code\u003e | Type of dependency. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..getPkgIds\"\u003e\u003c/a\u003e\n\n#### verifyDeps~getPkgIds(filteredPkgs) ⇒ \u003ccode\u003estring\u003c/code\u003e\nFormats package name for installation.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003estring\u003c/code\u003e - - Concatenated 'name@latest' for provided package.  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| filteredPkgs | [\u003ccode\u003eArray.\u0026lt;PackageStatus\u0026gt;\u003c/code\u003e](#PackageStatus) | Package properties. |\n\n\u003ca name=\"module_lifion-verify-deps--verifyDeps..removeLockedDependencies\"\u003e\u003c/a\u003e\n\n#### verifyDeps~removeLockedDependencies(deps) ⇒ \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e \\| \u003ccode\u003eObject\u003c/code\u003e\nFilters out dependencies with locked versions.\n\n**Kind**: inner method of [\u003ccode\u003everifyDeps\u003c/code\u003e](#exp_module_lifion-verify-deps--verifyDeps)  \n**Returns**: \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e \\| \u003ccode\u003eObject\u003c/code\u003e - List of dependencies excluding locked semver versions.  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deps | \u003ccode\u003eObject.\u0026lt;string, string\u0026gt;\u003c/code\u003e | List of dependencies. |\n\n\n## License\n\n[Apache-2.0](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flifion%2Flifion-verify-deps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flifion%2Flifion-verify-deps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flifion%2Flifion-verify-deps/lists"}