npq 3.8.1 → 3.9.1

package/__tests__/scripts.test.js

@@ -1,7 +1,7 @@
 const fs = require('fs')
 const os = require('os')
 const path = require('path')
-const inquirer = require('inquirer')
+const cliPrompt = require('../lib/helpers/cliPrompt.js')
 
 const postinstall = require('../scripts/postinstall').testable
 const preuninstall = require('../scripts/preuninstall').testable
@@ -9,7 +9,7 @@ const helpers = require('../scripts/scriptHelpers')
 
 const TEST_PROFILE_PATH = path.resolve(os.tmpdir(), '.npq_test_profile')
 const TEST_ALIAS = 'alias npm="npq-hero"'
-inquirer.prompt = jest.fn().mockResolvedValue({ install: true })
+cliPrompt.prompt = jest.fn().mockResolvedValue({ install: true })
 
 let mockGetShellConfig
 let mockIsRunningInYarn

package/bin/npq-hero.js

@@ -5,38 +5,89 @@
 const cliSupport = require('../lib/helpers/cliSupportHandler')
 cliSupport.isEnvSupport() || (cliSupport.noSupportError() && cliSupport.packageManagerPassthrough())
 
-const inquirer = require('inquirer')
-const yargs = require('yargs')
 const pkgMgr = require('../lib/packageManager')
 const Marshall = require('../lib/marshall')
-const cliCommons = require('../lib/cliCommons')
+const { CliParser } = require('../lib/cli')
+const cliPrompt = require('../lib/helpers/cliPrompt.js')
+const { reportResults } = require('../lib/helpers/reportResults')
+const { Spinner } = require('../lib/helpers/cliSpinner')
+const { promiseThrottleHelper } = require('../lib/helpers/promiseThrottler')
 
 const PACKAGE_MANAGER_TOOL = process.env.NPQ_PKG_MGR
 
-const cli = yargs
-  .options(cliCommons.getOptions())
-  .command(cliCommons.getInstallCommand())
-  .help(false)
-  .version(false).argv
+const cliArgs = CliParser.parseArgsMinimal()
+
+const silentModeNoPackages = !cliArgs || !cliArgs.packages || cliArgs.packages.length === 0
+
+const isInteractive = cliSupport.isInteractiveTerminal() && !silentModeNoPackages
+const spinner = isInteractive ? new Spinner({ text: 'Initiating...' }) : null
+
+if (spinner) {
+  spinner.start()
+}
 
 const marshall = new Marshall({
-  pkgs: cli.package
+  pkgs: cliArgs.packages,
+  progressManager: spinner,
+  promiseThrottleHelper
 })
 
 marshall
   .process()
+  .then((marshallResults) => {
+    if (spinner) {
+      spinner.stop()
+    }
+
+    const results = reportResults(marshallResults)
+    if (
+      results &&
+      Object.hasOwn(results, 'countErrors') &&
+      Object.hasOwn(results, 'countWarnings')
+    ) {
+      const { countErrors, countWarnings, useRichFormatting } = results
+      const isErrors = countErrors > 0 || countWarnings > 0
+
+      if (isErrors) {
+        console.log()
+        console.log('Packages with issues found:')
+
+        if (useRichFormatting) {
+          console.log(results.resultsForPrettyPrint)
+          console.log(results.summaryForPrettyPrint)
+        } else {
+          console.log(results.resultsForPlainTextPrint)
+          console.log(results.summaryForPlainTextPrint)
+        }
+      }
+
+      return {
+        anyIssues: isErrors,
+        countErrors,
+        countWarnings
+      }
+    }
+    return undefined
+  })
   .then((result) => {
-    if (result && result.error) {
+    if (result && result.countErrors > 0) {
       // eslint-disable-next-line no-console
       console.log()
-      return inquirer.prompt([
-        {
-          type: 'confirm',
+      return cliPrompt.prompt({
+        name: 'install',
+        message: 'Continue install ?',
+        default: false
+      })
+    } else {
+      if (result && result.countWarnings > 0) {
+        // eslint-disable-next-line no-console
+        console.log()
+        return cliPrompt.autoContinue({
           name: 'install',
-          message: 'Would you like to continue installing package(s)?',
-          default: false
-        }
-      ])
+          message: 'Auto-continue with install in... ',
+          timeInSeconds: 15
+        })
+      }
     }
 
     return { install: true }
@@ -47,7 +98,9 @@ marshall
     }
   })
   .catch((error) => {
-    // eslint-disable-next-line no-console
-    console.error(error)
-    process.exit(-1)
+    CliParser.exit({
+      errorCode: error.code || -1,
+      message: error.message || 'An error occurred',
+      spinner
+    })
   })

