lifion-verify-deps

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 --global

To run command:

lifion-verify-deps

To 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]) ⏏

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 running npm 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.

License

Apache-2.0

Changelog

v2.0.1 (2021-12-13)

• #244: Bring develop up to date
• #242: Add fix to properly handle versions with ~ and locked versions
• 4e1c194: Refactor unit tests to avoid virtual path mocking
• 5b3c48e: Test path structure
• b9f3791: Refactored external commands out of index.js into utils
• 64b95fd: Add coverage exception for util files
• 5814b9a: Update package-lock
• c7af116: All unit tests refactored and pass
• 658c43f: Update package-lock
• 45ee622: Add badges and update workflows
• fc59855: Fix skipped unit tests
• 7e41f3b: Refactor to exclude only command execution
• b5ce7d9: Remove extra spacing
• b931e29: Attempt at refactoring module export
• dc1d1a1: Bring develop upto date
• 6690169: Test path structure
• 788b681: Fix types
• 782eb1f: Move test helpers outside of lib
• 9da2413: Add documentation
• 322ace1: Fix typo in filename
• 007052f: Remove redundant directory name variables
• 3c92420: Update package-lock
• e08c7e3: Test path structure
• f5e5b48: Workaround to fix failing virtual mocks on windows
• a6e4eaf: Workaround to fix failing virtual mocks on windows
• b672f89: Remove debug logs
• 314f738: Remove redandant async
• a69a47e: Test path structure
• b4cc5d8: Workaround to fix failing virtual mocks on windows
• 6fdbe7b: Fix error documentation for util files
• 9a35936: Workaround to fix failing virtual mocks on windows
• 5e69808: Reformatted .eslintrc
• 0177181: Add missing description for object parameter
• dd2e98d: Updated README
• 3c3fa37: Uninstall chance
• 8c8ed33: Put back report coverage
• b3af94f: Temporarely remove coverage report
• 47c4a6f: Remove debug logs
• 00898cf: Test path structure
• ef90aa1: Put back node 14
• 653ac82: Test ndoe 16, 17 only
• 30149df: Remove debug comment
• b8090fa: Remove debug log
• 3db1cc5: Remove TODO