@modernpoacher/deps 2.2.18 → 2.2.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.2.18",
+  "version": "2.2.19",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -12,6 +12,7 @@
   ],
   "main": "./index.mjs",
   "type": "module",
+  "types": "./index.d.mts",
   "author": {
     "name": "Jonathan Perry for Modern Poacher Limited",
     "email": "modernpoacher@modernpoacher.com",
@@ -37,7 +38,7 @@
     "deps-install": "cross-env NODE_OPTIONS=--disable-warning=ExperimentalWarning DEBUG_COLORS=yes NODE_ENV=production node bin/deps/install.mjs",
     "deps-push": "cross-env NODE_OPTIONS=--disable-warning=ExperimentalWarning DEBUG_COLORS=yes NODE_ENV=production node bin/deps/push.mjs",
     "deps-wipe": "cross-env NODE_OPTIONS=--disable-warning=ExperimentalWarning DEBUG_COLORS=yes NODE_ENV=production node bin/deps/wipe.mjs",
-    "lint": "cross-env NODE_OPTIONS=--disable-warning=ExperimentalWarning eslint . --ext .mjs,.cjs",
+    "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "husky",
     "start": "npm run deps",
@@ -60,15 +61,16 @@
     "supports-color": "^10.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/eslint-parser": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/register": "^7.25.9",
+    "@sequencemedia/eslint-config-standard": "^0.2.47",
+    "@sequencemedia/eslint-config-typescript": "^0.1.69",
+    "@types/chai": "^5.2.1",
+    "@types/debug": "^4.1.12",
+    "@types/mocha": "^10.0.10",
+    "@typescript-eslint/parser": "^8.28.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",
+    "eslint": "^9.23.0",
+    "globals": "^16.0.0",
     "husky": "^9.1.7",
     "mocha": "^11.1.0"
   },

package/src/common/env/index.mjs

@@ -17,7 +17,7 @@ import {
 const {
   name: NAME,
   version: VERSION
-} = JSON.parse(readFileSync(join(PATH, 'package.json')))
+} = JSON.parse(readFileSync(join(PATH, 'package.json')).toString('utf8'))
 
 const PLATFORM = platform()
 

package/src/common/git/index.mjs

@@ -28,7 +28,7 @@ const ADD = 'package.json package-lock.json'
 
 export const MESSAGE = PLATFORM === 'win32'
   ? 'Updated `package.json` &/ `package-lock.json`'
-  : 'Updated \\`package.json\\` &/ \\`package-lock.json\\`' /* eslint-disable-line no-useless-escape */
+  : 'Updated \\`package.json\\` &/ \\`package-lock.json\\`'
 
 export const AUTHOR = 'Modern Poacher Limited <modernpoacher@modernpoacher.com>'
 
@@ -40,25 +40,19 @@ echo "\${BASH_REMATCH[0]}"
 
 const GIT_PULL = `
 source "${BIN}/common.sh"
-
 source_home "${BIN}"
-
 git pull
 `
 
 const GIT_PUSH = `
 source "${BIN}/common.sh"
-
 source_home "${BIN}"
-
 git push
 `
 
 const GIT_PUSH_TAGS = `
 source "${BIN}/common.sh"
-
 source_home "${BIN}"
-
 git push --tags
 `
 
@@ -66,25 +60,49 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`common/git\` (${VERSION} - ${PLATFORM}) is awake`)
 
+/**
+ *  @param {string} v
+ *  @returns {string}
+ */
 const trim = (v) => v.split(String.fromCharCode(10)).map((v) => v.trimEnd()).join(String.fromCharCode(10)).trim()
 
+/**
+ *  @param {string} v
+ *  @returns {boolean}
+ */
 function filter (v) {
   return Boolean(stripAnsi(v).trim())
 }
 
+/**
+ *  @param {string} directory
+ *  @returns {(s: string) => boolean}
+ */
 function getIsDirectory (directory) {
   return function isDirectory (s) {
     return directory === s
   }
 }
 