package/bin/npq.js

@@ -1,48 +1,140 @@
 #!/usr/bin/env node
 'use strict'
 
+const util = require('node:util')
+
 // Require minimum node version or bail out
 const cliSupport = require('../lib/helpers/cliSupportHandler')
 cliSupport.isEnvSupport() || cliSupport.noSupportError(true)
 
-const inquirer = require('inquirer')
-const cli = require('../lib/cli')
+const { getProjectPackages } = require('../lib/helpers/sourcePackages')
+const { CliParser } = require('../lib/cli')
 const pkgMgr = require('../lib/packageManager')
 const Marshall = require('../lib/marshall')
+const cliPrompt = require('../lib/helpers/cliPrompt.js')
+const { reportResults } = require('../lib/helpers/reportResults')
+const { Spinner } = require('../lib/helpers/cliSpinner')
+const { promiseThrottleHelper } = require('../lib/helpers/promiseThrottler')
 
-const marshall = new Marshall({
-  pkgs: cli.package
-})
+const debug = util.debuglog('npq')
+
+const cliArgs = CliParser.parseArgsFull()
+const isInteractive = cliSupport.isInteractiveTerminal() && !cliArgs.plain
+const spinner = isInteractive ? new Spinner({ text: 'Initiating...' }) : null
+
+if (spinner) {
+  spinner.start()
+}
+
+Promise.resolve()
+  .then(() => {
+    if (cliArgs.packages.length === 0) {
+      debug('\nNo packages specified, using project packages from package.json')
+      return getProjectPackages()
+    }
+
+    return cliArgs.packages
+  })
+  .then((packages) => {
+    if (packages.error) {
+      console.log()
+      CliParser.exit({
+        errorCode: packages.error.code || -1,
+        message: packages.message,
+        spinner
+      })
+    }
+
+    const marshall = new Marshall({
+      pkgs: packages,
+      progressManager: spinner,
+      promiseThrottleHelper
+    })
+
+    return marshall.process()
+  })
+  .then((marshallResults) => {
+    if (spinner) {
+      spinner.stop()
+    }
+
+    const results = reportResults(marshallResults, { plain: cliArgs.plain })
+    if (
+      results &&
+      Object.hasOwn(results, 'countErrors') &&
+      Object.hasOwn(results, 'countWarnings')
+    ) {
+      const { countErrors, countWarnings, useRichFormatting } = results
+      const isErrors = countErrors > 0 || countWarnings > 0
+
+      if (isErrors) {
+        console.log()
+        console.log('Packages with issues found:')
+
+        if (useRichFormatting) {
+          console.log(results.resultsForPrettyPrint)
+          console.log(results.summaryForPrettyPrint)
+        } else {
+          console.log(results.resultsForPlainTextPrint)
+          console.log(results.summaryForPlainTextPrint)
+        }
+      }
 
-marshall
-  .process()
+      return {
+        anyIssues: isErrors,
+        countErrors,
+        countWarnings
+      }
+    }
+    return undefined
+  })
   .then((result) => {
-    if (cli.dryRun) {
-      process.exit(0)
+    if (cliArgs.dryRun) {
+      CliParser.exit({
+        errorCode: 0,
+        spinner
+      })
     }
 
-    if (result && result.error) {
+    if (result && result.countErrors > 0) {
       // eslint-disable-next-line no-console
       console.log()
-      return inquirer.prompt([
-        {
-          type: 'confirm',
+      return cliPrompt.prompt({
+        name: 'install',
+        message: 'Continue install ?',
+        default: false
+      })
+    } else {
+      if (result && result.countWarnings > 0) {
+        // eslint-disable-next-line no-console
+        console.log()
+        return cliPrompt.autoContinue({
           name: 'install',
-          message: 'Would you like to continue installing package(s)?',
-          default: false
-        }
-      ])
+          message: 'Auto-continue with install in... ',
+          timeInSeconds: 15
+        })
+      }
     }
 
     return { install: true }
   })
   .then((status) => {
     if (status && status.hasOwnProperty('install') && status.install === true) {
-      pkgMgr.process(cli.packageManager)
+      pkgMgr.process(cliArgs.packageManager)
     }
   })
   .catch((error) => {
-    // eslint-disable-next-line no-console
-    console.error(error)
-    process.exit(-1)
+    CliParser.exit({
+      errorCode: error.code || -1,
+      message: error.message || 'An error occurred',
+      spinner
+    })
   })
+
+// attach event handler for CTRL+C
+process.on('SIGINT', () => {
+  CliParser.exit({
+    errorCode: 0,
+    spinner
+  })
+})

package/lib/cli.js

@@ -1,26 +1,142 @@
 'use strict'
 
-const yargs = require('yargs')
-const cliCommons = require('./cliCommons')
-
-const argv = yargs
-  .version()
-  .usage('Usage: npq install <package> [options]')
-  .help('help')
-  .alias('help', 'h')
-  .options(cliCommons.getOptions())
-  .command(cliCommons.getInstallCommand())
-  .command({
-    command: '--packageManager [packageManager]',
-    aliases: ['--pkgMgr'],
-    desc: 'the package manager to offload handling the command',
-    builder: (yargs) => yargs.default('packageManager', 'npm')
-  })
-  .command({
-    command: '--dry-run',
-    desc: 'npq will run checks only and will not proceed with actually installing a package'
-  })
-  .example('npq install express')
-  .epilogue('curated by Liran Tal at https://github.com/lirantal/npq').argv
-
-module.exports = argv
+const { parseArgs } = require('node:util')
+const npa = require('npm-package-arg')
+const pkg = require('../package.json')
+
+class CliParser {
+  static exit({ errorCode, message, spinner }) {
+    if (spinner && spinner.isSpinning) {
+      spinner.stop()
+    }
+
+    if (message) {
+      console.error(message)
+    }
+
+    process.exit(errorCode || -1)
+  }
+
+  static _extractPackagesFromPositionals(positionals, earlyExitNoInstall = false) {
+    let packages = []
+    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
+      }
+    }
+
+    // Parse and normalize packages
+    return packages.map((pkg) => {
+      const parsedPackage = npa(pkg)
+      const versionModifier = parsedPackage.fetchSpec === '*' ? 'latest' : parsedPackage.fetchSpec
+      return `${parsedPackage.name}@${versionModifier}`
+    })
+  }
+
+  static parseArgsFull() {
+    const options = {
+      'dry-run': { type: 'boolean' },
+      plain: { type: 'boolean' },
+      packageManager: { type: 'string' },
+      pkgMgr: { type: 'string' },
+      help: { type: 'boolean', short: 'h' },
+      version: { type: 'boolean', short: 'v' }
+    }
+
+    const config = {
+      options,
+      allowPositionals: true,
+      strict: false
+    }
+
+    const { values, positionals } = parseArgs(config)
+
+    // Handle help
+    if (values.help) {
+      console.log(`Usage: npq install <package> [options]
+
+Commands:
+  install [package...]  install a package
+
+Options:
+      --dry-run           Run checks only, don't install
+      --plain             Force non-rich text output
+      --packageManager    Package Manager to use (default: npm)
+      --pkgMgr            Alias for packageManager
+  -h, --help              Show help
+  -v, --version           Show version
+
+Examples:
+  npq install express
+
+curated by Liran Tal at https://github.com/lirantal/npq`)
+      process.exit(0)
+    }
+
+    // Handle version
+    if (values.version) {
+      console.log(pkg.version)
+      process.exit(0)
+    }
+
+    // Process install command and packages
+    const normalizedPackages = this._extractPackagesFromPositionals(positionals)
+
+    return {
+      packages: normalizedPackages,
+      packageManager: values.packageManager || values.pkgMgr || 'npm',
+      dryRun: values['dry-run'] || false,
+      plain: values.plain || false
+    }
+  }
+
+  static parseArgsMinimal() {
+    const config = {
+      allowPositionals: true,
+      strict: false,
+      options: {
+        install: {
+          type: 'string',
+          short: 'i',
+          default: 'install'
+        }
+      }
+    }
+
+    const { positionals } = parseArgs(config)
+
+    const earlyExitNoInstall = true
+    const normalizedPackages = this._extractPackagesFromPositionals(positionals, earlyExitNoInstall)
+
+    return {
+      packages: normalizedPackages
+    }
+  }
+}
+
+module.exports.CliParser = CliParser

