lifion
lifion-verify-deps
Verifies that installed NPM modules are the latest currently available version.
Getting Started
To install the module:
npm install lifion-verify-deps --globalTo run command:
lifion-verify-depsTo use as module:
const verifyDeps = require('lifion-verify-deps');
verifyDeps({ dir: './path-to/project-directory' })
.then(() => /* all installed packages up to date */)
.catch((err) => /* there are packages to be updated */)API Reference
- lifion-verify-deps
- verifyDeps([options]) ⏏
- ~isValidNpmPackageName(name)
- ~getLatestVersions(name) ⇒
Promise.<Array.<string>> - ~getLatestTag(name) ⇒
Promise.<string> - ~getLatestVersion(name, wanted) ⇒
Promise.<string> - ~getInstalledVersion(currentDir, name, logger) ⇒
string|null - ~pushPkgs(params) ⇒
Array.<Promise.<PackageStatus>> - ~getPkgIds(filteredPkgs) ⇒
string - ~removeLockedDependencies(deps) ⇒
Object.<string, string>|Object
- verifyDeps([options]) ⏏
verifyDeps([options]) ⏏
Verifies the dependencies listed in the package.json of the given directory.
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| [options] | Object |
| Optional parameters. | |
| [options.autoUpgrade] | boolean |
false |
Automatically upgrade all suggested dependencies. |
| [options.dir] | string |
| The path where to look for the package.json file. | |
| [options.logger] | Logger |
| A logger instance, with a similar API as the console object. |
verifyDeps~isValidNpmPackageName(name)
Validates package name.
Kind: inner method of verifyDeps
Throws:
Error- Package name is invalid.
| Param | Type | Description |
|---|---|---|
| name | string |
Package name. |
verifyDeps~getLatestVersions(name) ⇒ Promise.<Array.<string>>
Gets available versions for provided package name.
Kind: inner method of verifyDeps
Returns: Promise.<Array.<string>> - - List of available versions.
Throws:
Error- Output failed JSON parse.
| Param | Type | Description |
|---|---|---|
| name | string |
Package name. |
verifyDeps~getLatestTag(name) ⇒ Promise.<string>
Gets latest tag from provided package name.
Kind: inner method of verifyDeps
Returns: Promise.<string> - - Return latest version, if latest tag exists.
Throws:
Error- Output failed JSON parse.
| Param | Type | Description |
|---|---|---|
| name | string |
Package name. |
verifyDeps~getLatestVersion(name, wanted) ⇒ Promise.<string>
Finds valid upgrade version of the provided package name.
Kind: inner method of verifyDeps
Returns: Promise.<string> - - Valid upgrade version.
Throws:
Error- Outdated version in package.json, version was likely unpublished.
| Param | Type | Description |
|---|---|---|
| name | string |
Package name. |
| wanted | string |
Package version. |
verifyDeps~getInstalledVersion(currentDir, name, logger) ⇒ string | null
Gets currently installed version for provided package name.
Kind: inner method of verifyDeps
Returns: string | null - - Installed version or null if not installed.
Throws:
Error- Unable to find installed versions, try installing node modules by runningnpm i.
| Param | Type | Description |
|---|---|---|
| currentDir | string |
Path to package.json directory. |
| name | string |
Package name. |
| logger | Logger |
Logger flag. |
verifyDeps~pushPkgs(params) ⇒ Array.<Promise.<PackageStatus>>
Builds list of packages to update.
Kind: inner method of verifyDeps
Returns: Array.<Promise.<PackageStatus>> - - NPM package state.
| Param | Type | Description |
|---|---|---|
| params | Object |
Object with parameters. |
| params.deps | Object.<string, string> |
List of dependencies. |
| params.dir | string |
Directory location. |
| params.logger | Logger |
Logging tool. |
| params.type | string |
Type of dependency. |
verifyDeps~getPkgIds(filteredPkgs) ⇒ string
Formats package name for installation.
Kind: inner method of verifyDeps
Returns: string - - Concatenated 'name@latest' for provided package.
| Param | Type | Description |
|---|---|---|
| filteredPkgs | Array.<PackageStatus> |
Package properties. |
verifyDeps~removeLockedDependencies(deps) ⇒ Object.<string, string> | Object
Filters out dependencies with locked versions.
Kind: inner method of verifyDeps
Returns: Object.<string, string> | Object - List of dependencies excluding locked semver versions.
| Param | Type | Description |
|---|---|---|
| deps | Object.<string, string> |
List of dependencies. |