npq 3.16.4 → 3.16.5

package/README.md

@@ -179,6 +179,8 @@ Here are all the available environment variable names for disabling specific mar
 
 ### Run checks on package without installing it
 
+Running `npq` without an `install` / `i` / `add` subcommand (for example from a project directory with a `package.json`) audits dependencies only and does not run the package manager. The same applies to `npq <package>`: checks only, no install passthrough. Use `npq install …` when you want npq to hand off to npm (or `NPQ_PKG_MGR`) after the checks.
+
 ```sh
 npq install express --dry-run
 ```

package/bin/npq.js

@@ -19,6 +19,7 @@ const { promiseThrottleHelper } = require('../lib/helpers/promiseThrottler')
 const debug = util.debuglog('npq')
 
 const cliArgs = CliParser.parseArgsFull()
+const auditOnly = cliArgs.dryRun || !cliArgs.installSubcommandExplicit
 const isInteractive = cliSupport.isInteractiveTerminal() && !cliArgs.plain
 const spinner = isInteractive ? new Spinner({ text: 'Initiating...' }) : null
 
@@ -89,11 +90,12 @@ Promise.resolve()
     return undefined
   })
   .then((result) => {
-    if (cliArgs.dryRun) {
+    if (auditOnly) {
       CliParser.exit({
         errorCode: 0,
         spinner
       })
+      return undefined
     }
 
     if (result && result.countErrors > 0) {

package/lib/cli.js

@@ -4,7 +4,25 @@ const { parseArgs } = require('node:util')
 const npa = require('npm-package-arg')
 const pkg = require('../package.json')
 
+const INSTALL_SUBCOMMANDS = new Set([
+  'install',
+  'i',
+  'add',
+  'isntall',
+  'in',
+  'ins',
+  'inst',
+  'insta',
+  'instal',
+  'isnt',
+  'isnta',
+  'isntal'
+])
+
 class CliParser {
+  static isInstallSubcommand(token) {
+    return INSTALL_SUBCOMMANDS.has(token)
+  }
   static exit({ errorCode, message, spinner }) {
     if (spinner && spinner.isSpinning) {
       spinner.stop()
@@ -25,32 +43,13 @@ class CliParser {
     if (positionals.length > 0) {
       const command = positionals[0]
 
-      switch (command) {
-        case 'install':
-        case 'i':
-        case 'add':
-        case 'isntall':
-        case 'in':
-        case 'ins':
-        case 'inst':
-        case 'insta':
-        case 'instal':
-        case 'isnt':
-        case 'isnta':
-        case 'isntal':
-          packages = positionals.slice(1)
-          break
-        default:
-          if (earlyExitNoInstall) {
-            // If no install command, exit early
-            // needed for npq-hero command which only runs on 'install' use-cases of npm
-            break
-          }
-
-          // Treat first positional as package if no explicit command
-          packages = positionals
-          break
+      if (this.isInstallSubcommand(command)) {
+        packages = positionals.slice(1)
+      } else if (!earlyExitNoInstall) {
+        // Treat first positional as package if no explicit command
+        packages = positionals
       }
+      // earlyExitNoInstall + non-install: packages stay [] (npq-hero)
     }
 
     // Parse and normalize packages
@@ -85,7 +84,10 @@ class CliParser {
       console.log(`Usage: npq install <package> [options]
 
 Commands:
-  install [package...]  install a package
+  install [package...]  install a package (required to run the package manager)
+
+  With no install subcommand, npq audits packages only (current project deps from
+  package.json, or package names you pass) and does not invoke npm install.
 
 Options:
       --dry-run               Run checks only, don't install
@@ -97,7 +99,7 @@ Options:
   -v, --version               Show version
 
 Environment Variables:
-  NPQ_PKG_MGR                 Package manager to use (default: npm)
+  NPQ_PKG_MGR                 Package manager to use; overrides --packageManager when set (default: npm)
   NPQ_DISABLE_AUTO_CONTINUE   Set to 'true' to disable auto-continue
 
 Examples:
@@ -115,14 +117,17 @@ curated by Liran Tal at https://github.com/lirantal/npq`)
 
     // Process install command and packages
     const normalizedPackages = this._extractPackagesFromPositionals(positionals)
+    const installSubcommandExplicit =
+      positionals.length > 0 && this.isInstallSubcommand(positionals[0])
 
     return {
       packages: normalizedPackages,
-      packageManager: values.packageManager || values.pkgMgr || process.env.NPQ_PKG_MGR || 'npm',
+      packageManager: process.env.NPQ_PKG_MGR || values.packageManager || values.pkgMgr || 'npm',
       dryRun: values['dry-run'] || false,
       plain: values.plain || false,
       disableAutoContinue:
-        values['disable-auto-continue'] || process.env.NPQ_DISABLE_AUTO_CONTINUE === 'true'
+        values['disable-auto-continue'] || process.env.NPQ_DISABLE_AUTO_CONTINUE === 'true',
+      installSubcommandExplicit
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npq",
-  "version": "3.16.4",
+  "version": "3.16.5",
   "description": "marshall your npm/npm package installs with high quality and class 🎖",
   "bin": {
     "npq": "./bin/npq.js",