package/lib/helpers/cliPrompt.js

@@ -0,0 +1,97 @@
+'use strict'
+
+const { setTimeout } = require('node:timers/promises')
+const readline = require('node:readline/promises')
+const { stdin, stdout } = require('node:process')
+
+/**
+ * Simple CLI prompt for yes/no confirmation
+ * @param {Object} options - Prompt options
+ * @param {string} options.name - The property name for the result (e.g., 'install')
+ * @param {string} options.message - The question to ask
+ * @param {boolean} [options.default=false] - Default answer if user just presses Enter
+ * @returns {Promise<Object>} - Object with the specified property name and boolean value
+ */
+async function prompt(options = {}) {
+  const { name, message, default: defaultValue = false } = options
+
+  if (!message) {
+    throw new Error('Message is required for prompt')
+  }
+
+  if (!name) {
+    throw new Error('Name is required for prompt')
+  }
+
+  const rl = readline.createInterface({
+    input: stdin,
+    output: stdout
+  })
+
+  try {
+    // Format the prompt message with default indicator
+    const defaultIndicator = defaultValue ? 'Y/n' : 'y/N'
+    const promptMessage = `${message} (${defaultIndicator}) `
+
+    const answer = await rl.question(promptMessage)
+
+    // Parse the answer
+    const normalizedAnswer = answer.trim().toLowerCase()
+
+    let result
+    if (normalizedAnswer === '') {
+      // User pressed Enter without typing anything, use default
+      result = defaultValue
+    } else if (['y', 'yes'].includes(normalizedAnswer)) {
+      result = true
+    } else if (['n', 'no'].includes(normalizedAnswer)) {
+      result = false
+    } else {
+      // Invalid input, ask again
+      rl.close()
+      console.log('Please answer with y/yes or n/no.')
+      return prompt(options)
+    }
+
+    return { [name]: result }
+  } finally {
+    rl.close()
+  }
+}
+
+async function autoContinue({ name, message, timeInSeconds = 5 } = {}) {
+  // Show initial message with countdown
+  process.stdout.write(`${message}${timeInSeconds}`)
+
+  // Count down from timeInSeconds-1 to 1
+  for (let i = timeInSeconds - 1; i > 0; i--) {
+    await setTimeout(1000)
+
+    // Calculate how many characters to backspace (previous number length)
+    const prevNumber = i + 1
+    const prevLength = prevNumber.toString().length
+    const currentLength = i.toString().length
+
+    // Backspace to beginning of number
+    const backspaces = '\b'.repeat(prevLength)
+
+    // Write new number and pad with spaces if needed to clear any remaining digits
+    const padding = ' '.repeat(Math.max(0, prevLength - currentLength))
+    const moveBack = '\b'.repeat(Math.max(0, prevLength - currentLength))
+
+    process.stdout.write(`${backspaces}${i}${padding}${moveBack}`)
+  }
+
+  // Wait for the final second
+  await setTimeout(1000)
+
+  // Move to next line after countdown completes
+  console.log()
+
+  return { [name]: true }
+}
+
+module.exports = {
+  prompt,
+  autoContinue
+}

