@modernpoacher/deps 2.2.19 → 2.2.20

package/src/index.mjs

@@ -1,3 +1,7 @@
+/**
+ *  @typedef {import('node:child_process').ExecException} ExecException
+ */
+
 /**
  *  Package or configuration dependencies
  *  @typedef {import('./common/index.mjs').Dependencies} Dependencies
@@ -8,7 +12,12 @@
  *  @typedef {import('./common/index.mjs').DependencyDescriptor} DependencyDescriptor
  */
 
-import debug from 'debug'
+/**
+ *  @callback HandleComplete
+ *  @param {ExecException | null} e
+ *  @param {string} v
+ *  @returns {void}
+ */
 
 import stripAnsi from 'strip-ansi'
 
@@ -20,6 +29,8 @@ import {
   exec
 } from 'node:child_process'
 
+import debug from '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM
@@ -83,9 +94,8 @@ export function use (key) {
 
 /**
  *  @function getInstallSaveExactCommands
- *
+ *  @description
  *  Get the `npm install --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -101,9 +111,8 @@ export function getInstallSaveExactCommands (deps, r, f) {
 
 /**
  *  @function getInstallCommands
- *
+ *  @description
  *  Get the `npm install` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -119,9 +128,8 @@ export function getInstallCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveBundleSaveExactCommands
- *
+ *  @description
  *  Get the `npm install --save-bundle --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -141,9 +149,8 @@ export function getInstallSaveBundleSaveExactCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveBundleCommands
- *
+ *  @description
  *  Get the `npm install --save-bundle` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -163,9 +170,8 @@ export function getInstallSaveBundleCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveOptionalSaveExactCommands
- *
+ *  @description
  *  Get the `npm install --save-optional --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -185,9 +191,8 @@ export function getInstallSaveOptionalSaveExactCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveOptionalCommands
- *
+ *  @description
  *  Get the `npm install --save-optional` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -207,9 +212,8 @@ export function getInstallSaveOptionalCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveDevSaveExactCommands
- *
+ *  @description
  *  Get the `npm install --save-dev --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -229,9 +233,8 @@ export function getInstallSaveDevSaveExactCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveDevCommands
- *
+ *  @description
  *  Get the `npm install --save-dev` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -251,9 +254,8 @@ export function getInstallSaveDevCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveProdSaveExactCommands
- *
+ *  @description
  *  Get the `npm install --save-prod --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -273,9 +275,8 @@ export function getInstallSaveProdSaveExactCommands (deps, r, f) {
 
 /**
  *  @function getInstallSaveProdCommands
- *
+ *  @description
  *  Get the `npm install --save-prod` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
@@ -295,9 +296,8 @@ export function getInstallSaveProdCommands (deps, r, f) {
 
 /**
  *  @function installSaveBundleSaveExact
- *
+ *  @description
  *  Spawn the `npm install --save-bundle --save-exact` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -315,13 +315,21 @@ export function installSaveBundleSaveExact (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveBundleSaveExactCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-bundle-save-exact')
 
@@ -333,9 +341,8 @@ export function installSaveBundleSaveExact (d, deps, r, f) {
 
 /**
  *  @function installSaveBundle
- *
+ *  @description
  *  Spawn the `npm install --save-bundle` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -353,13 +360,21 @@ export function installSaveBundle (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveBundleCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-bundle')
 
@@ -371,9 +386,8 @@ export function installSaveBundle (d, deps, r, f) {
 
 /**
  *  @function installSaveOptionalSaveExact
- *
+ *  @description
  *  Spawn the `npm install --save-optional --save-exact` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -391,13 +405,21 @@ export function installSaveOptionalSaveExact (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveOptionalSaveExactCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-otional-save-exact')
 
@@ -409,9 +431,8 @@ export function installSaveOptionalSaveExact (d, deps, r, f) {
 
 /**
  *  @function installSaveOptional
- *
+ *  @description
  *  Spawn the `npm install --save-optional` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependencies
  *  @param {string} r - Registry
@@ -429,13 +450,21 @@ export function installSaveOptional (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveOptionalCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-otional')
 
@@ -447,9 +476,8 @@ export function installSaveOptional (d, deps, r, f) {
 
 /**
  *  @function installSaveDevSaveExact
- *
+ *  @description
  *  Spawn the `npm install --save-dev --save-exact` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -467,13 +495,21 @@ export function installSaveDevSaveExact (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveDevSaveExactCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-dev-save-exact')
 
@@ -485,9 +521,8 @@ export function installSaveDevSaveExact (d, deps, r, f) {
 
 /**
  *  @function installSaveDev
- *
+ *  @description
  *  Spawn the `npm install --save-dev` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -505,13 +540,21 @@ export function installSaveDev (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveDevCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-dev')
 
@@ -523,9 +566,8 @@ export function installSaveDev (d, deps, r, f) {
 
 /**
  *  @function installSaveProdSaveExact
- *
+ *  @description
  *  Spawn the `npm install --save-prod --save-exact` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -543,13 +585,21 @@ export function installSaveProdSaveExact (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveProdSaveExactCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-prod-save-exact')
 
@@ -561,9 +611,8 @@ export function installSaveProdSaveExact (d, deps, r, f) {
 
 /**
  *  @function installSaveProd
- *
+ *  @description
  *  Spawn the `npm install --save-prod` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
@@ -581,13 +630,21 @@ export function installSaveProd (d, deps, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveProdCommands(deps, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('install-save-prod')
 
@@ -599,9 +656,8 @@ export function installSaveProd (d, deps, r, f) {
 
 /**
  *  @function executeBundle
- *
+ *  @description
  *  Execute the `npm install --save-bundle --save-exact` and `npm install --save-bundle` commands
- *
  *  @param {string} d - Directory
  *  @param {Dependencies} packageDependencies - Package dependencies
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
@@ -623,9 +679,8 @@ export async function executeBundle (d = DIRECTORY, packageDependencies = {}, co
 
 /**
  *  @function executeOptional
- *
+ *  @description
  *  Execute the `npm install --save-optional --save-exact` and `npm install --save-optional` commands
- *
  *  @param {string} d - Directory
  *  @param {Dependencies} packageDependencies - Package dependencies
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
@@ -647,9 +702,8 @@ export async function executeOptional (d = DIRECTORY, packageDependencies = {},
 
 /**
  *  @function executeDev
- *
+ *  @description
  *  Execute the `npm install --save-dev --save-exact` and `npm install --save-dev` commands
- *
  *  @param {string} d - Directory
  *  @param {Dependencies} packageDependencies - Package dependencies
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
@@ -671,9 +725,8 @@ export async function executeDev (d = DIRECTORY, packageDependencies = {}, confi
 
 /**
  *  @function executeProd
- *
+ *  @description
  *  Execute the `npm install --save-prod --save-exact` and `npm install --save-prod` commands
- *
  *  @param {string} d - Directory
  *  @param {Dependencies} packageDependencies - Package dependencies
  *  @param {Dependencies} configurationDependencies - Configuration dependencies

package/src/install/index.mjs

@@ -1,10 +1,16 @@
 /**
- *  @typedef {DepsTypes.DependencyDescriptor}  DependencyDescriptor
+ *  @typedef {import('node:child_process').ExecException} ExecException
+ *  @typedef {DepsTypes.DependencyDescriptor} DependencyDescriptor
  *  @typedef {DepsTypes.Package} Package
  *  @typedef {DepsTypes.Configuration} Configuration
  */
 
-import debug from 'debug'
+/**
+ *  @callback HandleComplete
+ *  @param {ExecException | null} e
+ *  @param {string} v
+ *  @returns {void}
+ */
 
 import {
   normalize
@@ -14,6 +20,8 @@ import {
   exec
 } from 'node:child_process'
 
+import debug from '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM
@@ -44,9 +52,8 @@ log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)
 
 /**
  *  @function getInstallSaveExactCommands
- *
+ *  @description
  *  Get the `install --save-exact` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
@@ -67,9 +74,8 @@ export function getInstallSaveExactCommands (p, s, r, f) {
 
 /**
  *  @function getInstallCommands
- *
+ *  @description
  *  Get the `install` commands as a string
- *
  *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
@@ -90,9 +96,8 @@ export function getInstallCommands (p, s, r, f) {
 
 /**
  *  @function installSaveExact
- *
+ *  @description
  *  Spawn the `install --save-exact` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
  *  @param {boolean} s - Save
@@ -111,13 +116,21 @@ export function installSaveExact (d, p, s, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallSaveExactCommands(p, s, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       if (stdout) stdout.on('data', log)
       if (stderr) stderr.on('data', log)
@@ -127,9 +140,8 @@ export function installSaveExact (d, p, s, r, f) {
 
 /**
  *  @function install
- *
+ *  @description
  *  Spawn the `install` commands
- *
  *  @param {string} d - Directory
  *  @param {DependencyDescriptor | DependencyDescriptor[]} p - Package
  *  @param {boolean} s - Save
@@ -148,13 +160,21 @@ export function install (d, p, s, r, f) {
     new Promise((resolve, reject) => {
       const commands = getCommands(getInstallCommands(p, s, r, f))
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        return (!e) ? resolve(v) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       if (stdout) stdout.on('data', log)
       if (stderr) stderr.on('data', log)
@@ -164,9 +184,8 @@ export function install (d, p, s, r, f) {
 
 /**
  *  @function execute
- *
+ *  @description
  *  Execute the `install --save-exact` and `install` commands
- *
  *  @param {string} d - Directory
  *  @param {Package} p - Package
  *  @param {Configuration} c - Configuration