check-installed 2.2.1 → 3.0.0

package/README.md

@@ -14,8 +14,7 @@ $ npm i check-installed --save-dev
 ### Engines Check
 - Compares the installed version of engines to the versions specified in `package.json`
 - Engines can be things like node, dotnet, or anything that responds to `--version`
-- 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
+- Versions are checked with [semver](https://www.npmjs.com/package/semver), so you can use any valid semver range
 ```json
   "engines": {
     "node": ">=12.x",
@@ -28,7 +27,7 @@ $ npm i check-installed --save-dev
 - Compares the installed versions of node modules to the versions 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
+- URL, Git URL, and file path versions are currently skipped
 
 ## Usage
 

package/lib/checkEngines.js

@@ -40,7 +40,7 @@ async function getEngineVersion (name) {
  * @returns {Promise<[string, string, string]>} - The [name, version, installed] installed and checked successfully
  */
 async function checkEngineVersion (name, version) {
-  const installed = await getEngineVersion(name, version)
+  const installed = await getEngineVersion(name)
 
   if (!semver.satisfies(installed, version)) {
     throw new Error(`check-installed engine failed for ${name}: installed ${installed}, expected ${version}`)
@@ -55,7 +55,7 @@ async function checkEngineVersion (name, version) {
  * @param {Partial<typeof import('./constants').OPTIONS>} options - Options for the CLI
  * @returns {Promise<void>} - Resolves when all engines are checked (throws on check fail)
  */
-async function checkEngines (json = {}, options) {
+async function checkEngines (json = {}, options = {}) {
   const { showSuccess, showEngines } = { ...OPTIONS, ...options }
 
   // Check engines

package/lib/checkModules.js

@@ -25,15 +25,14 @@ function checkModuleVersion (name, version, optional) {
   }
 
   // Ignore git URLs version
-  if (/^(git.*:\/\/|github:|gitlab:|bitbucket:|gist:)/.test(version)) {
+  if (/^(file:|https?:\/\/|git.*:\/\/|github:|gitlab:|bitbucket:|gist:)/.test(version)) {
     return [name, version, aliased, 'skipped']
   }
 
-  const directoryPath = `node_modules/${name}`
-  const jsonPath = `${directoryPath}/package.json`
+  const jsonPath = resolve('node_modules', name, 'package.json')
 
   // Check if module is installed and contains a `package.json` (throw if not optional)
-  if (!fs.existsSync(directoryPath) || !fs.existsSync(jsonPath)) {
+  if (!fs.existsSync(jsonPath)) {
     if (optional) {
       return [name, version, aliased, 'none']
     } else {
@@ -41,7 +40,7 @@ function checkModuleVersion (name, version, optional) {
     }
   }
 
-  const json = require(resolve(process.cwd(), jsonPath))
+  const json = require(jsonPath)
   const installed = json.version
 
   if (version !== 'latest' && !semver.satisfies(json.version, version)) {
@@ -57,7 +56,7 @@ function checkModuleVersion (name, version, optional) {
  * @param {Partial<typeof import('./constants').OPTIONS>} options - Options for the CLI
  * @returns {Promise<void>} - Resolves when all modules are checked (throws on check fail)
  */
-async function checkModules (json = {}, options) {
+async function checkModules (json = {}, options = {}) {
   const { showSuccess, showModules } = { ...OPTIONS, ...options }
 
   // Check modules

package/lib/getOptions.js

@@ -3,7 +3,7 @@ const { OPTIONS } = require('./constants')
 /**
  * Get check-installed options from CLI arguments
  * @param {string[]} args - CLI arguments
- * @returns {typeof OPTIONS} - Options for the CLI with defaults
+ * @returns {Partial<typeof OPTIONS>} - Options for the CLI with defaults
  */
 function getOptions (args = []) {
   const options = {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-installed",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "Minimal Node package to check that dependencies are installed ✅",
   "author": "Phillip Lanclos <check-installed@flippidippi.com>",
   "license": "Unlicense",
@@ -35,6 +35,7 @@
     "check": "./bin/check-installed --show-engines",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
+    "compile": "tsc",
     "test": "npm run check && jest",
     "test:coverage": "npm run test -- --coverage",
     "test:watch": "npm run test -- --watch",
@@ -45,10 +46,12 @@
     "semver": "^7.5.4"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.5",
     "husky": "^8.0.3",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "standard": "^17.1.0"
+    "standard": "^17.1.0",
+    "typescript": "^5.2.2"
   },
   "standard": {
     "env": [