@modernpoacher/deps/src/install/index.mjs

Update NPM package dependencies from the command line

/**
 *  @typedef {DepsTypes.DependencyDescriptor}  DependencyDescriptor
 *  @typedef {DepsTypes.Package} Package
 *  @typedef {DepsTypes.Configuration} Configuration
 */

import debug from 'debug'

import {
  normalize
} from 'node:path'

import {
  exec
} from 'node:child_process'

import {
  VERSION,
  PLATFORM
} from '#deps/src/common/env'

import {
  getOptions
} from '#deps/src/common/options'

import {
  DIRECTORY,
  REGISTRY,
  getNoSaveParameter,
  getRegistryParameter,
  getForceParameter,
  getSaveExactParameter,
  getCommands,
  normalizeCommands,
  transform,
  getDepsExact,
  getDeps
} from '#deps/src/common'

const log = debug('@modernpoacher/deps')
const info = debug('@modernpoacher/deps:info')

log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)

/**
 *  @function getInstallSaveExactCommands
 *
 *  Get the `install --save-exact` commands as a string
 *
 *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
 *  @param {boolean} s - Save
 *  @param {string} r - Registry
 *  @param {boolean} f - Force
 *  @returns {string}
 */
export function getInstallSaveExactCommands (p, s, r, f) {
  log('getInstallSaveExactCommands')

  const commands = normalizeCommands(
    getNoSaveParameter(s, getRegistryParameter(r, getForceParameter(f, getSaveExactParameter(`npm i ${transform(p)}`))))
  )

  info(commands)

  return commands
}

/**
 *  @function getInstallCommands
 *
 *  Get the `install` commands as a string
 *
 *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
 *  @param {boolean} s - Save
 *  @param {string} r - Registry
 *  @param {boolean} f - Force
 *  @returns {string}
 */
export function getInstallCommands (p, s, r, f) {
  log('getInstallCommands')

  const commands = normalizeCommands(
    getNoSaveParameter(s, getRegistryParameter(r, getForceParameter(f, `npm i ${transform(p)}`)))
  )

  info(commands)

  return commands
}

/**
 *  @function installSaveExact
 *
 *  Spawn the `install --save-exact` commands
 *
 *  @param {string} d - Directory
 *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
 *  @param {boolean} s - Save
 *  @param {string} r - Registry
 *  @param {boolean} f - Force
 *  @returns {Promise<string>}
 */
export function installSaveExact (d, p, s, r, f) {
  log('installSaveExact')

  const directory = normalize(d.trim())

  info(`Directory is "${directory}"`)

  return (
    new Promise((resolve, reject) => {
      const commands = getCommands(getInstallSaveExactCommands(p, s, r, f))
      const options = getOptions(directory)

      const {
        stdout,
        stderr
      } = exec(commands, options, (e, v) => {
        return (!e) ? resolve(v) : reject(e)
      })

      if (stdout) stdout.on('data', log)
      if (stderr) stderr.on('data', log)
    })
  )
}

/**
 *  @function install
 *
 *  Spawn the `install` commands
 *
 *  @param {string} d - Directory
 *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
 *  @param {boolean} s - Save
 *  @param {string} r - Registry
 *  @param {boolean} f - Force
 *  @returns {Promise<string>}
 */
export function install (d, p, s, r, f) {
  log('install')

  const directory = normalize(d.trim())

  info(`Directory is "${directory}"`)

  return (
    new Promise((resolve, reject) => {
      const commands = getCommands(getInstallCommands(p, s, r, f))
      const options = getOptions(directory)

      const {
        stdout,
        stderr
      } = exec(commands, options, (e, v) => {
        return (!e) ? resolve(v) : reject(e)
      })

      if (stdout) stdout.on('data', log)
      if (stderr) stderr.on('data', log)
    })
  )
}

/**
 *  @function execute
 *
 *  Execute the `install --save-exact` and `install` commands
 *
 *  @param {string} d - Directory
 *  @param {Package} p - Package
 *  @param {Configuration} c - Configuration
 *  @param {boolean} s - Save
 *  @param {string} r - Registry
 *  @param {boolean} f - Force
 *  @returns {Promise<void>}
 */
export async function execute (d = DIRECTORY, p = {}, c = {}, s = false, r = REGISTRY, f = false) {
  log('execute')

  const depsExact = getDepsExact(p, c)

  if (depsExact.length) await installSaveExact(d, depsExact, s, r, f)

  const deps = getDeps(p)

  if (deps.length) await install(d, deps, s, r, f)
}