@modernpoacher/deps 2.0.17 → 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.17",
+  "version": "2.0.18",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -58,14 +58,14 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.0",
-    "@babel/eslint-parser": "^7.19.1",
+    "@babel/core": "^7.21.3",
+    "@babel/eslint-parser": "^7.21.3",
     "@babel/preset-env": "^7.20.2",
     "@babel/register": "^7.21.0",
     "chai": "^4.3.7",
-    "core-js": "^3.29.0",
+    "core-js": "^3.29.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.35.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

@@ -154,7 +154,7 @@ function isCommandError (e) {
  *
  *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function catGitRefsRemotesOriginHead (directory = DIRECTORY) {
   log('catGitRefsRemotesOriginHead')
@@ -185,7 +185,7 @@ export function catGitRefsRemotesOriginHead (directory = DIRECTORY) {
  *
  *  @param {string} directory - A directory
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitRevParse (directory = DIRECTORY) {
   log('gitRevParse')
@@ -217,7 +217,7 @@ export function gitRevParse (directory = DIRECTORY) {
  *  @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')
@@ -252,7 +252,7 @@ export function gitCheckout (directory = DIRECTORY, branch = BRANCH) {
  *
  *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPull (directory = DIRECTORY) {
   log('gitPull')
@@ -287,7 +287,7 @@ export function gitPull (directory = DIRECTORY) {
  *
  *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPush (directory = DIRECTORY) {
   log('gitPush')
@@ -322,7 +322,7 @@ export function gitPush (directory = DIRECTORY) {
  *
  *  @param {string} directory - A directory configured for Git
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function gitPushTags (directory = DIRECTORY) {
   log('gitPushTags')
@@ -358,7 +358,7 @@ export function gitPushTags (directory = DIRECTORY) {
  *  @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')
@@ -394,7 +394,7 @@ export function gitAdd (directory = DIRECTORY, add = ADD) {
  *  @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')

package/src/common/index.mjs

@@ -58,7 +58,7 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`common\` (${VERSION} - ${PLATFORM}) is awake at "${PATH}"`)
 
-const tidy = (v) => v.replace(/\n\n/gm, String.fromCharCode(10)).trim()
+const tidy = (v) => v.replace(/\n{2,}}/gm, String.fromCharCode(10)).trim()
 
 /**
  *  @function getSaveProdParameter
@@ -188,7 +188,6 @@ ${commands}
  *
  *  @return {string}
  */
-
 export const getCommands = PLATFORM === 'win32'
   ? (commands = 'npm i') => tidy(commands)
   : (commands = 'npm i') => tidy(getExportPath(getNvm(commands)))
@@ -366,13 +365,15 @@ export function getDeps (packageDependencies) {
  *
  *  @return {string}
  */
-export function normalizeCommands (value) {
-  while (/\s\s|\n/.test(value)) {
-    value = value.replace(/\s\s/gm, String.fromCharCode(32)).replace(/\n/gm, String.fromCharCode(32))
+export function normalizeCommands (commands) {
+  const s = String.fromCharCode(32)
+
+  while (/\s{2,}|\n+/.test(commands)) {
+    commands = commands.replace(/\s{2,}/gm, s).replace(/\n+/gm, s)
   }
 
   return (
-    value.trim()
+    commands.trim()
   )
 }
 

package/src/index.mjs

@@ -292,7 +292,7 @@ export function getInstallSaveProdCommands (deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveBundleSaveExact (d, deps, r, f) {
   log('installSaveBundleSaveExact')
@@ -332,7 +332,7 @@ export function installSaveBundleSaveExact (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveBundle (d, deps, r, f) {
   log('installSaveBundle')
@@ -372,7 +372,7 @@ export function installSaveBundle (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveOptionalSaveExact (d, deps, r, f) {
   log('installSaveOptionalSaveExact')
@@ -412,7 +412,7 @@ export function installSaveOptionalSaveExact (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveOptional (d, dependencies, r, f) {
   log('installSaveOptional')
@@ -452,7 +452,7 @@ export function installSaveOptional (d, dependencies, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveDevSaveExact (d, deps, r, f) {
   log('installSaveDevSaveExact')
@@ -492,7 +492,7 @@ export function installSaveDevSaveExact (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveDev (d, deps, r, f) {
   log('installSaveDev')
@@ -532,7 +532,7 @@ export function installSaveDev (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveProdSaveExact (d, deps, r, f) {
   log('installSaveProdSaveExact')
@@ -572,7 +572,7 @@ export function installSaveProdSaveExact (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveProd (d, deps, r, f) {
   log('installSaveProd')
@@ -613,7 +613,7 @@ export function installSaveProd (d, deps, r, f) {
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<void>}
  */
 export async function executeBundle (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeBundle')
@@ -638,7 +638,7 @@ export async function executeBundle (d = DIRECTORY, packageDependencies = {}, co
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<void>}
  */
 export async function executeOptional (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeOptional')
@@ -663,7 +663,7 @@ export async function executeOptional (d = DIRECTORY, packageDependencies = {},
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<void>}
  */
 export async function executeDev (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeDev')
@@ -688,7 +688,7 @@ export async function executeDev (d = DIRECTORY, packageDependencies = {}, confi
  *  @param {string} r - Registry
  *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<void>}
  */
 export async function executeProd (d = DIRECTORY, packageDependencies = {}, configurationDependencies = {}, r = REGISTRY, f = false) {
   log('executeProd')

package/src/install/index.mjs

@@ -110,7 +110,7 @@ export function getInstallCommands (p, s, r, f) {
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function installSaveExact (d, p, s, r, f) {
   log('installSaveExact')
@@ -145,7 +145,7 @@ export function installSaveExact (d, p, s, r, f) {
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
  *
- *  @return {Promise}
+ *  @return {Promise<string>}
  */
 export function install (d, p, s, r, f) {
   log('install')
@@ -179,17 +179,18 @@ export function install (d, p, s, r, f) {
  *  @param {Configuration} c - Configuration
  *  @param {boolean} s - Save
  *  @param {string} r - Registry
+ *  @param {boolean} f - Force
  *
- *  @return {Promise}
+ *  @return {Promise<void>}
  */
-export async function execute (directory = DIRECTORY, packages = {}, configuration = {}, save = false, registry = REGISTRY, force = false) {
+export async function execute (d = DIRECTORY, p = {}, c = {}, s = false, r = REGISTRY, f = false) {
   log('execute')
 
-  const depsExact = getDepsExact(packages, configuration)
+  const depsExact = getDepsExact(p, c)
 
-  if (depsExact.length) await installSaveExact(directory, depsExact, save, registry, force)
+  if (depsExact.length) await installSaveExact(d, depsExact, s, r, f)
 
-  const deps = getDeps(packages)
+  const deps = getDeps(p)
 
-  if (deps.length) await install(directory, deps, save, registry, force)
+  if (deps.length) await install(d, deps, s, r, f)
 }