check-installed 1.0.0 → 2.0.1

package/README.md

@@ -10,10 +10,20 @@ $ npm i check-installed --save-dev
 
 ## Usage
 - Run this before npm scripts to make sure that the environment is set up correctly
-- It checks that npm packages and engines (node, dotnet, anything that responds to `--version`) are installed and are the correct version
+- It checks that engines and node modules are installed and are the correct versions
 - Version are checked with `semver.satisfies()`, so you can use any valid semver range
   - See [semver](https://www.npmjs.com/package/semver) for more info
 
+### Engine Check
+- Compares the installed version of an engine to the version specified in `package.json`
+- Engines can be things like node, dotnet, or anything that responds to `--version`
+
+### Node Module Check
+- Compares the installed version of a node module to the version specified in `package.json`
+- Versions for modules that have `latest` are not checked, only that they are installed
+- Optional node module dependencies are only checked if they are installed
+- Git URL versions are skipped
+
 ## Example
 In `package.json`:
 ```json
@@ -24,11 +34,7 @@ In `package.json`:
   },
   "scripts": {
     "check": "check-installed",
-    "start": "npm run check && node index.js",
-    "test": "npm run check && mocha"
-  },
-  "dependencies": {
-    "semver": "^7.5.4"
+    "start": "npm run check && node index.js"
   }
 ```
 
@@ -42,5 +48,17 @@ In `package.json`:
 #### `--help`
 Show help (skips check)
 
+#### `--skip-engines`
+Skip checking engines
+
+#### `--skip-modules`
+Skip checking node modules
+
+#### `--show-success`
+Show success message on successful checks
+
 #### `--show-engines`
 Show installed engines on successful check
+
+### `--show-modules`
+Show installed node modules on successful check

package/index.js

@@ -1,19 +1,6 @@
+const { HELP, OPTIONS } = require('./lib/constants')
 const { checkEngines } = require('./lib/checkEngines')
-
-const HELP = `
-Usage: check-installed [options]
-
-Options:
-  --help          Show help (skips check)
-  --show-engines  Show installed engines on successful check
-
-See https://www.npmjs.com/package/check-installed
-`.trim()
-
-const OPTIONS = {
-  help: false,
-  showEngines: false
-}
+const { checkModules } = require('./lib/checkModules')
 
 /**
  * Get options from CLI arguments
@@ -39,6 +26,7 @@ function getOptions (args) {
 
 /**
  * check-installed CLI entry point
+ * @param {string[]} argv - CLI arguments
  */
 async function cli (argv = process.argv) {
   const args = argv.slice(2)
@@ -49,7 +37,13 @@ async function cli (argv = process.argv) {
     return
   }
 
-  await checkEngines(options)
+  if (!options.skipEngines) {
+    await checkEngines(options)
+  }
+
+  if (!options.skipModules) {
+    await checkModules(options)
+  }
 }
 
 exports.cli = cli

package/lib/checkEngines.js

@@ -4,10 +4,11 @@ const semver = require('semver')
 
 /**
  * Get the version of an engine
- * @param {string} engine - The name of the engine to get version for
+ * @param {string} name - The name of the engine to get version for
+ * @returns {Promise<string>} - The version of the engine
  */
-async function getEngineVersion (engine) {
-  const spawned = spawn(engine, ['--version'])
+async function getEngineVersion (name) {
+  const spawned = spawn(name, ['--version'])
 
   return new Promise((resolve) => {
     let result = ''
@@ -32,39 +33,45 @@ async function getEngineVersion (engine) {
 
 /**
  * Checks that the given engine is installed and satisfies version (throws if not)
- * @param {string} engine - The name of the engine to check
+ * @param {string} name - The name of the engine to check
  * @param {string} version - The version to check against
- * @returns {Promise<[string, string]>} - The [engine, version] installed and checked successfully
+ * @returns {Promise<[string, string, string]>} - The [name, version, installed] installed and checked successfully
  */
-async function checkEngineVersion (engine, version) {
-  const installed = await getEngineVersion(engine, version)
+async function checkEngineVersion (name, version) {
+  const installed = await getEngineVersion(name, version)
 
   if (!semver.satisfies(installed, version)) {
-    throw new Error(`Engine check failed for ${engine}: installed ${installed}, expected ${version}`)
+    throw new Error(`check-installed engine failed for ${name}: installed ${installed}, expected ${version}`)
   }
 
-  return [engine, installed]
+  return [name, version, installed]
 }
 
 /**
  * Checks engines in `package.json` are installed
- * @param {boolean} showInstalled - Whether to show installed engines
+ * @param {typeof import('./constants').OPTIONS} options - Options for the CLI
  */
-async function checkEngines ({
-  showEngines = false
-} = {}) {
+async function checkEngines (options) {
+  const { showSuccess, showEngines } = options
   const json = require(resolve(process.cwd(), 'package.json'))
 
+  // Check engines
   const engines = await Promise.all(
     Object.entries(json.engines || {})
-      .map(([engine, version]) => checkEngineVersion(engine, version))
+      .map(([name, version]) => checkEngineVersion(name, version))
   )
 
+  if (showSuccess) {
+    console.log('check-installed engines successful')
+  }
+
   if (showEngines) {
-    for (const [engine, version] of engines) {
-      console.log(`${engine}: ${version}`)
+    for (const [name, version, installed] of engines) {
+      console.log(`${name}: ${installed} (${version})`)
     }
   }
 }
 
-exports.checkEngines = checkEngines
+module.exports = {
+  checkEngines
+}

package/lib/checkModules.js

@@ -0,0 +1,85 @@
+const { resolve } = require('path')
+const fs = require('fs')
+const semver = require('semver')
+
+/**
+ * Regex used to extract the real name and version from an npm alias
+ */
+const NPM_ALIAS_REGEX = /npm:(.+)@(.+)/
+
+/**
+ * Checks that the given node module is installed and satisfies version (throws if not)
+ * @param {string} name - The name of the node module to check
+ * @param {string} version - The version to check against
+ * @returns {[string, string, string, string]} - The [name, version, aliased, installed] installed and checked successfully
+ */
+function checkModuleVersion (name, version, optional) {
+  // Update with npm alias if needed ("my-react": "npm:react@^18.2.0")
+  let aliased = ''
+  if (NPM_ALIAS_REGEX.test(version)) {
+    const [, realName, realVersion] = version.match(NPM_ALIAS_REGEX)
+
+    aliased = `${realName} `
+    console.log('realnamel', realName)
+    version = realVersion
+  }
+
+  // Ignore git URLs version
+  if (/^(git.*:\/\/|github:|gitlab:|bitbucket:|gist:)/.test(version)) {
+    return [name, version, aliased, 'skipped']
+  }
+
+  const directoryPath = `node_modules/${name}`
+  const jsonPath = `${directoryPath}/package.json`
+
+  // Check if module is installed and contains a `package.json` (throw if not optional)
+  if (!fs.existsSync(directoryPath) || !fs.existsSync(jsonPath)) {
+    if (optional) {
+      return [name, version, aliased, 'none']
+    } else {
+      throw new Error(`check-installed module failed for ${name}: installed none, expected ${aliased}${version}`)
+    }
+  }
+
+  const json = require(resolve(process.cwd(), jsonPath))
+  const installed = json.version
+
+  if (version !== 'latest' && !semver.satisfies(json.version, version)) {
+    throw new Error(`check-installed module failed for ${name}: installed ${installed}, expected ${aliased}${version}`)
+  }
+
+  return [name, version, aliased, installed]
+}
+
+/**
+ * Checks node modules in `package.json` are installed
+ * @param {typeof import('./constants').OPTIONS} options - Options for the CLI
+ */
+async function checkModules (options) {
+  const { showSuccess, showModules } = options
+  const json = require(resolve(process.cwd(), 'package.json'))
+
+  // Check modules
+  const modules = [
+    ...Object.entries(json.dependencies || {})
+      .map(([name, version]) => checkModuleVersion(name, version, false)),
+    ...Object.entries(json.devDependencies || {})
+      .map(([name, version]) => checkModuleVersion(name, version, false)),
+    ...Object.entries(json.optionalDependencies || {})
+      .map(([name, version]) => checkModuleVersion(name, version, true))
+  ]
+
+  if (showSuccess) {
+    console.log('check-installed modules successful')
+  }
+
+  if (showModules) {
+    for (const [name, version, aliased, installed] of modules) {
+      console.log(`${name}: ${installed} (${aliased}${version})`)
+    }
+  }
+}
+
+module.exports = {
+  checkModules
+}

package/lib/constants.js

@@ -0,0 +1,33 @@
+/**
+ * Help text for the CLI
+ */
+const HELP = `
+Usage: check-installed [options]
+
+Options:
+  --help          Show help (skips check)
+  --skip-engines  Skip checking engines
+  --skip-modules  Skip checking node modules
+  --show-success  Show success message on successful checks
+  --show-engines  Show installed engines on successful check
+  --show-modules  Show installed node modules on successful check
+
+See https://www.npmjs.com/package/check-installed
+`.trim()
+
+/**
+ * Default options for the CLI
+ */
+const OPTIONS = {
+  help: false,
+  skipEngines: false,
+  skipModules: false,
+  showSuccess: false,
+  showEngines: false,
+  showModules: false
+}
+
+module.exports = {
+  HELP,
+  OPTIONS
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-installed",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "Minimal Node package to check that dependencies are installed ✅",
   "author": "Phillip Lanclos <check-installed@flippidippi.com>",
   "license": "Unlicense",
@@ -32,7 +32,7 @@
     "npm": ">=6"
   },
   "scripts": {
-    "check": "./bin/check-installed --show-engines",
+    "check": "./bin/check-installed",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
     "test": "npm run check",