@modernpoacher/deps 2.0.16 → 2.0.18

package/bin/execute/app.mjs

@@ -77,6 +77,14 @@ function handleCommandError (e) {
   }
 }
 
+/**
+ * @function getIgnoreFromConfiguration
+ *
+ * Interrogates `.depsrc` or `.depsrc.json` for an `ignore` value
+ *
+ * @param {string} directory
+ * @returns {Promise<boolean>}
+ */
 async function getIgnoreFromConfiguration (directory) {
   log('getIgnoreFromConfiguration')
 
@@ -91,6 +99,14 @@ async function getIgnoreFromConfiguration (directory) {
   )
 }
 
+/**
+ * @function getAuthorFromConfiguration
+ *
+ * Interrogates `.depsrc` or `.depsrc.json` for an `author` value
+ *
+ * @param {string} directory
+ * @returns {Promise<string|null>}
+ */
 async function getAuthorFromConfiguration (directory) {
   log('getAuthorFromConfiguration')
 
@@ -105,6 +121,14 @@ async function getAuthorFromConfiguration (directory) {
   )
 }
 
+/**
+ * @function getAuthorFromPackage
+ *
+ * Interrogates `package.json` for an `author` value
+ *
+ * @param {string} directory
+ * @returns {Promise<string|null>}
+ */
 async function getAuthorFromPackage (directory) {
   log('getAuthorFromPackage')
 
@@ -119,6 +143,22 @@ async function getAuthorFromPackage (directory) {
   )
 }
 
+/**
+ * @function toAuthor
+ *
+ * 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
+ *
+ * @param {string|null} author
+ * @param {string} directory
+ * @returns {Promise<string>}
+ */
+async function toAuthor (author, directory) {
+  return author || await getAuthorFromConfiguration(directory) || await getAuthorFromPackage(directory) || AUTHOR
+}
+
 const filterDeps = (v) => !!v // de-falsy
 
 const reduceDeps = (a, v) => a.includes(v) ? a : a.concat(v) // de-dupe
