@modernpoacher/deps 2.2.19 → 2.2.20

package/src/common/git/index.mjs

@@ -1,4 +1,13 @@
-import debug from 'debug'
+/**
+ *  @typedef {import('node:child_process').ExecException} ExecException
+ */
+
+/**
+ *  @callback HandleComplete
+ *  @param {ExecException | null} e
+ *  @param {string} v
+ *  @returns {void}
+ */
 
 import stripAnsi from 'strip-ansi'
 
@@ -10,6 +19,8 @@ import {
   exec
 } from 'node:child_process'
 
+import debug from '#deps/src/common/debug'
+
 import {
   BIN,
   VERSION,
@@ -60,11 +71,19 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`common/git\` (${VERSION} - ${PLATFORM}) is awake`)
 
+const LF = String.fromCharCode(10)
+
 /**
  *  @param {string} v
  *  @returns {string}
  */
-const trim = (v) => v.split(String.fromCharCode(10)).map((v) => v.trimEnd()).join(String.fromCharCode(10)).trim()
+const trimEnd = (v) => v.trimEnd()
+
+/**
+ *  @param {string} v
+ *  @returns {string}
+ */
+const trim = (v) => v.split(LF).map(trimEnd).join(LF).trim()
 
 /**
  *  @param {string} v
@@ -108,7 +127,7 @@ export function use (key) {
   }
 
   return function use (value) {
-    value.split(String.fromCharCode(10))
+    value.split(LF)
       .filter(filter)
       .forEach(write)
   }
@@ -145,7 +164,7 @@ export function out (key, directory) {
   }
 
   return function out (value) {
-    value.split(String.fromCharCode(10))
+    value.split(LF)
       .filter(filter).filter(filterOut)
       .forEach(write)
   }
@@ -182,7 +201,7 @@ export function err (key, directory) {
   }
 
   return function err (value) {
-    value.split(String.fromCharCode(10))
+    value.split(LF)
       .filter(filter).filter(filterErr)
       .forEach(write)
   }
@@ -190,9 +209,8 @@ export function err (key, directory) {
 
 /**
  *  @function getErrorCode
- *
+ *  @description
  *  Get an error code from an error
- *
  *  @param {{code?: number, message?: string}} e
  *  @returns {number}
  */
@@ -200,9 +218,8 @@ const getErrorCode = ({ code = 0 } = {}) => code
 
 /**
  *  @function getErrorMessage
- *
+ *  @description
  *  Get an error message from an error
- *
  *  @param {{code?: number, message?: string}} e
  *  @returns {string}
  */
@@ -210,9 +227,8 @@ const getErrorMessage = ({ message = '' } = {}) => message
 
 /**
  *  @function isCommandError
- *
+ *  @description
  *  Determine whether an error is a safe non-zero exit from a Git command
- *
  *  @param {{code?: number, message?: string}} e
  *  @returns {boolean}
  */