-function isFatal (s) {
-  return s.toLowerCase().startsWith('fatal: not a git repository')
+/**
+ *  @param {string} v
+ *  @returns {boolean}
+ */
+function isFatal (v) {
+  return v.toLowerCase().startsWith('fatal: not a git repository')
 }
 
+/**
+ *  @param {string} key
+ *  @returns {(value: string) => void}
+ */
 export function use (key) {
   const log = debug(`@modernpoacher/deps:${key}`)
 
+  /**
+   *  @param {string} v
+   *  @returns {void}
+   */
   function write (v) {
     log(v.trimEnd())
   }
@@ -96,11 +114,20 @@ export function use (key) {
   }
 }
 
+/**
+ *  @param {string} key
+ *  @param {string} directory
+ *  @returns {(value: string) => void}
+ */
 export function out (key, directory) {
   const log = debug(`@modernpoacher/deps:${key}`)
 
   const isDirectory = getIsDirectory(directory)
 
+  /**
+   *  @param {string} v
+   *  @returns {boolean}
+   */
   function filterOut (v) {
     const s = v.trim()
 
@@ -109,6 +136,10 @@ export function out (key, directory) {
     )
   }
 
+  /**
+   *  @param {string} v
+   *  @returns {void}
+   */
   function write (v) {
     if (v.trim()) log(v.trimEnd())
   }
@@ -120,11 +151,20 @@ export function out (key, directory) {
   }
 }
 
+/**
+ *  @param {string} key
+ *  @param {string} directory
+ *  @returns {(value: string) => void}
+ */
 export function err (key, directory) {
   const log = debug(`@modernpoacher/deps:${key}`)
 
   const isDirectory = getIsDirectory(directory)
 
+  /**
+   *  @param {string} v
+   *  @returns {boolean}
+   */
   function filterErr (v) {
     const s = v.trim()
 
@@ -133,6 +173,10 @@ export function err (key, directory) {
     )
   }
 
+  /**
+   *  @param {string} v
+   *  @returns {void}
+   */
   function write (v) {
     if (v.trim()) log(v.trimEnd())
   }
@@ -149,7 +193,7 @@ export function err (key, directory) {
  *
  *  Get an error code from an error
  *
- *  @param {Error}
+ *  @param {{code?: number, message?: string}} e
  *  @returns {number}
  */
 const getErrorCode = ({ code = 0 } = {}) => code
@@ -159,7 +203,7 @@ const getErrorCode = ({ code = 0 } = {}) => code
  *
  *  Get an error message from an error
  *
- *  @param {Error}
+ *  @param {{code?: number, message?: string}} e
  *  @returns {string}
  */
 const getErrorMessage = ({ message = '' } = {}) => message
@@ -169,7 +213,7 @@ const getErrorMessage = ({ message = '' } = {}) => message
  *
  *  Determine whether an error is a safe non-zero exit from a Git command
  *
- *  @param {Error}
+ *  @param {{code?: number, message?: string}} e
  *  @returns {boolean}
  */
 function isCommandError (e) {
@@ -202,14 +246,12 @@ export function catGitRefsRemotesOriginHead (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v = '') => {
-        (!e)
-          ? resolve(trim(v))
-          : reject(e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e) ? resolve(trim(v)) : reject(e)
       })
 
-      stdout.on('data', out('cat-git-refs-remotes-origin-head', directory))
-      stderr.on('data', err('cat-git-refs-remotes-origin-head', directory))
+      if (stdout) stdout.on('data', out('cat-git-refs-remotes-origin-head', directory))
+      if (stderr) stderr.on('data', err('cat-git-refs-remotes-origin-head', directory))
     })
   )
 }
@@ -235,14 +277,12 @@ export function awkGitRemoteShowOriginHead (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v = '') => {
-        (!e)
-          ? resolve(trim(v))
-          : reject(e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e) ? resolve(trim(v)) : reject(e)
       })
 
-      stdout.on('data', out('git-remote-show-origin-head', directory))
-      stderr.on('data', err('git-remote-show-origin-head', directory))
+      if (stdout) stdout.on('data', out('git-remote-show-origin-head', directory))
+      if (stderr) stderr.on('data', err('git-remote-show-origin-head', directory))
     })
   )
 }
@@ -268,14 +308,12 @@ export function gitRevParseShowTopLevel (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v = '') => {
-        (!e)
-          ? resolve(trim(v))
-          : reject(e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e) ? resolve(trim(v)) : reject(e)
       })
 
-      stdout.on('data', out('git-rev-parse-show-toplevel', directory))
-      stderr.on('data', err('git-rev-parse-show-toplevel', directory))
+      if (stdout) stdout.on('data', out('git-rev-parse-show-toplevel', directory))
+      if (stderr) stderr.on('data', err('git-rev-parse-show-toplevel', directory))
     })
   )
 }
