@modernpoacher/deps 2.0.15 → 2.0.17

package/bin/deps.sh

@@ -7,7 +7,7 @@ export PATH=/usr/local/bin:$PATH
 EXP="[-0-9a-zA-Z]*$"
 
 function update {
-  eval $(ssh-agent 1> /dev/null)
+  eval $(ssh-agent) 1> /dev/null
   git checkout $default_branch
   git pull
 
@@ -19,7 +19,7 @@ function update {
   git commit -m "Updated \`package.json\` &/ \`package-lock.json\`"
   git push
   git push --tags
-  eval $(ssh-agent -k 1> /dev/null)
+  eval $(ssh-agent -k) 1> /dev/null
 }
 
 function can_update {

package/bin/push.sh

@@ -37,11 +37,11 @@ function checkout_default_branch {
 }
 
 function update {
-  eval $(ssh-agent 1> /dev/null)
+  eval $(ssh-agent) 1> /dev/null
   git pull
   git push
   git push --tags
-  eval $(ssh-agent -k 1> /dev/null)
+  eval $(ssh-agent -k) 1> /dev/null
 }
 
 function execute {

package/bin/wipe.sh

@@ -37,12 +37,12 @@ function checkout_default_branch {
 }
 
 function update {
-  eval $(ssh-agent 1> /dev/null)
+  eval $(ssh-agent) 1> /dev/null
   git pull
   git branch --merged | egrep -v "(^\*|$default_branch)" | xargs git branch -d
   git remote prune origin
   git gc --aggressive --prune=now
-  eval $(ssh-agent -k 1> /dev/null)
+  eval $(ssh-agent -k) 1> /dev/null
 }
 
 function execute {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.0.15",
+  "version": "2.0.17",
   "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/cli": "^7.21.0",
+    "@babel/core": "^7.21.0",
     "@babel/eslint-parser": "^7.19.1",
     "@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.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.34.0",
+    "eslint": "^8.35.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,7 +152,7 @@ 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}
  */
@@ -154,7 +161,7 @@ export function catGitRefsRemotesOriginHead (directory = DIRECTORY) {
 
   return (
     new Promise((resolve, reject) => {
-      const commands = getCatGitRefsRemotesOriginHeadCommands()
+      const commands = CAT_GIT_REFS_REMOTES_ORIGIN_HEAD.trim()
 
       const {
         stdout,
@@ -176,7 +183,7 @@ 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}
  */
@@ -207,8 +214,8 @@ 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}
  */
@@ -243,7 +250,7 @@ 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}
  */
@@ -252,11 +259,7 @@ export function gitPull (directory = DIRECTORY) {
 
   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,7 +285,7 @@ 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}
  */
@@ -291,11 +294,7 @@ export function gitPush (directory = DIRECTORY) {
 
   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,7 +320,7 @@ 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}
  */
@@ -330,11 +329,7 @@ export function gitPushTags (directory = DIRECTORY) {
 
   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,8 +355,8 @@ 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}
  */
@@ -396,8 +391,8 @@ 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}
  */

package/src/common/index.mjs

@@ -1,3 +1,38 @@
+/**
+ * Package or configuration dependencies
+ * @typedef {Object.<string, string>} Dependencies
+ */
+
+/**
+ * A dependency descriptor
+ * @typedef {Object} DependencyDescriptor
+ * @property {string} name - Dependency name in NPM.
+ * @property {string} version - Dependency version or "latest".
+ */
+
+/**
+ * A package
+ * @typedef {Object} Package
+ * @property {string|{name: string, email: string}} author
+ * @property {Dependencies} dependencies - Production dependencies.
+ * @property {Dependencies} devDependencies - Development dependencies.
+ * @property {Dependencies} optionalDependencies - Optional dependencies.
+ * @property {Dependencies} bundleDependencies - Bundle dependencies.
+ * @property {Dependencies} peerDependencies - Peer dependencies
+ */
+
+/**
+ * A configuration
+ * @typedef {Object} Configuration
+ * @property {string|{name: string, email: string}} author
+ * @property {boolean} ignore
+ * @property {Dependencies} dependencies - Production dependencies.
+ * @property {Dependencies} devDependencies - Development dependencies.
+ * @property {Dependencies} optionalDependencies - Optional dependencies.
+ * @property {Dependencies} bundleDependencies - Bundle dependencies.
+ * @property {Dependencies} peerDependencies - Peer dependencies
+ */
+
 import debug from 'debug'
 
 import PATH from '#where-am-i'
@@ -30,9 +65,9 @@ const tidy = (v) => v.replace(/\n\n/gm, String.fromCharCode(10)).trim()
  *
  *  Get the `--save-prod` parameter
  *
- *  @param {String} current commands string
+ *  @param {string} current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getSaveProdParameter = (commands) => commands.concat(' --save-prod')
 
@@ -41,9 +76,9 @@ export const getSaveProdParameter = (commands) => commands.concat(' --save-prod'
  *
  *  Get the `--save-dev` parameter
  *
- *  @param {String} current commands string
+ *  @param {string} current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getSaveDevParameter = (commands) => commands.concat(' --save-dev')
 
@@ -52,9 +87,9 @@ export const getSaveDevParameter = (commands) => commands.concat(' --save-dev')
  *
  *  Get the "save bundle" parameter
  *
- *  @param {String} current commands string
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getSaveBundleParameter = (commands) => commands.concat(' --save-bundle')
 
@@ -63,9 +98,9 @@ export const getSaveBundleParameter = (commands) => commands.concat(' --save-bun
  *
  *  Get the `--save-optional` parameter
  *
- *  @param {String} current commands string
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getSaveOptionalParameter = (commands) => commands.concat(' --save-optional')
 
@@ -74,10 +109,10 @@ export const getSaveOptionalParameter = (commands) => commands.concat(' --save-o
  *
  *  Get the "registry" parameter and argument
  *
- *  @param {String} registry
- *  @param {String} current commands string
+ *  @param {string} r - Registry
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getRegistryParameter = (r, commands) => r ? commands.concat(` --registry ${r}`) : commands
 
@@ -86,10 +121,10 @@ export const getRegistryParameter = (r, commands) => r ? commands.concat(` --reg
  *
  *  Get the "force" parameter and argument
  *
- *  @param {String} force
- *  @param {String} current commands string
+ *  @param {boolean} f - Force
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getForceParameter = (f, commands) => f ? commands.concat(' --force') : commands
 
@@ -98,10 +133,10 @@ export const getForceParameter = (f, commands) => f ? commands.concat(' --force'
  *
  *  Get the `--no-save` parameter
  *
- *  @param {Boolean} save
- *  @param {String} current commands string
+ *  @param {boolean} s - Save
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getNoSaveParameter = (s, commands) => s ? commands : commands.concat(' --no-save')
 
@@ -110,10 +145,9 @@ export const getNoSaveParameter = (s, commands) => s ? commands : commands.conca
  *
  *  Get the `--save-exact` parameter
  *
- *  @param {Boolean} exact
- *  @param {String} current commands string
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getSaveExactParameter = (commands) => commands.concat(' --save-exact')
 
@@ -122,9 +156,9 @@ export const getSaveExactParameter = (commands) => commands.concat(' --save-exac
  *
  *  Get the export PATH shell script
  *
- *  @param {String} commands
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getExportPath = (commands) => `
 export PATH=/usr/local/bin:$PATH &> /dev/null
@@ -136,9 +170,9 @@ ${commands}
  *
  *  Get the NVM shell script
  *
- *  @param {String} commands
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 export const getNvm = (commands) => `
 . "${NVM}" 2> /dev/null
@@ -150,30 +184,23 @@ ${commands}
  *
  *  Get the installation shell script
  *
- *  @param {String} directory
- *  @param {String} commands
+ *  @param {string} commands - Current commands string
  *
- *  @return {String}
+ *  @return {string}
  */
 
 export const getCommands = PLATFORM === 'win32'
-  ? (directory = DIRECTORY, commands = 'npm i') => tidy(`
-echo Directory is \\"${directory}\\"
-${commands}
-`)
-  : (directory = DIRECTORY, commands = 'npm i') => tidy(`
-echo Directory is \\"${directory}\\"
-${getExportPath(getNvm(commands))}
-`)
+  ? (commands = 'npm i') => tidy(commands)
+  : (commands = 'npm i') => tidy(getExportPath(getNvm(commands)))
 
 /**
  *  @function getProdDependencies
  *
  *  Get the production dependencies by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Object}
+ *  @return {Dependencies}
  */
 export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
 
@@ -182,9 +209,9 @@ export const getProdDependencies = ({ dependencies = {} } = {}) => dependencies
  *
  *  Get the development dependencies by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Object}
+ *  @return {Dependencies}
  */
 export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependencies
 
@@ -193,9 +220,9 @@ export const getDevDependencies = ({ devDependencies = {} } = {}) => devDependen
  *
  *  Get the optional dependencies by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Object}
+ *  @return {Dependencies}
  */
 export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => optionalDependencies
 
@@ -204,20 +231,20 @@ export const getOptionalDependencies = ({ optionalDependencies = {} } = {}) => o
  *
  *  Get the bundle dependencies by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Object}
+ *  @return {Dependencies}
  */
-export const getBundleDependencies = ({ bundleDependencies = [] } = {}) => bundleDependencies
+export const getBundleDependencies = ({ bundleDependencies = {} } = {}) => bundleDependencies
 
 /**
  *  @function getPeerDependencies
  *
  *  Get the peer dependencies by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Object}
+ *  @return {Dependencies}
  */
 export const getPeerDependencies = ({ peerDependencies } = {}) => peerDependencies
 
@@ -226,9 +253,9 @@ export const getPeerDependencies = ({ peerDependencies } = {}) => peerDependenci
  *
  *  Get the ignore flag by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {Boolean}
+ *  @return {boolean}
  */
 export const getIgnore = ({ ignore = false } = {}) => ignore === true
 
@@ -237,20 +264,23 @@ export const getIgnore = ({ ignore = false } = {}) => ignore === true
  *
  *  Get the author by destructuring the package or configuration
  *
- *  @param {Object} package
+ *  @param {Package|Configuration}
  *
- *  @return {String}
+ *  @return {string|null}
  */
-export const getAuthor = ({ author } = {}) => {
+export const getAuthor = ({ author = '' } = {}) => {
   if ((author || false) instanceof Object) {
     const {
-      name = '',
-      email = ''
+      name: NAME = '',
+      email: EMAIL = ''
     } = author
 
+    const name = String(NAME).trim()
+    const email = String(EMAIL).trim()
+
     return (
       name && email
-        ? `${name} <${email}>`.trim()
+        ? `${name} <${email}>`
         : null
     )
   }
@@ -263,9 +293,9 @@ export const getAuthor = ({ author } = {}) => {
  *
  *  Determine whether the dependency is a pre-release with a Regular Expression
  *
- *  @param {String} v
+ *  @param {string} v
  *
- *  @return {Boolean}
+ *  @return {boolean}
  */
 export const isPreRelease = (v) => /-/.test(v)
 
@@ -274,9 +304,9 @@ export const isPreRelease = (v) => /-/.test(v)
  *
  *  Determine whether the dependency is exact with a Regular Expression
  *
- *  @param {String} v
+ *  @param {string} v
  *
- *  @return {Boolean}
+ *  @return {boolean}
  */
 export const isExact = (v) => /^\d/.test(v)
 
@@ -285,19 +315,19 @@ export const isExact = (v) => /^\d/.test(v)
  *
  *  Get an array of dependencies to be installed with the `--save-exact` parameter
  *
- *  @param {Object} values
- *  @param {Object} configuration
+ *  @param {Dependencies} packageDependencies - Package dependencies
+ *  @param {Dependencies} configurationDependencies - Configuration dependencies
  *
- *  @return {Array}
+ *  @return {DependencyDescriptor[]}
  */
-export function getDepsExact (values, configuration) {
+export function getDepsExact (packageDependencies, configurationDependencies) {
   log('getDepsExact')
 
   return (
-    Object.entries(values)
+    Object.entries(packageDependencies)
       .reduce((accumulator, [name, version]) => (
         isExact(version)
-          ? accumulator.concat({ name, version: Reflect.has(configuration, name) ? Reflect.get(configuration, name) : version })
+          ? accumulator.concat({ name, version: Reflect.has(configurationDependencies, name) ? Reflect.get(configurationDependencies, name) : version })
           : accumulator
       ), [])
   )
@@ -308,15 +338,15 @@ export function getDepsExact (values, configuration) {
  *
  *  Get an array of dependencies to be installed
  *
- *  @param {Object} values
+ *  @param {Dependencies} packageDependencies - Package dependencies
  *
- *  @return {Array}
+ *  @return {DependencyDescriptor[]}
  */
-export function getDeps (values) {
+export function getDeps (packageDependencies) {
   log('getDeps')
 
   return (
-    Object.entries(values)
+    Object.entries(packageDependencies)
       .reduce((accumulator, [name, version]) => (
         isExact(version)
           ? accumulator
@@ -332,9 +362,9 @@ export function getDeps (values) {
  *
  *  Normalise the commands string
  *
- *  @param {String} value
+ *  @param {string} value
  *
- *  @return {String}
+ *  @return {string}
  */
 export function normalizeCommands (value) {
   while (/\s\s|\n/.test(value)) {
@@ -351,9 +381,9 @@ export function normalizeCommands (value) {
  *
  *  Transform by destructuring the value
  *
- *  @param {Object}
+ *  @param {DependencyDescriptor}
  *
- *  @return {String}
+ *  @return {string}
  */
 export const transformDependency = ({ name = '@modernpoacher/deps', version = 'latest' } = {}) => `${name}@${version}`
 
@@ -362,9 +392,9 @@ export const transformDependency = ({ name = '@modernpoacher/deps', version = 'l
  *
  *  Transform the parameter to a string
  *
- *  @param {(Array|Object)} value
+ *  @param {DependencyDescriptor|DependencyDescriptor[]} value
  *
- *  @return {String}
+ *  @return {string}
  */
 export function transform (value) {
   log('transform')