@@ -176,7 +216,7 @@ async function iterate ([directory, ...directories] = [], registry, force, messa
       if (D === await gitRevParse(D)) {
         const ignore = await getIgnoreFromConfiguration(D)
         if (!ignore) {
-          await execute(D, registry, force, message, author || await getAuthorFromConfiguration(D) || await getAuthorFromPackage(D))
+          await execute(D, registry, force, message, toAuthor(author, D))
         }
       }
     } catch (e) {
@@ -219,7 +259,7 @@ async function executeFrom (directory, registry, force, message, author) {
       const ignore = await getIgnoreFromConfiguration(D)
       if (!ignore) {
         return (
-          await execute(D, registry, force, message, author || await getAuthorFromConfiguration(D) || await getAuthorFromPackage(D))
+          await execute(D, registry, force, message, toAuthor(author, D))
         )
       }
     }
@@ -238,7 +278,7 @@ async function executeOnly (directory, registry, force, message, author) {
       const ignore = await getIgnoreFromConfiguration(D)
       if (!ignore) {
         return (
-          await execute(D, registry, force, message, author || await getAuthorFromConfiguration(D) || await getAuthorFromPackage(D))
+          await execute(D, registry, force, message, toAuthor(author, D))
         )
       }
     }
@@ -257,7 +297,7 @@ async function executePath (directory, registry, force, message, author) {
       const ignore = await getIgnoreFromConfiguration(D)
       if (!ignore) {
         return (
-          await execute(D, registry, force, message, author || await getAuthorFromConfiguration(D) || await getAuthorFromPackage(D))
+          await execute(D, registry, force, message, toAuthor(author, D))
         )
       }
     }
@@ -316,7 +356,9 @@ async function app () {
     ...(F ? { from: F } : {}),
     ...(O ? { only: O } : {}),
     ...(registry ? { registry } : {}),
-    ...(force ? { force } : {})
+    ...(force ? { force } : {}),
+    ...(message ? { message } : {}),
+    ...(author ? { author } : {})
   })
 
   if (P || (!F && !O)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.0.16",
+  "version": "2.0.18",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -57,15 +57,15 @@
     "supports-color": "8.1.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.20.7",
-    "@babel/core": "^7.20.12",
-    "@babel/eslint-parser": "^7.19.1",
+    "@babel/cli": "^7.21.0",
+    "@babel/core": "^7.21.3",
+    "@babel/eslint-parser": "^7.21.3",
     "@babel/preset-env": "^7.20.2",
-    "@babel/register": "^7.18.9",
+    "@babel/register": "^7.21.0",
     "chai": "^4.3.7",
-    "core-js": "^3.28.0",
+    "core-js": "^3.29.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.34.0",
+    "eslint": "^8.36.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",

package/src/common/git/index.mjs

@@ -25,6 +25,30 @@ export const MESSAGE = PLATFORM === 'win32'
 
 export const AUTHOR = 'Modern Poacher Limited <modernpoacher@modernpoacher.com>'
 
+const CAT_GIT_REFS_REMOTES_ORIGIN_HEAD = `
+DIR=$(echo "./.git/refs/remotes/origin/HEAD'" | sed -e "s/\\//\\\\\\/g" -e "s/://" | cat 2> /dev/null)
+[[ $DIR =~ "[-0-9a-zA-Z]*$" ]]
+echo "\${BASH_REMATCH[0]}"
+`
+
+const GIT_PULL = `
+eval $(ssh-agent) 1> /dev/null
+git pull
+eval $(ssh-agent -k) 1> /dev/null
+`
+
+const GIT_PUSH = `
+eval $(ssh-agent) 1> /dev/null
+git push
+eval $(ssh-agent -k) 1> /dev/null
+`
+
+const GIT_PUSH_TAGS = `
+eval $(ssh-agent) 1> /dev/null
+git push --tags
+eval $(ssh-agent -k) 1> /dev/null
+`
+
 const OPTIONS = {
   maxBuffer: 1024 * 2000,
   shell: true,
@@ -90,7 +114,7 @@ function err (key, directory) {
  *
  *  @param {Error}
  *
- *  @return {Number}
+ *  @return {number}
  */
 const getErrorCode = ({ code = 0 } = {}) => code
 
@@ -101,27 +125,10 @@ const getErrorCode = ({ code = 0 } = {}) => code
  *
  *  @param {Error}
  *
- *  @return {String}
+ *  @return {string}
  */
 const getErrorMessage = ({ message = '' } = {}) => message
 
-/**
- *  @function getCatGitRefsRemotesOriginHeadCommands
- *
- *  Compatible with MacOS and Windows
- *
- *  @return {String}
- */
-function getCatGitRefsRemotesOriginHeadCommands () { /* eslint-disable no-useless-escape */
-  log('getCatGitRefsRemotesOriginHeadCommands')
-
-  return `
-DIR=$(echo "./.git/refs/remotes/origin/HEAD'" | sed -e "s/\\//\\\\\\/g" -e "s/://" | cat 2> /dev/null)
-[[ $DIR =~ "[-0-9a-zA-Z]*$" ]]
-echo "\${BASH_REMATCH[0]}"
-` /* eslint-enable no-useless-escape */
-}
-
 /**
  *  @function isCommandError
  *
@@ -129,7 +136,7 @@ echo "\${BASH_REMATCH[0]}"
  *
  *  @param {Error}
  *
- *  @return {Boolean}
+ *  @return {boolean}
  */
 function isCommandError (e) {
   log('isCommandError')
@@ -145,16 +152,16 @@ function isCommandError (e) {
  *
  *  Get the default branch from `.git/refs/remotes/origin/HEAD`
  *
- *  @param {String} directory - A directory configured for Git
+ *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function catGitRefsRemotesOriginHead (directory = DIRECTORY) {
   log('catGitRefsRemotesOriginHead')
 
   return (
     new Promise((resolve, reject) => {
-      const commands = getCatGitRefsRemotesOriginHeadCommands()
+      const commands = CAT_GIT_REFS_REMOTES_ORIGIN_HEAD.trim()
 
       const {
         stdout,
@@ -176,9 +183,9 @@ export function catGitRefsRemotesOriginHead (directory = DIRECTORY) {
  *
  *  Determine whether a directory is configured for Git
  *
- *  @param {String} directory - A directory
+ *  @param {string} directory - A directory
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitRevParse (directory = DIRECTORY) {
   log('gitRevParse')
@@ -207,10 +214,10 @@ export function gitRevParse (directory = DIRECTORY) {
  *
  *  Switch to the default value if none is supplied
  *
- *  @param {String} directory - A directory configured for Git
- *  @param {String} branch - The Git branch
+ *  @param {string} directory - A directory configured for Git
+ *  @param {string} branch - The Git branch
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitCheckout (directory = DIRECTORY, branch = BRANCH) {
   log('gitCheckout')
@@ -243,20 +250,16 @@ export function gitCheckout (directory = DIRECTORY, branch = BRANCH) {
  *
  *  Pull changes from the Git remote
  *
- *  @param {String} directory - A directory configured for Git
+ *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPull (directory = DIRECTORY) {
   log('gitPull')
 
   return (
     new Promise((resolve, reject) => {
-      const commands = `
-        eval $(ssh-agent) 1> /dev/null
-        git pull
-        eval $(ssh-agent -k) 1> /dev/null
-      `.trim()
+      const commands = GIT_PULL.trim()
 
       const {
         stdout,
@@ -282,20 +285,16 @@ export function gitPull (directory = DIRECTORY) {
  *
  *  Push changes to the Git remote
  *
- *  @param {String} directory - A directory configured for Git
+ *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPush (directory = DIRECTORY) {
   log('gitPush')
 
   return (
     new Promise((resolve, reject) => {
-      const commands = `
-        eval $(ssh-agent) 1> /dev/null
-        git push
-        eval $(ssh-agent -k) 1> /dev/null
-      `.trim()
+      const commands = GIT_PUSH.trim()
 
       const {
         stdout,
@@ -321,20 +320,16 @@ export function gitPush (directory = DIRECTORY) {
  *
  *  Push tags changes to the Git remote
  *
- *  @param {String} directory - A directory configured for Git
+ *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPushTags (directory = DIRECTORY) {
   log('gitPushTags')
 
   return (
     new Promise((resolve, reject) => {
-      const commands = `
-        eval $(ssh-agent) 1> /dev/null
-        git push --tags
-        eval $(ssh-agent -k) 1> /dev/null
-      `.trim()
+      const commands = GIT_PUSH_TAGS.trim()
 
       const {
         stdout,
@@ -360,10 +355,10 @@ export function gitPushTags (directory = DIRECTORY) {
  *
  *  Add changes to Git with a default value if none is supplied
  *
- *  @param {String} directory - A directory configured for Git
- *  @param {String} add - An add parameter
+ *  @param {string} directory - A directory configured for Git
+ *  @param {string} add - An add parameter
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitAdd (directory = DIRECTORY, add = ADD) {
   log('gitAdd')
@@ -396,10 +391,10 @@ export function gitAdd (directory = DIRECTORY, add = ADD) {
  *
  *  Commit changes to Git with a default value if none is supplied
  *
- *  @param {String} directory - A directory configured for Git
- *  @param {String} message - A commit message
+ *  @param {string} directory - A directory configured for Git
+ *  @param {string} message - A commit message
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitCommit (directory = DIRECTORY, message = MESSAGE, author = AUTHOR) {
   log('gitCommit')