@@ -227,9 +243,8 @@ function isCommandError (e) {
 
 /**
  *  @function catGitRefsRemotesOriginHead
- *
+ *  @description
  *  Get the default branch from `.git/refs/remotes/origin/HEAD`
- *
  *  @param {string} d - A directory configured for Git
  *  @returns {Promise<string>}
  */
@@ -242,13 +257,21 @@ export function catGitRefsRemotesOriginHead (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = CAT_GIT_REFS_REMOTES_ORIGIN_HEAD.trim()
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(trim(v))
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e) ? resolve(trim(v)) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       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))
@@ -258,9 +281,8 @@ export function catGitRefsRemotesOriginHead (d = DIRECTORY) {
 
 /**
  *  @function awkGitRemoteShowOriginHead
- *
+ *  @description
  *  Get the remote default branch
- *
  *  @param {string} d - A directory configured for Git
  *  @returns {Promise<string>}
  */
@@ -273,13 +295,21 @@ export function awkGitRemoteShowOriginHead (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = 'git remote show origin | awk \'/HEAD branch/ {print $NF}\''
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e = null, v = '') {
+        if (!e) {
+          resolve(trim(v))
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e) ? resolve(trim(v)) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       if (stdout) stdout.on('data', out('git-remote-show-origin-head', directory))
       if (stderr) stderr.on('data', err('git-remote-show-origin-head', directory))
@@ -289,9 +319,8 @@ export function awkGitRemoteShowOriginHead (d = DIRECTORY) {
 
 /**
  *  @function gitRevParseShowTopLevel
- *
+ *  @description
  *  Determine whether a directory is configured for Git
- *
  *  @param {string} d - A directory
  *  @returns {Promise<string>}
  */
@@ -304,13 +333,21 @@ export function gitRevParseShowTopLevel (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = 'git rev-parse --show-toplevel'
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(trim(v))
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e) ? resolve(trim(v)) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       if (stdout) stdout.on('data', out('git-rev-parse-show-toplevel', directory))
       if (stderr) stderr.on('data', err('git-rev-parse-show-toplevel', directory))
@@ -320,9 +357,8 @@ export function gitRevParseShowTopLevel (d = DIRECTORY) {
 
 /**
  *  @function gitRevParseAbbrevRefHead
- *
+ *  @description
  *  Determine which branch is HEAD
- *
  *  @param {string} d - A directory
  *  @returns {Promise<string>}
  */
@@ -335,13 +371,21 @@ export function gitRevParseAbbrevRefHead (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = 'git rev-parse --abbrev-ref HEAD'
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e) {
+          resolve(trim(v))
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e) ? resolve(trim(v)) : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       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))
@@ -351,9 +395,8 @@ export function gitRevParseAbbrevRefHead (d = DIRECTORY) {
 
 /**
  *  @function gitCheckout
- *
+ *  @description
  *  Switch to the default value if none is supplied
- *
  *  @param {string} d - A directory configured for Git
  *  @param {string} branch - The Git branch
  *  @returns {Promise<string>}
@@ -368,16 +411,21 @@ export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
       const commands = `git checkout ${branch}`
       const options = getOptions(directory)
 
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
+
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-checkout')
 
@@ -389,9 +437,8 @@ export function gitCheckout (d = DIRECTORY, branch = BRANCH) {
 
 /**
  *  @function gitPull
- *
+ *  @description
  *  Pull changes from the Git remote
- *
  *  @param {string} d - A directory configured for Git
  *  @returns {Promise<string>}
  */
@@ -404,17 +451,21 @@ export function gitPull (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = GIT_PULL.trim()
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-pull')
 
@@ -426,9 +477,8 @@ export function gitPull (d = DIRECTORY) {
 
 /**
  *  @function gitPush
- *
+ *  @description
  *  Push changes to the Git remote
- *
  *  @param {string} d - A directory configured for Git
  *  @returns {Promise<string>}
  */
@@ -441,17 +491,21 @@ export function gitPush (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = GIT_PUSH.trim()
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-push')
 
@@ -463,9 +517,8 @@ export function gitPush (d = DIRECTORY) {
 
 /**
  *  @function gitPushTags
- *
+ *  @description
  *  Push tags changes to the Git remote
- *
  *  @param {string} d - A directory configured for Git
  *  @returns {Promise<string>}
  */
@@ -478,17 +531,21 @@ export function gitPushTags (d = DIRECTORY) {
     new Promise((resolve, reject) => {
       const commands = GIT_PUSH_TAGS.trim()
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-push-tags')
 
@@ -500,9 +557,8 @@ export function gitPushTags (d = DIRECTORY) {
 
 /**
  *  @function gitAdd
- *
+ *  @description
  *  Add changes to Git with a default value if none is supplied
- *
  *  @param {string} d - A directory configured for Git
  *  @param {string} add - An add parameter
  *  @returns {Promise<string>}
@@ -516,17 +572,21 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
     new Promise((resolve, reject) => {
       const commands = `git add ${add}`
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-add')
 
@@ -538,9 +598,8 @@ export function gitAdd (d = DIRECTORY, add = ADD) {
 
 /**
  *  @function gitCommit
- *
+ *  @description
  *  Commit changes to Git with a default value if none is supplied
- *
  *  @param {string} d - A directory configured for Git
  *  @param {string} message - A commit message
  *  @param {string | { name: string; email: string }} author - The commit author
@@ -555,17 +614,21 @@ export function gitCommit (d = DIRECTORY, message = MESSAGE, author = AUTHOR) {
     new Promise((resolve, reject) => {
       const commands = `git commit -m "${message}" --author "${author}"`
       const options = getOptions(directory)
+      /**
+       *  @type {HandleComplete}
+       */
+      function handleComplete (e, v) {
+        if (!e || isCommandError(e)) {
+          resolve(v)
+        } else {
+          reject(e)
+        }
+      }
 
       const {
         stdout,
         stderr
-      } = exec(commands, options, (e = null, v = '') => {
-        return (!e)
-          ? resolve(v)
-          : isCommandError(e)
-            ? resolve(v)
-            : reject(e)
-      })
+      } = exec(commands, options, handleComplete)
 
       const log = use('git-commit')