package/lib/helpers/cliSpinner.js

@@ -0,0 +1,104 @@
+const growVertical = {
+  interval: 120,
+  frames: ['▁', '▃', '▄', '▅', '▆', '▇', '▆', '▅', '▄', '▃']
+}
+
+class Spinner {
+  constructor(options = {}) {
+    this.spinner = options.spinner || growVertical
+    this.text = options.text || ''
+    this.color = options.color || null
+    this.stream = options.stream || process.stderr
+    this.frameIndex = 0
+    this.timer = null
+    this.isSpinning = false
+  }
+
+  start(text) {
+    if (this.isSpinning) {
+      return
+    }
+
+    if (text) {
+      this.text = text
+    }
+
+    this.isSpinning = true
+    this.frameIndex = 0
+
+    // Hide cursor
+    this.stream.write('\u001B[?25l')
+
+    this.timer = setInterval(() => {
+      this.render()
+    }, this.spinner.interval)
+
+    this.render()
+  }
+
+  stop(finalText) {
+    if (!this.isSpinning) {
+      return
+    }
+
+    clearInterval(this.timer)
+    this.isSpinning = false
+
+    // Clear current line and show cursor
+    this.stream.write('\r\u001B[K\u001B[?25h')
+
+    if (finalText) {
+      this.stream.write(finalText + '\n')
+    }
+  }
+
+  succeed(text) {
+    this.stop()
+    const message = text || this.text
+    this.stream.write(`✅ ${message}\n`)
+  }
+
+  fail(text) {
+    this.stop()
+    const message = text || this.text
+    this.stream.write(`❌ ${message}\n`)
+  }
+
+  warn(text) {
+    this.stop()
+    const message = text || this.text
+    this.stream.write(`⚠️  ${message}\n`)
+  }
+
+  info(text) {
+    this.stop()
+    const message = text || this.text
+    this.stream.write(`ℹ️  ${message}\n`)
+  }
+
+  setText(text) {
+    this.text = text
+  }
+
+  update(text) {
+    this.text = text
+    if (this.isSpinning) {
+      this.render()
+    }
+  }
+
+  render() {
+    const frame = this.spinner.frames[this.frameIndex]
+    const output = `${frame} ${this.text}`
+
+    // Move cursor to beginning of line and clear it
+    this.stream.write('\r\u001B[K')
+    this.stream.write(output)
+
+    this.frameIndex = (this.frameIndex + 1) % this.spinner.frames.length
+  }
+}
+
+module.exports = {
+  Spinner
+}