@@ -301,14 +339,12 @@ export function gitRevParseAbbrevRefHead (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v = '') => {
-        (!e)
-          ? resolve(trim(v))
-          : reject(e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e) ? resolve(trim(v)) : reject(e)
       })
 
-      stdout.on('data', out('git-rev-parse-abbrev-ref-head', directory))
-      stderr.on('data', err('git-rev-parse-abbrev-ref-head', directory))
+      if (stdout) stdout.on('data', out('git-rev-parse-abbrev-ref-head', directory))
+      if (stderr) stderr.on('data', err('git-rev-parse-abbrev-ref-head', directory))
     })
   )
 }
@@ -335,8 +371,8 @@ export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -345,8 +381,8 @@ export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
 
       const log = use('git-checkout')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }
@@ -372,8 +408,8 @@ export function gitPull (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -382,8 +418,8 @@ export function gitPull (d = DIRECTORY) {
 
       const log = use('git-pull')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }
@@ -409,8 +445,8 @@ export function gitPush (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -419,8 +455,8 @@ export function gitPush (d = DIRECTORY) {
 
       const log = use('git-push')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }
@@ -446,8 +482,8 @@ export function gitPushTags (d = DIRECTORY) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -456,8 +492,8 @@ export function gitPushTags (d = DIRECTORY) {
 
       const log = use('git-push-tags')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }
@@ -484,8 +520,8 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -494,8 +530,8 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
 
       const log = use('git-add')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }
@@ -505,9 +541,9 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
  *
  *  Commit changes to Git with a default value if none is supplied
  *
- *  @param {string} c - A directory configured for Git
+ *  @param {string} d - A directory configured for Git
  *  @param {string} message - A commit message
- *  @param {string} author - The commit author
+ *  @param {string | { name: string; email: string }} author - The commit author
  *  @returns {Promise<string>}
  */
 export function gitCommit (d = DIRECTORY, message = MESSAGE, author = AUTHOR) {
@@ -523,8 +559,8 @@ export function gitCommit (d = DIRECTORY, message = MESSAGE, author = AUTHOR) {
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e, v) => {
-        (!e)
+      } = exec(commands, options, (e = null, v = '') => {
+        return (!e)
           ? resolve(v)
           : isCommandError(e)
             ? resolve(v)
@@ -533,8 +569,8 @@ export function gitCommit (d = DIRECTORY, message = MESSAGE, author = AUTHOR) {
 
       const log = use('git-commit')
 
-      stdout.on('data', log)
-      stderr.on('data', log)
+      if (stdout) stdout.on('data', log)
+      if (stderr) stderr.on('data', log)
     })
   )
 }

package/src/common/index.mjs

@@ -1,40 +1,8 @@
 /**
- *  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 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
+ *  @typedef {DepsTypes.Dependencies} Dependencies
+ *  @typedef {DepsTypes.DependencyDescriptor} DependencyDescriptor
+ *  @typedef {DepsTypes.Package} Package
+ *  @typedef {DepsTypes.Configuration} Configuration
  */
 
 import debug from 'debug'
@@ -62,8 +30,16 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`common\` (${VERSION} - ${PLATFORM}) is awake`)
 
+/**
+ *  @param {string} v
+ *  @returns {string}
+ */
 export const tidy = (v) => v.replace(/\n{2,}}/gm, String.fromCharCode(10)).trim()
 
+/**
+ *  @param {string} v
+ *  @returns {string}
+ */
 export const trim = (v) => v.split(String.fromCharCode(10)).map((v) => v.trimEnd()).join(String.fromCharCode(10)).trim()
 
 /**
@@ -71,7 +47,7 @@ export const trim = (v) => v.split(String.fromCharCode(10)).map((v) => v.trimEnd
  *
  *  Get the `--save-prod` parameter
  *
- *  @param {string} current commands string
+ *  @param {string} commands commands string
  *  @returns {string}
  */
 export const getSaveProdParameter = (commands) => commands.concat(' --save-prod')
