@modernpoacher/deps 2.2.14 → 2.2.15

package/bin/deps.mjs

@@ -6,6 +6,8 @@ import {
   Command
 } from 'commander'
 
+import '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM
@@ -33,14 +35,6 @@ import {
   executeBundle
 } from '#deps/src'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
-
 const log = debug('@modernpoacher/deps')
 
 log(`\`deps\` (${VERSION} - ${PLATFORM}) is awake`)

package/bin/node/deps.mjs

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   exec
 } from 'node:child_process'
@@ -10,11 +8,7 @@ import {
   join
 } from 'node:path'
 
-import {
-  getArgs,
-  use,
-  handleComplete
-} from '#deps/bin/common'
+import '#deps/src/common/debug'
 
 import {
   PLATFORM,
@@ -25,13 +19,11 @@ import {
   getOptions
 } from '#deps/src/common/options'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
+import {
+  getArgs,
+  use,
+  handleComplete
+} from '#deps/bin/common'
 
 const command = (
   PLATFORM === 'win32'

package/bin/node/execute.mjs

@@ -15,6 +15,8 @@ import {
   Command
 } from 'commander'
 
+import '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM
@@ -53,14 +55,6 @@ import {
   getPackage
 } from '#deps/bin/common'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
-
 const log = debug('@modernpoacher/deps')
 
 log(`\`execute\` (${VERSION} - ${PLATFORM}) is awake`)
@@ -96,13 +90,12 @@ async function isHeadDefaultBranch (directory) {
 }
 
 /**
- * @function getIgnoreFromConfiguration
- *
- * Interrogates `.depsrc` or `.depsrc.json` for an `ignore` value
+ *  @function getIgnoreFromConfiguration
  *
- * @param {string} directory
+ *  Interrogates `.depsrc` or `.depsrc.json` for an `ignore` value
  *
- * @return {Promise<boolean>}
+ *  @param {string} directory
+ *  @returns {Promise<boolean>}
  */
 async function getIgnoreFromConfiguration (directory) {
   log('getIgnoreFromConfiguration')
@@ -119,13 +112,12 @@ async function getIgnoreFromConfiguration (directory) {
 }
 
 /**
- * @function getAuthorFromConfiguration
+ *  @function getAuthorFromConfiguration
  *
- * Interrogates `.depsrc` or `.depsrc.json` for an `author` value
+ *  Interrogates `.depsrc` or `.depsrc.json` for an `author` value
  *
- * @param {string} directory
- *
- * @return {Promise<string|null>}
+ *  @param {string} directory
+ *  @returns {Promise<string|null>}
  */
 async function getAuthorFromConfiguration (directory) {
   log('getAuthorFromConfiguration')
@@ -142,13 +134,12 @@ async function getAuthorFromConfiguration (directory) {
 }
 
 /**
- * @function getAuthorFromPackage
- *
- * Interrogates `package.json` for an `author` value
+ *  @function getAuthorFromPackage
  *
- * @param {string} directory
+ *  Interrogates `package.json` for an `author` value
  *
- * @return {Promise<string|null>}
+ *  @param {string} directory
+ *  @returns {Promise<string|null>}
  */
 async function getAuthorFromPackage (directory) {
   log('getAuthorFromPackage')
@@ -165,13 +156,12 @@ async function getAuthorFromPackage (directory) {
 }
 
 /**
- * @function getMessageFromConfiguration
- *
- * Interrogates `.depsrc` or `.depsrc.json` for a `message` value
+ *  @function getMessageFromConfiguration
  *
- * @param {string} directory
+ *  Interrogates `.depsrc` or `.depsrc.json` for a `message` value
  *
- * @return {Promise<string|null>}
+ *  @param {string} directory
+ *  @returns {Promise<string|null>}
  */
 async function getMessageFromConfiguration (directory) {
   log('getMessageFromConfiguration')
@@ -188,34 +178,32 @@ async function getMessageFromConfiguration (directory) {
 }
 
 /**
- * @function toAuthor
+ *  @function toAuthor
  *
- * Ensures that the `author` is set either from the command line,
- * configuration, package, or a default
+ *  Ensures that the `author` is set either from the command line,
+ *  configuration, package, or a default
  *
- * Since it can be null `author` may not default in function arguments
+ *  Since it can be null `author` may not default in function arguments
  *
- * @param {string|null} author
- * @param {string} directory
- *
- * @return {Promise<string>}
+ *  @param {string|null} author
+ *  @param {string} directory
+ *  @returns {Promise<string>}
  */
 async function toAuthor (author, directory) {
   return author || await getAuthorFromConfiguration(directory) || await getAuthorFromPackage(directory) || AUTHOR
 }
 
 /**
- * @function toMessage
- *
- * Ensures that the `message` is set either from the command line,
- * configuration, or a default
+ *  @function toMessage
  *
- * Since it can be null `message` may not default in function arguments
+ *  Ensures that the `message` is set either from the command line,
+ *  configuration, or a default
  *
- * @param {string|null} message
- * @param {string} directory
+ *  Since it can be null `message` may not default in function arguments
  *
- * @return {Promise<string>}
+ *  @param {string|null} message
+ *  @param {string} directory
+ *  @returns {Promise<string>}
  */
 async function toMessage (message, directory) {
   return message || await getMessageFromConfiguration(directory) || MESSAGE

package/bin/node/head.mjs

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   exec
 } from 'node:child_process'
@@ -10,11 +8,7 @@ import {
   join
 } from 'node:path'
 
-import {
-  getArgs,
-  use,
-  handleComplete
-} from '#deps/bin/common'
+import '#deps/src/common/debug'
 
 import {
   PLATFORM,
@@ -25,13 +19,11 @@ import {
   getOptions
 } from '#deps/src/common/options'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
+import {
+  getArgs,
+  use,
+  handleComplete
+} from '#deps/bin/common'
 
 const command = (
   PLATFORM === 'win32'

package/bin/node/install.mjs

@@ -6,6 +6,8 @@ import {
   Command
 } from 'commander'
 
+import '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM
@@ -31,14 +33,6 @@ import {
   execute
 } from '#deps/src/install'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
-
 const log = debug('@modernpoacher/deps')
 
 log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)

package/bin/node/push.mjs

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   exec
 } from 'node:child_process'
@@ -10,11 +8,7 @@ import {
   join
 } from 'node:path'
 
-import {
-  getArgs,
-  use,
-  handleComplete
-} from '#deps/bin/common'
+import '#deps/src/common/debug'
 
 import {
   PLATFORM,
@@ -25,13 +19,11 @@ import {
   getOptions
 } from '#deps/src/common/options'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
-
-debug.enable(DEBUG)
+import {
+  getArgs,
+  use,
+  handleComplete
+} from '#deps/bin/common'
 
 const command = (
   PLATFORM === 'win32'

package/bin/node/wipe.mjs

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   exec
 } from 'node:child_process'
@@ -10,12 +8,6 @@ import {
   join
 } from 'node:path'
 
-import {
-  getArgs,
-  use,
-  handleComplete
-} from '#deps/bin/common'
-
 import {
   PLATFORM,
   BIN
@@ -25,13 +17,13 @@ import {
   getOptions
 } from '#deps/src/common/options'
 
-const {
-  env: {
-    DEBUG = '@modernpoacher/deps*'
-  }
-} = process
+import '#deps/src/common/debug'
 
-debug.enable(DEBUG)
+import {
+  getArgs,
+  use,
+  handleComplete
+} from '#deps/bin/common'
 
 const command = (
   PLATFORM === 'win32'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.2.14",
+  "version": "2.2.15",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -19,7 +19,7 @@
   },
   "license": "ISC",
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=22.11.0"
   },
   "repository": {
     "type": "git",
@@ -53,24 +53,24 @@
     "deps-wipe": "bin/deps/wipe.sh"
   },
   "dependencies": {
-    "commander": "^13.0.0",
+    "commander": "^13.1.0",
     "debug": "^4.4.0",
     "glob": "^11.0.1",
     "strip-ansi": "^7.1.0",
     "supports-color": "^10.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.0",
-    "@babel/eslint-parser": "^7.25.9",
-    "@babel/preset-env": "^7.26.0",
+    "@babel/core": "^7.26.10",
+    "@babel/eslint-parser": "^7.26.10",
+    "@babel/preset-env": "^7.26.9",
     "@babel/register": "^7.25.9",
-    "chai": "^5.1.2",
-    "core-js": "^3.40.0",
+    "chai": "^5.2.0",
+    "core-js": "^3.41.0",
     "cross-env": "^7.0.3",
     "eslint": "8.57.1",
     "eslint-config-standard": "^17.1.0",
     "husky": "^9.1.7",
-    "mocha": "^11.0.1"
+    "mocha": "^11.1.0"
   },
   "imports": {
     "#deps/bin": "./bin/index.mjs",

package/src/common/debug.mjs

@@ -0,0 +1,9 @@
+import debug from 'debug'
+
+const {
+  env: {
+    DEBUG = '@modernpoacher/deps*'
+  }
+} = process
+
+if (DEBUG) debug.enable(DEBUG)

package/src/common/git/index.mjs

@@ -150,8 +150,7 @@ export function err (key, directory) {
  *  Get an error code from an error
  *
  *  @param {Error}
- *
- *  @return {number}
+ *  @returns {number}
  */
 const getErrorCode = ({ code = 0 } = {}) => code
 
@@ -161,8 +160,7 @@ const getErrorCode = ({ code = 0 } = {}) => code
  *  Get an error message from an error
  *
  *  @param {Error}
- *
- *  @return {string}
+ *  @returns {string}
  */
 const getErrorMessage = ({ message = '' } = {}) => message
 
@@ -172,8 +170,7 @@ const getErrorMessage = ({ message = '' } = {}) => message
  *  Determine whether an error is a safe non-zero exit from a Git command
  *
  *  @param {Error}
- *
- *  @return {boolean}
+ *  @returns {boolean}
  */
 function isCommandError (e) {
   log('isCommandError')
@@ -190,8 +187,7 @@ function isCommandError (e) {
  *  Get the default branch from `.git/refs/remotes/origin/HEAD`
  *
  *  @param {string} d - A directory configured for Git
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function catGitRefsRemotesOriginHead (d = DIRECTORY) {
   log('catGitRefsRemotesOriginHead')
@@ -224,8 +220,7 @@ export function catGitRefsRemotesOriginHead (d = DIRECTORY) {
  *  Get the remote default branch
  *
  *  @param {string} d - A directory configured for Git
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function awkGitRemoteShowOriginHead (d = DIRECTORY) {
   log('awkGitRemoteShowOriginHead')
@@ -258,8 +253,7 @@ export function awkGitRemoteShowOriginHead (d = DIRECTORY) {
  *  Determine whether a directory is configured for Git
  *
  *  @param {string} d - A directory
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitRevParseShowTopLevel (d = DIRECTORY) {
   log('gitRevParseShowTopLevel')
@@ -292,8 +286,7 @@ export function gitRevParseShowTopLevel (d = DIRECTORY) {
  *  Determine which branch is HEAD
  *
  *  @param {string} d - A directory
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitRevParseAbbrevRefHead (d = DIRECTORY) {
   log('gitRevParseAbbrevRefHead')
@@ -327,8 +320,7 @@ export function gitRevParseAbbrevRefHead (d = DIRECTORY) {
  *
  *  @param {string} d - A directory configured for Git
  *  @param {string} branch - The Git branch
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
   log('gitCheckout')
@@ -365,8 +357,7 @@ export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
  *  Pull changes from the Git remote
  *
  *  @param {string} d - A directory configured for Git
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitPull (d = DIRECTORY) {
   log('gitPull')
@@ -403,8 +394,7 @@ export function gitPull (d = DIRECTORY) {
  *  Push changes to the Git remote
  *
  *  @param {string} d - A directory configured for Git
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitPush (d = DIRECTORY) {
   log('gitPush')
@@ -441,8 +431,7 @@ export function gitPush (d = DIRECTORY) {
  *  Push tags changes to the Git remote
  *
  *  @param {string} d - A directory configured for Git
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitPushTags (d = DIRECTORY) {
   log('gitPushTags')
@@ -480,8 +469,7 @@ export function gitPushTags (d = DIRECTORY) {
  *
  *  @param {string} d - A directory configured for Git
  *  @param {string} add - An add parameter
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitAdd (d = DIRECTORY, add = ADD) {
   log('gitAdd')
@@ -520,8 +508,7 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
  *  @param {string} c - A directory configured for Git
  *  @param {string} message - A commit message
  *  @param {string} author - The commit author
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function gitCommit (d = DIRECTORY, message = MESSAGE, author = AUTHOR) {
   log('gitCommit')

package/src/common/index.mjs

@@ -1,36 +1,40 @@
 /**
- * Package or configuration dependencies
- * @typedef {Object.<string, string>} Dependencies
+ *  Package or configuration dependencies
+ *
+ *  @typedef {Record<string, string>} Dependencies
  */
 
 /**
- * A dependency descriptor
- * @typedef {Object} DependencyDescriptor
- * @property {string} name - Dependency name in NPM.
- * @property {string} version - Dependency version or "latest".
+ *  A dependency descriptor
+ *
+ *  @typedef {Object} DependencyDescriptor
+ *  @property {string} name - Dependency name in NPM.
+ *  @property {string} version - Dependency version or "latest".
  */
 
 /**
- * A package
- * @typedef {Object} Package
- * @property {string|{name: string, email: string}} author
- * @property {Dependencies} dependencies - Production dependencies.
- * @property {Dependencies} devDependencies - Development dependencies.
- * @property {Dependencies} optionalDependencies - Optional dependencies.
- * @property {Dependencies} bundleDependencies - Bundle dependencies.
- * @property {Dependencies} peerDependencies - Peer dependencies
+ *  A package
+ *
+ *  @typedef {Object} Package
+ *  @property {string|{name: string, email: string}} author
+ *  @property {Dependencies} dependencies - Production dependencies.
+ *  @property {Dependencies} devDependencies - Development dependencies.
+ *  @property {Dependencies} optionalDependencies - Optional dependencies.
+ *  @property {Dependencies} bundleDependencies - Bundle dependencies.
+ *  @property {Dependencies} peerDependencies - Peer dependencies
  */
 
 /**
- * A configuration
- * @typedef {Object} Configuration
- * @property {string|{name: string, email: string}} author
- * @property {boolean} ignore
- * @property {Dependencies} dependencies - Production dependencies.
- * @property {Dependencies} devDependencies - Development dependencies.
- * @property {Dependencies} optionalDependencies - Optional dependencies.
- * @property {Dependencies} bundleDependencies - Bundle dependencies.
- * @property {Dependencies} peerDependencies - Peer dependencies
+ *  A configuration
+ *
+ *  @typedef {Object} Configuration
+ *  @property {string|{name: string, email: string}} author
+ *  @property {boolean} ignore
+ *  @property {Dependencies} dependencies - Production dependencies.
+ *  @property {Dependencies} devDependencies - Development dependencies.
+ *  @property {Dependencies} optionalDependencies - Optional dependencies.
+ *  @property {Dependencies} bundleDependencies - Bundle dependencies.
+ *  @property {Dependencies} peerDependencies - Peer dependencies
  */
 
 import debug from 'debug'
@@ -68,8 +72,7 @@ export const trim = (v) => v.split(String.fromCharCode(10)).map((v) => v.trimEnd
  *  Get the `--save-prod` parameter
  *
  *  @param {string} current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getSaveProdParameter = (commands) => commands.concat(' --save-prod')
 
@@ -79,8 +82,7 @@ export const getSaveProdParameter = (commands) => commands.concat(' --save-prod'
  *  Get the `--save-dev` parameter
  *
  *  @param {string} current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getSaveDevParameter = (commands) => commands.concat(' --save-dev')
 
@@ -90,8 +92,7 @@ export const getSaveDevParameter = (commands) => commands.concat(' --save-dev')
  *  Get the "save bundle" parameter
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getSaveBundleParameter = (commands) => commands.concat(' --save-bundle')
 
@@ -101,8 +102,7 @@ export const getSaveBundleParameter = (commands) => commands.concat(' --save-bun
  *  Get the `--save-optional` parameter
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getSaveOptionalParameter = (commands) => commands.concat(' --save-optional')
 
@@ -113,8 +113,7 @@ export const getSaveOptionalParameter = (commands) => commands.concat(' --save-o
  *
  *  @param {string} r - Registry
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getRegistryParameter = (r, commands) => r ? commands.concat(` --registry ${r}`) : commands
 
@@ -125,8 +124,7 @@ export const getRegistryParameter = (r, commands) => r ? commands.concat(` --reg
  *
  *  @param {boolean} f - Force
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getForceParameter = (f, commands) => f ? commands.concat(' --force') : commands
 
@@ -137,8 +135,7 @@ export const getForceParameter = (f, commands) => f ? commands.concat(' --force'
  *
  *  @param {boolean} s - Save
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getNoSaveParameter = (s, commands) => s ? commands : commands.concat(' --no-save')
 
@@ -148,8 +145,7 @@ export const getNoSaveParameter = (s, commands) => s ? commands : commands.conca
  *  Get the `--save-exact` parameter
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getSaveExactParameter = (commands) => commands.concat(' --save-exact')
 
@@ -159,8 +155,7 @@ export const getSaveExactParameter = (commands) => commands.concat(' --save-exac
  *  Get the export PATH shell script
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getExportPath = (commands) => `
 export PATH=/usr/local/bin:$PATH &> /dev/null
@@ -173,8 +168,7 @@ ${commands}
  *  Get the NVM shell script
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getNvm = (commands) => `
 bash "${NVM}" 2> /dev/null
@@ -187,8 +181,7 @@ ${commands}
  *  Get the installation shell script
  *
  *  @param {string} commands - Current commands string
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const getCommands = PLATFORM === 'win32'
   ? (commands = 'npm i') => tidy(commands)
@@ -200,8 +193,7 @@ export const getCommands = PLATFORM === 'win32'
  *  Get the production dependencies by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {Dependencies}
+ *  @returns {Dependencies}
  */
 export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
 
@@ -211,8 +203,7 @@ export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
  *  Get the development dependencies by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {Dependencies}
+ *  @returns {Dependencies}
  */
 export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependencies
 
@@ -222,8 +213,7 @@ export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependen
  *  Get the optional dependencies by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {Dependencies}
+ *  @returns {Dependencies}
  */
 export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => optionalDependencies
 
@@ -233,8 +223,7 @@ export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => o
  *  Get the bundle dependencies by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {Dependencies}
+ *  @returns {Dependencies}
  */
 export const getBundleDependencies = ({ bundleDependencies = {} } = {}) => bundleDependencies
 
@@ -244,8 +233,7 @@ export const getBundleDependencies = ({ bundleDependencies = {} } = {}) => bundl
  *  Get the peer dependencies by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {Dependencies}
+ *  @returns {Dependencies}
  */
 export const getPeerDependencies = ({ peerDependencies } = {}) => peerDependencies
 
@@ -255,8 +243,7 @@ export const getPeerDependencies = ({ peerDependencies } = {}) => peerDependenci
  *  Get the ignore flag by destructuring the configuration
  *
  *  @param {Configuration}
- *
- *  @return {boolean}
+ *  @returns {boolean}
  */
 export const getIgnore = ({ ignore = false } = {}) => ignore === true
 
@@ -266,8 +253,7 @@ export const getIgnore = ({ ignore = false } = {}) => ignore === true
  *  Get the author by destructuring the package or configuration
  *
  *  @param {Package|Configuration}
- *
- *  @return {string|null}
+ *  @returns {string|null}
  */
 export const getAuthor = ({ author = '' } = {}) => {
   if ((author || false) instanceof Object) {
@@ -295,8 +281,7 @@ export const getAuthor = ({ author = '' } = {}) => {
  *  Get the message by destructuring the configuration
  *
  *  @param {Configuration}
- *
- *  @return {string|null}
+ *  @returns {string|null}
  */
 export const getMessage = ({ message = '' } = {}) => message || null
 
@@ -306,8 +291,7 @@ export const getMessage = ({ message = '' } = {}) => message || null
  *  Determine whether the dependency is a pre-release with a Regular Expression
  *
  *  @param {string} v
- *
- *  @return {boolean}
+ *  @returns {boolean}
  */
 export const isPreRelease = (v) => /-/.test(v)
 
@@ -317,8 +301,7 @@ export const isPreRelease = (v) => /-/.test(v)
  *  Determine whether the dependency is exact with a Regular Expression
  *
  *  @param {string} v
- *
- *  @return {boolean}
+ *  @returns {boolean}
  */
 export const isExact = (v) => /^\d/.test(v)
 
@@ -329,8 +312,7 @@ export const isExact = (v) => /^\d/.test(v)
  *
  *  @param {Dependencies} packageDependencies - Package dependencies
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
- *
- *  @return {DependencyDescriptor[]}
+ *  @returns {DependencyDescriptor[]}
  */
 export function getDepsExact (packageDependencies, configurationDependencies) {
   log('getDepsExact')
@@ -351,8 +333,7 @@ export function getDepsExact (packageDependencies, configurationDependencies) {
  *  Get an array of dependencies to be installed
  *
  *  @param {Dependencies} packageDependencies - Package dependencies
- *
- *  @return {DependencyDescriptor[]}
+ *  @returns {DependencyDescriptor[]}
  */
 export function getDeps (packageDependencies) {
   log('getDeps')
@@ -375,8 +356,7 @@ export function getDeps (packageDependencies) {
  *  Normalise the commands string
  *
  *  @param {string} value
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function normalizeCommands (commands) {
   const s = String.fromCharCode(32)
@@ -396,8 +376,7 @@ export function normalizeCommands (commands) {
  *  Transform by destructuring the value
  *
  *  @param {DependencyDescriptor}
- *
- *  @return {string}
+ *  @returns {string}
  */
 export const transformDependency = ({ name = '@modernpoacher/deps', version = 'latest' } = {}) => `${name}@${version}`
 
@@ -407,8 +386,7 @@ export const transformDependency = ({ name = '@modernpoacher/deps', version = 'l
  *  Transform the parameter to a string
  *
  *  @param {DependencyDescriptor|DependencyDescriptor[]} value
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function transform (value) {
   log('transform')

package/src/common/options/index.mjs

@@ -39,21 +39,20 @@ log(`\`common/options\` (${VERSION} - ${PLATFORM}) is awake`)
  *  Get the installation `exec` child process options
  *
  *  @param {string} cwd normalized directory
- *
- *  @return {{
-*    maxBuffer: number,
-*    stdio: string
-*    env: {
-*      DEBUG_COLORS: string,
-*      FORCE_COLOR: number,
-*      NODE_OPTIONS: string,
-*      SSH_AUTH_SOCK?: string,
-*      HOME?: string,
-*      PATH?: string
-*    }
-*    cwd: string
-*  }}
-*/
+ *  @returns {{
+ *    maxBuffer: number,
+ *    stdio: string
+ *    env: {
+ *      DEBUG_COLORS: string,
+ *      FORCE_COLOR: number,
+ *      NODE_OPTIONS: string,
+ *      SSH_AUTH_SOCK?: string,
+ *      HOME?: string,
+ *      PATH?: string
+ *    }
+ *    cwd: string
+ *  }}
+ */
 export function getOptions (cwd) {
   log('getOptions')
 

package/src/index.mjs

@@ -1,11 +1,11 @@
 /**
- * Package or configuration dependencies
- * @typedef {import('./common/index.mjs').Dependencies} Dependencies
+ *  Package or configuration dependencies
+ *  @typedef {import('./common/index.mjs').Dependencies} Dependencies
  */
 
 /**
- * Dependency descriptor
- * @typedef {import('./common/index.mjs').DependencyDescriptor} DependencyDescriptor
+ *  Dependency descriptor
+ *  @typedef {import('./common/index.mjs').DependencyDescriptor} DependencyDescriptor
  */
 
 import debug from 'debug'
@@ -77,8 +77,7 @@ export function use (key) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveExactCommands (deps, r, f) {
   log('getInstallSaveExactCommands')
@@ -96,8 +95,7 @@ export function getInstallSaveExactCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallCommands (deps, r, f) {
   log('getInstallCommands')
@@ -115,8 +113,7 @@ export function getInstallCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveBundleSaveExactCommands (deps, r, f) {
   log('getInstallSaveBundleSaveExactCommands')
@@ -138,8 +135,7 @@ export function getInstallSaveBundleSaveExactCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveBundleCommands (deps, r, f) {
   log('getInstallSaveBundleCommands')
@@ -161,8 +157,7 @@ export function getInstallSaveBundleCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveOptionalSaveExactCommands (deps, r, f) {
   log('getInstallSaveOptionalSaveExactCommands')
@@ -184,8 +179,7 @@ export function getInstallSaveOptionalSaveExactCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveOptionalCommands (deps, r, f) {
   log('getInstallSaveOptionalCommands')
@@ -207,8 +201,7 @@ export function getInstallSaveOptionalCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveDevSaveExactCommands (deps, r, f) {
   log('getInstallSaveDevSaveExactCommands')
@@ -230,8 +223,7 @@ export function getInstallSaveDevSaveExactCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveDevCommands (deps, r, f) {
   log('getInstallSaveDevCommands')
@@ -253,8 +245,7 @@ export function getInstallSaveDevCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveProdSaveExactCommands (deps, r, f) {
   log('getInstallSaveProdSaveExactCommands')
@@ -276,8 +267,7 @@ export function getInstallSaveProdSaveExactCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveProdCommands (deps, r, f) {
   log('getInstallSaveProdCommands')
@@ -300,8 +290,7 @@ export function getInstallSaveProdCommands (deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveBundleSaveExact (d, deps, r, f) {
   log('installSaveBundleSaveExact')
@@ -339,8 +328,7 @@ export function installSaveBundleSaveExact (d, deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveBundle (d, deps, r, f) {
   log('installSaveBundle')
@@ -378,8 +366,7 @@ export function installSaveBundle (d, deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveOptionalSaveExact (d, deps, r, f) {
   log('installSaveOptionalSaveExact')
@@ -417,8 +404,7 @@ export function installSaveOptionalSaveExact (d, deps, r, f) {
  *  @param {Dependencies} dependencies - Dependencies
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveOptional (d, dependencies, r, f) {
   log('installSaveOptional')
@@ -456,8 +442,7 @@ export function installSaveOptional (d, dependencies, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveDevSaveExact (d, deps, r, f) {
   log('installSaveDevSaveExact')
@@ -495,8 +480,7 @@ export function installSaveDevSaveExact (d, deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveDev (d, deps, r, f) {
   log('installSaveDev')
@@ -534,8 +518,7 @@ export function installSaveDev (d, deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveProdSaveExact (d, deps, r, f) {
   log('installSaveProdSaveExact')
@@ -573,8 +556,7 @@ export function installSaveProdSaveExact (d, deps, r, f) {
  *  @param {DependencyDescriptor|DependencyDescriptor[]} deps - Dependency descriptor(s)
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveProd (d, deps, r, f) {
   log('installSaveProd')
@@ -613,8 +595,7 @@ export function installSaveProd (d, deps, r, f) {
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<void>}
+ *  @returns {Promise<void>}
  */
 export async function executeBundle (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeBundle')
@@ -638,8 +619,7 @@ export async function executeBundle (d = DIRECTORY, packageDependencies = {}, co
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<void>}
+ *  @returns {Promise<void>}
  */
 export async function executeOptional (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeOptional')
@@ -663,8 +643,7 @@ export async function executeOptional (d = DIRECTORY, packageDependencies = {},
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<void>}
+ *  @returns {Promise<void>}
  */
 export async function executeDev (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeDev')
@@ -688,8 +667,7 @@ export async function executeDev (d = DIRECTORY, packageDependencies = {}, confi
  *  @param {Dependencies} configurationDependencies - Configuration dependencies
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<void>}
+ *  @returns {Promise<void>}
  */
 export async function executeProd (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeProd')

package/src/install/index.mjs

@@ -1,11 +1,11 @@
 /**
- * A package
- * @typedef {import('../common/index.mjs').Package} Package
+ *  A package
+ *  @typedef {import('../common/index.mjs').Package} Package
  */
 
 /**
- * A configuration
- * @typedef {import('../common/index.mjs').Configuration} Configuration
+ *  A configuration
+ *  @typedef {import('../common/index.mjs').Configuration} Configuration
  */
 
 import debug from 'debug'
@@ -55,8 +55,7 @@ log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallSaveExactCommands (p, s, r, f) {
   log('getInstallSaveExactCommands')
@@ -79,8 +78,7 @@ export function getInstallSaveExactCommands (p, s, r, f) {
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {string}
+ *  @returns {string}
  */
 export function getInstallCommands (p, s, r, f) {
   log('getInstallCommands')
@@ -104,8 +102,7 @@ export function getInstallCommands (p, s, r, f) {
  *  @param {Configuration} c - Configuration
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function installSaveExact (d, p, s, r, f) {
   log('installSaveExact')
@@ -142,8 +139,7 @@ export function installSaveExact (d, p, s, r, f) {
  *  @param {Configuration} c - Configuration
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
- *
- *  @return {Promise<string>}
+ *  @returns {Promise<string>}
  */
 export function install (d, p, s, r, f) {
   log('install')
@@ -181,8 +177,7 @@ export function install (d, p, s, r, f) {
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
- *
- *  @return {Promise<void>}
+ *  @returns {Promise<void>}
  */
 export async function execute (d = DIRECTORY, p = {}, c = {}, s = false, r = REGISTRY, f = false) {
   log('execute')