check-installed 3.1.0 → 4.0.0

package/lib/checkEngines.js

@@ -1,4 +1,4 @@
-const { spawn } = require('child_process')
+const spawn = require('cross-spawn')
 const semver = require('semver')
 const { OPTIONS } = require('./constants')
 
@@ -8,14 +8,16 @@ const { OPTIONS } = require('./constants')
  * @returns {Promise<string>} - The version of the engine
  */
 async function getEngineVersion (name) {
-  const spawned = spawn(name, ['--version'], { shell: true })
+  const spawned = spawn(name, ['--version'])
 
   return new Promise((resolve) => {
     let result = ''
 
-    spawned.stdout.on('data', (data) => {
-      result += data.toString()
-    })
+    if (spawned.stdout != null) {
+      spawned.stdout.on('data', (data) => {
+        result += data.toString()
+      })
+    }
 
     spawned.on('close', (code) => {
       if (code !== 0) {
@@ -45,7 +47,7 @@ async function checkEngineVersion (name, version) {
 
 /**
  * Checks engines in `package.json` are installed
- * @param {object} json - The `package.json` JSON object
+ * @param {Record<string, any>} json - The `package.json` JSON object
  * @param {Partial<typeof import('./constants').OPTIONS>} options - Options for the CLI
  * @returns {Promise<void>} - Resolves when all engines are checked (throws on check fail)
  */

package/lib/checkModules.js

@@ -12,16 +12,19 @@ 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
+ * @param {boolean} optional - Whether the module is optional
  * @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} `
-    version = realVersion
+    const match = version.match(NPM_ALIAS_REGEX)
+    if (match != null) {
+      const [, realName, realVersion] = match
+      aliased = `${realName} `
+      version = realVersion
+    }
   }
 
   // Ignore git URLs version
@@ -52,7 +55,7 @@ function checkModuleVersion (name, version, optional) {
 
 /**
  * Checks node modules in `package.json` are installed
- * @param {object} json - The `package.json` JSON object
+ * @param {Record<string, any>} json - The `package.json` JSON object
  * @param {Partial<typeof import('./constants').OPTIONS>} options - Options for the CLI
  * @returns {Promise<void>} - Resolves when all modules are checked (throws on check fail)
  */

package/lib/getOptions.js

@@ -6,12 +6,14 @@ const { OPTIONS } = require('./constants')
  * @returns {Partial<typeof OPTIONS>} - Options for the CLI with defaults
  */
 function getOptions (args = []) {
+  /** @type {Record<string, boolean | string>} */
   const options = {}
 
   for (const arg of args) {
     if (arg.startsWith('--')) {
       const [key, value] = arg.slice(2).split('=')
       const keyCamelCase = key.replace(/-([a-z])/g, (_, c) => c.toUpperCase())
+      // @ts-ignore
       const option = OPTIONS[keyCamelCase]
 
       // Only set if the option is defined in `OPTIONS`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-installed",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "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 --show-engines --show-modules",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
     "compile": "tsc",
@@ -40,18 +40,21 @@
     "test:coverage": "npm run test -- --coverage",
     "test:watch": "npm run test -- --watch",
     "test:ci": "npm run test:coverage -- --ci --reporters=default --reporters=jest-junit",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "dependencies": {
-    "semver": "^7.5.4"
+    "cross-spawn": "^7.0.6",
+    "semver": "^7.7.4"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.5",
-    "husky": "^8.0.3",
-    "jest": "^29.7.0",
+    "@types/cross-spawn": "^6.0.6",
+    "@types/jest": "^30.0.0",
+    "@types/semver": "^7.7.1",
+    "husky": "^9.1.7",
+    "jest": "^30.3.0",
     "jest-junit": "^16.0.0",
-    "standard": "^17.1.0",
-    "typescript": "^5.2.2"
+    "standard": "^17.1.2",
+    "typescript": "^6.0.2"
   },
   "standard": {
     "env": [