@@ -81,7 +57,7 @@ export const getSaveProdParameter = (commands) => commands.concat(' --save-prod'
  *
  *  Get the `--save-dev` parameter
  *
- *  @param {string} current commands string
+ *  @param {string} commands commands string
  *  @returns {string}
  */
 export const getSaveDevParameter = (commands) => commands.concat(' --save-dev')
@@ -192,7 +168,7 @@ export const getCommands = PLATFORM === 'win32'
  *
  *  Get the production dependencies by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
+ *  @param {Package | Configuration} deps
  *  @returns {Dependencies}
  */
 export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
@@ -202,7 +178,7 @@ export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
  *
  *  Get the development dependencies by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
+ *  @param {Package | Configuration} deps
  *  @returns {Dependencies}
  */
 export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependencies
@@ -212,7 +188,7 @@ export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependen
  *
  *  Get the optional dependencies by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
+ *  @param {Package | Configuration} deps
  *  @returns {Dependencies}
  */
 export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => optionalDependencies
@@ -222,7 +198,7 @@ export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => o
  *
  *  Get the bundle dependencies by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
+ *  @param {Package | Configuration} deps
  *  @returns {Dependencies}
  */
 export const getBundleDependencies = ({ bundleDependencies = {} } = {}) => bundleDependencies
@@ -232,17 +208,17 @@ export const getBundleDependencies = ({ bundleDependencies = {} } = {}) => bundl
  *
  *  Get the peer dependencies by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
+ *  @param {Package | Configuration} deps
  *  @returns {Dependencies}
  */
-export const getPeerDependencies = ({ peerDependencies } = {}) => peerDependencies
+export const getPeerDependencies = ({ peerDependencies = {} } = {}) => peerDependencies
 
 /**
  *  @function getIgnore
  *
  *  Get the ignore flag by destructuring the configuration
  *
- *  @param {Configuration}
+ *  @param {Configuration} deps
  *  @returns {boolean}
  */
 export const getIgnore = ({ ignore = false } = {}) => ignore === true
@@ -252,11 +228,12 @@ export const getIgnore = ({ ignore = false } = {}) => ignore === true
  *
  *  Get the author by destructuring the package or configuration
  *
- *  @param {Package|Configuration}
- *  @returns {string|null}
+ *  @param {Package | Configuration} deps
+ *  @returns {string | null}
  */
 export const getAuthor = ({ author = '' } = {}) => {
-  if ((author || false) instanceof Object) {
+  if (typeof author === 'string') return author
+  if (typeof (author || false) === 'object') {
     const {
       name: NAME = '',
       email: EMAIL = ''
@@ -272,7 +249,7 @@ export const getAuthor = ({ author = '' } = {}) => {
     )
   }
 
-  return author || null
+  return null
 }
 
 /**
@@ -280,8 +257,8 @@ export const getAuthor = ({ author = '' } = {}) => {
  *
  *  Get the message by destructuring the configuration
  *
- *  @param {Configuration}
- *  @returns {string|null}
+ *  @param {Configuration} deps
+ *  @returns {string | null}
  */
 export const getMessage = ({ message = '' } = {}) => message || null
 
@@ -439,13 +416,13 @@ export function getDeps (packageDependencies) {
  *
  *  Normalise the commands string
  *
- *  @param {string} value
+ *  @param {string} commands
  *  @returns {string}
  */
 export function normalizeCommands (commands) {
   const s = String.fromCharCode(32)
 
-  while (/\s{2,}|\n+/.test(commands)) {
+  while (/\s{2,} | \n+/.test(commands)) {
     commands = commands.replace(/\s{2,}/gm, s).replace(/\n+/gm, s)
   }
 
@@ -459,7 +436,7 @@ export function normalizeCommands (commands) {
  *
  *  Transform by destructuring the value
  *
- *  @param {DependencyDescriptor}
+ *  @param {DependencyDescriptor | { name?: string, version?: string }} dependencyDescriptor
  *  @returns {string}
  */
 export const transformDependency = ({ name = '@modernpoacher/deps', version = 'latest' } = {}) => `${name}@${version}`
@@ -469,7 +446,7 @@ export const transformDependency = ({ name = '@modernpoacher/deps', version = 'l
  *
  *  Transform the parameter to a string
  *
- *  @param {DependencyDescriptor|DependencyDescriptor[]} value
+ *  @param {DependencyDescriptor | DependencyDescriptor[]} value
  *  @returns {string}
  */
 export function transform (value) {