@modernpoacher/deps 2.2.38 → 2.2.40

package/bin/common/index.mjs

@@ -49,7 +49,7 @@ import {
 } from '#deps/src/common/env'
 
 import {
-  toHomeDir,
+  formatDirectory,
   use,
   tidy
 } from '#deps/src/common/format'
@@ -241,7 +241,7 @@ async function getDepsRcJson (directory = DIRECTORY) {
 async function hasPackage (directory = DIRECTORY) {
   log('hasPackage')
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   try {
     await access(getPackageJsonPath(directory), constants.R_OK)
@@ -261,7 +261,7 @@ async function hasPackage (directory = DIRECTORY) {
 async function getPackage (directory = DIRECTORY) {
   log('getPackage')
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   try {
     return await getPackageJson(directory)
@@ -278,7 +278,7 @@ async function getPackage (directory = DIRECTORY) {
 async function hasConfiguration (directory = DIRECTORY) {
   log('hasConfiguration')
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   try {
     await access(getDepsRcPath(directory), constants.R_OK)
@@ -321,7 +321,7 @@ async function hasConfiguration (directory = DIRECTORY) {
 async function getConfiguration (directory = DIRECTORY) {
   log('getConfiguration')
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   try {
     return await getDepsRc(directory)

package/bin/node/execute.mjs

@@ -24,7 +24,8 @@ import {
 } from '#deps/src/common/env'
 
 import {
-  toHomeDir
+  formatDirectory,
+  formatAuthor
 } from '#deps/src/common/format'
 
 import {
@@ -126,15 +127,15 @@ async function isHeadDefaultBranch (directory) {
 async function getIgnoreFromConfiguration (directory) {
   log('getIgnoreFromConfiguration')
 
-  const CONFIGURATION = (
-    await hasConfiguration(directory)
-      ? await getConfiguration(directory)
-      : {}
-  )
+  if (await hasConfiguration(directory)) {
+    return (
+      getIgnore(
+        await getConfiguration(directory)
+      )
+    )
+  }
 
-  return (
-    getIgnore(CONFIGURATION)
-  )
+  return false
 }
 
 /**
@@ -147,15 +148,15 @@ async function getIgnoreFromConfiguration (directory) {
 async function getAuthorFromConfiguration (directory) {
   log('getAuthorFromConfiguration')
 
-  const CONFIGURATION = (
-    await hasConfiguration(directory)
-      ? await getConfiguration(directory)
-      : {}
-  )
+  if (await hasConfiguration(directory)) {
+    return (
+      getAuthor(
+        await getConfiguration(directory)
+      )
+    )
+  }
 
-  return (
-    getAuthor(CONFIGURATION)
-  )
+  return null
 }
 
 /**
@@ -168,13 +169,11 @@ async function getAuthorFromConfiguration (directory) {
 async function getAuthorFromGit (directory) {
   log('getAuthorFromGitConfig')
 
-  const GIT = {
-    name: await gitConfigUserName(directory),
-    email: await gitConfigUserEmail(directory)
-  }
-
   return (
-    getAuthor(GIT)
+    formatAuthor(
+      await gitConfigUserName(directory) ?? '',
+      await gitConfigUserEmail(directory) ?? ''
+    )
   )
 }
 
@@ -188,15 +187,15 @@ async function getAuthorFromGit (directory) {
 async function getAuthorFromPackage (directory) {
   log('getAuthorFromPackage')
 
-  const PACKAGE = (
-    await hasPackage(directory)
-      ? await getPackage(directory)
-      : {}
-  )
+  if (await hasPackage(directory)) {
+    return (
+      getAuthor(
+        await getPackage(directory)
+      )
+    )
+  }
 
-  return (
-    getAuthor(PACKAGE)
-  )
+  return null
 }
 
 /**
@@ -209,15 +208,15 @@ async function getAuthorFromPackage (directory) {
 async function getMessageFromConfiguration (directory) {
   log('getMessageFromConfiguration')
 
-  const CONFIGURATION = (
-    await hasConfiguration(directory)
-      ? await getConfiguration(directory)
-      : {}
-  )
+  if (await hasConfiguration(directory)) {
+    return (
+      getMessage(
+        await getConfiguration(directory)
+      )
+    )
+  }
 
-  return (
-    getMessage(CONFIGURATION)
-  )
+  return null
 }
 
 /**
@@ -226,7 +225,7 @@ async function getMessageFromConfiguration (directory) {
  *  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` will not default in function arguments
  *  @param {string | { name: string; email: string }} author
  *  @param {string} directory
  *  @returns {Promise<string | { name: string; email: string }>}
@@ -241,7 +240,7 @@ async function toAuthor (author, directory) {
  *  Ensures that the `message` is set either from the command line,
  *  configuration, or a default
  *
- *  Since it can be null `message` may not default in function arguments
+ *  Since it can be null `message` will not default in function arguments
  *  @param {string | null} message
  *  @param {string} directory
  *  @returns {Promise<string>}
@@ -251,21 +250,21 @@ async function toMessage (message, directory) {
 }
 
 /**
+ *  @type {(v: string | undefined) => v is string}
  *  @param {string | undefined} v
  *  @returns {boolean}
  */
-export function filterDeps (v) { // de-falsy
+function filter (v) { // de-falsy
   return Boolean(v)
 }
 
 /**
- *  @param {string[]} a
- *  @param {string} v
- *  @returns {string[]}
+ * @param {string} alpha
+ * @param {string} omega
+ * @returns {number}
  */
-export function reduceDeps (a, v = '') { // de-dupe
-  if (!a.includes(v)) a.push(v)
-  return a
+function sort (alpha, omega) {
+  return alpha.localeCompare(omega)
 }
 
 /**
@@ -288,21 +287,12 @@ async function getPathList (directory) {
   return (
     array
       .map(dirname)
-      .sort()
+      .sort(sort)
   )
 }
 
 /**
- * @param {string} alpha
- * @param {string} omega
- * @returns {number}
- */
-function sort (alpha, omega) {
-  return alpha.localeCompare(omega)
-}
-
-/**
- *  @param {Array<string | undefined>} [directories]
+ *  @param {(string | undefined)[]} [directories]
  *  @returns {Promise<string[]>}
  */
 async function getDepsList (directories = []) {
@@ -313,16 +303,15 @@ async function getDepsList (directories = []) {
    *  @type {string[]}
    */
   const alpha = (
-    directories
-      .filter(Boolean)
-      .reduce(reduceDeps, [])
+    Array.from(new Set(directories))
+      .filter(filter)
       .sort(sort)
   )
 
   try {
     /**
      *  Recreate `directories` from `alpha`
-     *  @type {Array<string | undefined>}
+     *  @type {(string | undefined)[]}
      */
     const directories = (
       await Promise.all(
@@ -336,9 +325,8 @@ async function getDepsList (directories = []) {
      *  @type {string[]}
      */
     const omega = (
-      directories
-        .filter(Boolean)
-        .reduce(reduceDeps, [])
+      Array.from(new Set(directories))
+        .filter(filter)
         .sort(sort)
     )
 
@@ -436,7 +424,7 @@ async function execute (directory = DIRECTORY, registry = REGISTRY, force = fals
   log('execute')
 
   try {
-    info(`Directory is "${toHomeDir(directory)}"`)
+    info(`Directory is "${formatDirectory(directory)}"`)
     info(`Registry is "${registry}"`)
     info(`Force is "${force}"`)
     info(`Message is "${message}"`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.2.38",
+  "version": "2.2.40",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -54,7 +54,7 @@
     "deps-wipe": "bin/deps/wipe.sh"
   },
   "dependencies": {
-    "@sequencemedia/write": "^0.2.14",
+    "@sequencemedia/write": "^0.2.16",
     "commander": "^14.0.1",
     "debug": "^4.4.3",
     "glob": "^11.0.3",
@@ -62,8 +62,8 @@
     "supports-color": "^10.2.2"
   },
   "devDependencies": {
-    "@sequencemedia/eslint-config-standard": "^0.2.88",
-    "@sequencemedia/eslint-config-typescript": "^0.1.150",
+    "@sequencemedia/eslint-config-standard": "^0.2.89",
+    "@sequencemedia/eslint-config-typescript": "^0.1.152",
     "@sequencemedia/eslint-merge": "^0.0.54",
     "@types/chai": "^5.2.2",
     "@types/debug": "^4.1.12",
@@ -73,7 +73,7 @@
     "chai": "^6.2.0",
     "cross-env": "^10.1.0",
     "eslint": "^9.37.0",
-    "eslint-plugin-jsdoc": "^60.7.1",
+    "eslint-plugin-jsdoc": "^60.8.0",
     "globals": "^16.4.0",
     "husky": "^9.1.7",
     "mocha": "^11.7.4"

package/src/common/env/index.mjs

@@ -21,7 +21,6 @@ const {
 } = JSON.parse(readFileSync(join(PATH, 'package.json')).toString('utf8'))
 
 const PLATFORM = platform()
-
 const HOMEDIR = homedir()
 
 const {

package/src/common/format/index.mjs

@@ -14,10 +14,25 @@ const log = debug('@modernpoacher/deps')
 log(`\`common/format\` (${NAME} - ${VERSION} - ${PLATFORM}) is awake`)
 
 /**
- *  @function toHomeDir
+ *  @function formatAuthor
+ *  @type {(name: string, email: string) => string | null}
+ */
+export function formatAuthor (name, email) {
+  const n = name.trim()
+  const e = email.trim()
+
+  return (
+    n && e
+      ? `${n} <${e}>`
+      : null
+  )
+}
+
+/**
+ *  @function formatDirectory
  *  @type {(directory: string) => string}
  */
-export const toHomeDir = PLATFORM === 'win32'
+export const formatDirectory = PLATFORM === 'win32'
   ? (directory) => directory
   : (directory) => directory.includes(HOMEDIR) ? directory.replace(HOMEDIR, '~') : directory
 

package/src/common/index.mjs

@@ -20,6 +20,7 @@ import {
 } from '#deps/src/common/env'
 
 import {
+  formatAuthor,
   tidy
 } from '#deps/src/common/format'
 
@@ -243,24 +244,39 @@ export function getIgnore ({ ignore = false }) {
 export function getAuthor ({ author = '' }) {
   if (typeof author === 'string') return author
   if (typeof (author || false) === 'object') {
-    const {
-      name: NAME = '',
-      email: EMAIL = ''
-    } = author
-
-    const name = String(NAME).trim()
-    const email = String(EMAIL).trim()
-
     return (
-      name && email
-        ? `${name} <${email}>`
-        : null
+      formatAuthor(
+        String(getName(author) ?? ''),
+        String(getEmail(author) ?? '')
+      )
     )
   }
 
   return null
 }
 
+/**
+ *  @function getName
+ *  @description
+ *  Get the name by destructuring the configuration `author`
+ *  @param {Configuration} author
+ *  @returns {string}
+ */
+export function getName ({ name = '' }) {
+  return name
+}
+
+/**
+ *  @function getEmail
+ *  @description
+ *  Get the email by destructuring the configuration `author`
+ *  @param {Configuration} author
+ *  @returns {string}
+ */
+export function getEmail ({ email = '' }) {
+  return email
+}
+
 /**
  *  @function getMessage
  *  @description

package/src/index.mjs

@@ -36,7 +36,7 @@ import {
 } from '#deps/src/common/env'
 
 import {
-  toHomeDir,
+  formatDirectory,
   use
 } from '#deps/src/common/format'
 
@@ -251,7 +251,7 @@ export function installSaveBundleSaveExact (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -298,7 +298,7 @@ export function installSaveBundle (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -345,7 +345,7 @@ export function installSaveOptionalSaveExact (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -392,7 +392,7 @@ export function installSaveOptional (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -439,7 +439,7 @@ export function installSaveDevSaveExact (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -486,7 +486,7 @@ export function installSaveDev (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -533,7 +533,7 @@ export function installSaveProdSaveExact (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -580,7 +580,7 @@ export function installSaveProd (d, deps, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {

package/src/install/index.mjs

@@ -29,7 +29,7 @@ import {
 } from '#deps/src/common/env'
 
 import {
-  toHomeDir
+  formatDirectory
 } from '#deps/src/common/format'
 
 import {
@@ -107,7 +107,7 @@ export function installSaveExact (d, p, s, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {
@@ -153,7 +153,7 @@ export function install (d, p, s, r, f) {
 
   const directory = normalize(d.trim())
 
-  info(`Directory is "${toHomeDir(directory)}"`)
+  info(`Directory is "${formatDirectory(directory)}"`)
 
   return (
     new Promise((resolve, reject) => {