@modernpoacher/deps 2.2.19 → 2.2.21

package/bin/common/index.mjs

@@ -5,8 +5,6 @@
  *  @typedef {DepsTypes.Configuration} Configuration
  */
 
-import debug from 'debug'
-
 import stripAnsi from 'strip-ansi'
 
 import {
@@ -32,6 +30,8 @@ import {
   readFile
 } from 'node:fs/promises'
 
+import debug from '#deps/src/common/debug'
+
 import {
   VERSION,
   PLATFORM,

package/bin/deps.mjs

@@ -1,12 +1,10 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   Command
 } from 'commander'
 
-import '#deps/src/common/debug'
+import debug from '#deps/src/common/debug'
 
 import {
   VERSION,
@@ -39,6 +37,9 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`deps\` (${VERSION} - ${PLATFORM}) is awake`)
 
+/**
+ *  @function app
+ */
 async function app () {
   log('Deps')
 

package/bin/node/execute.mjs

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   resolve,
   dirname
@@ -15,7 +13,7 @@ import {
   Command
 } from 'commander'
 
-import '#deps/src/common/debug'
+import debug from '#deps/src/common/debug'
 
 import {
   VERSION,
@@ -107,9 +105,8 @@ async function isHeadDefaultBranch (directory) {
 
 /**
  *  @function getIgnoreFromConfiguration
- *
+ *  @description
  *  Interrogates `.depsrc` or `.depsrc.json` for an `ignore` value
- *
  *  @param {string} directory
  *  @returns {Promise<boolean>}
  */
@@ -129,9 +126,8 @@ async function getIgnoreFromConfiguration (directory) {
 
 /**
  *  @function getAuthorFromConfiguration
- *
+ *  @description
  *  Interrogates `.depsrc` or `.depsrc.json` for an `author` value
- *
  *  @param {string} directory
  *  @returns {Promise<string | null>}
  */
@@ -151,9 +147,8 @@ async function getAuthorFromConfiguration (directory) {
 
 /**
  *  @function getAuthorFromPackage
- *
+ *  @description
  *  Interrogates `package.json` for an `author` value
- *
  *  @param {string} directory
  *  @returns {Promise<string | null>}
  */
@@ -173,9 +168,8 @@ async function getAuthorFromPackage (directory) {
 
 /**
  *  @function getMessageFromConfiguration
- *
+ *  @description
  *  Interrogates `.depsrc` or `.depsrc.json` for a `message` value
- *
  *  @param {string} directory
  *  @returns {Promise<string | null>}
  */
@@ -195,12 +189,11 @@ async function getMessageFromConfiguration (directory) {
 
 /**
  *  @function toAuthor
- *
+ *  @description
  *  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 | { name: string; email: string }} author
  *  @param {string} directory
  *  @returns {Promise<string | { name: string; email: string }>}
@@ -211,12 +204,11 @@ async function toAuthor (author, directory) {
 
 /**
  *  @function toMessage
- *
+ *  @description
  *  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
- *
  *  @param {string | null} message
  *  @param {string} directory
  *  @returns {Promise<string>}
@@ -240,6 +232,7 @@ const reduceDeps = (a, v = '') => a.includes(v) ? a : a.concat(v) // de-dupe
 
 /**
  *  @param {string[]} directories
+ *  @yields {string | undefined}
  */
 function * genDirsList (directories = []) {
   while (directories.length) yield directories.shift()
@@ -281,7 +274,6 @@ async function getDepsList (directories = []) {
   try {
     /**
      *  Recreate `directories` from `alpha`
-     *
      *  @type {Array<string | undefined>}
      */
     const directories = (
@@ -331,6 +323,7 @@ async function mapRevParseShowTopLevel (directory) {
  *  @param {boolean} force
  *  @param {string} message
  *  @param {string | { name: string; email: string }} author
+ *  @returns {Promise<void>}
  */
 async function iterate (directory, registry, force, message, author) {
   log('iterate')
@@ -385,6 +378,7 @@ async function iteratePath (directory, registry, force, message, author) {
  *  @param {boolean} force
  *  @param {string} message
  *  @param {string | { name: string; email: string }} author
+ *  @returns {Promise<void>}
  */
 async function execute (directory = DIRECTORY, registry = REGISTRY, force = false, message = MESSAGE, author = AUTHOR) {
   log('execute')
@@ -415,6 +409,7 @@ async function execute (directory = DIRECTORY, registry = REGISTRY, force = fals
  *  @param {boolean} force
  *  @param {string} message
  *  @param {string | { name: string; email: string }} author
+ *  @returns {Promise<void>}
  */
 async function executeFrom (directory, registry, force, message, author) {
   log('executeFrom')
@@ -446,6 +441,7 @@ async function executeFrom (directory, registry, force, message, author) {
  *  @param {boolean} force
  *  @param {string} message
  *  @param {string | { name: string; email: string }} author
+ *  @returns {Promise<void>}
  */
 async function executeOnly (directory, registry, force, message, author) {
   log('executeOnly')
@@ -477,6 +473,7 @@ async function executeOnly (directory, registry, force, message, author) {
  *  @param {boolean} force
  *  @param {string} message
  *  @param {string | { name: string; email: string }} author
+ *  @returns {Promise<void>}
  */
 async function executePath (directory, registry, force, message, author) {
   log('executePath')
@@ -512,6 +509,9 @@ async function executePath (directory, registry, force, message, author) {
   }
 }
 
+/**
+ *  @function app
+ */
 async function app () {
   log('Deps')
 

package/bin/node/install.mjs

@@ -1,12 +1,10 @@
 #!/usr/bin/env node
 
-import debug from 'debug'
-
 import {
   Command
 } from 'commander'
 
-import '#deps/src/common/debug'
+import debug from '#deps/src/common/debug'
 
 import {
   VERSION,
@@ -37,6 +35,9 @@ const log = debug('@modernpoacher/deps')
 
 log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)
 
+/**
+ *  @function app
+ */
 async function app () {
   log('Deps')
 

package/eslint.config.mjs

@@ -1,9 +1,26 @@
 import globals from 'globals'
+import jsdoc from 'eslint-plugin-jsdoc'
+import merge from '@sequencemedia/eslint-merge'
 import standard from '@sequencemedia/eslint-config-standard/configs/recommended/merge'
 import typescript from '@sequencemedia/eslint-config-typescript/configs/recommended/merge'
 import typescriptParser from '@typescript-eslint/parser'
 
 export default [
+  merge(
+    jsdoc.configs['flat/recommended'],
+    {
+      languageOptions: {
+        globals: {
+          DepsTypes: 'readonly'
+        }
+      },
+      rules: {
+        'jsdoc/require-param-description': 'off',
+        'jsdoc/require-returns-description': 'off' /* ,
+        'jsdoc/tag-lines': 'off' */
+      }
+    }
+  ),
   /**
    *  Standard config
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.2.19",
+  "version": "2.2.21",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -24,9 +24,9 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/modernpoacher/deps.git"
+    "url": "git+https://github.com/modernpoacher/deps.git"
   },
-  "homepage": "https://github.com/modernpoacher/deps",
+  "homepage": "https://github.com/modernpoacher/deps#readme",
   "bugs": {
     "url": "https://github.com/modernpoacher/deps/issues"
   },
@@ -54,25 +54,28 @@
     "deps-wipe": "bin/deps/wipe.sh"
   },
   "dependencies": {
-    "commander": "^13.1.0",
-    "debug": "^4.4.0",
-    "glob": "^11.0.1",
+    "commander": "^14.0.0",
+    "debug": "^4.4.1",
+    "glob": "^11.0.3",
     "strip-ansi": "^7.1.0",
-    "supports-color": "^10.0.0"
+    "supports-color": "^10.2.0"
   },
   "devDependencies": {
-    "@sequencemedia/eslint-config-standard": "^0.2.47",
-    "@sequencemedia/eslint-config-typescript": "^0.1.69",
-    "@types/chai": "^5.2.1",
+    "@sequencemedia/eslint-config-standard": "^0.2.79",
+    "@sequencemedia/eslint-config-typescript": "^0.1.137",
+    "@sequencemedia/eslint-merge": "^0.0.47",
+    "@types/chai": "^5.2.2",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.10",
-    "@typescript-eslint/parser": "^8.28.0",
-    "chai": "^5.2.0",
-    "cross-env": "^7.0.3",
-    "eslint": "^9.23.0",
-    "globals": "^16.0.0",
+    "@types/node": "^24.3.1",
+    "@typescript-eslint/parser": "^8.42.0",
+    "chai": "^6.0.1",
+    "cross-env": "^10.0.0",
+    "eslint": "^9.34.0",
+    "eslint-plugin-jsdoc": "^54.3.1",
+    "globals": "^16.3.0",
     "husky": "^9.1.7",
-    "mocha": "^11.1.0"
+    "mocha": "^11.7.2"
   },
   "imports": {
     "#deps/bin": "./bin/index.mjs",
@@ -84,6 +87,7 @@
     "#deps/src/common/*": "./src/common/*/index.mjs",
     "#deps/src/common/debug": "./src/common/debug.mjs",
     "#deps/src/install": "./src/install/index.mjs",
+    "#deps/test/*": "./test/*.mjs",
     "#where-am-i": "./where-am-i.mjs"
   }
 }

package/src/common/debug.mjs

@@ -7,3 +7,5 @@ const {
 } = process
 
 if (DEBUG) debug.enable(DEBUG)
+
+export default debug

package/src/common/env/index.mjs

@@ -1,7 +1,3 @@
-import debug from 'debug'
-
-import PATH from '#where-am-i'
-
 import {
   join
 } from 'node:path'
@@ -14,6 +10,10 @@ import {
   platform
 } from 'node:os'
 
+import PATH from '#where-am-i'
+
+import debug from '#deps/src/common/debug'
+
 const {
   name: NAME,
   version: VERSION