@modernpoacher/deps 2.0.3 → 2.0.4

package/README.md

@@ -32,7 +32,8 @@ When installed locally, or not installed, use `npx`:
 ```sh
 npx @modernpoacher/deps
 ```
-Or when installed locally, use `npm` with script targets in `package.json`:
+
+Alternatively, use `npm` with a script target in your project's `package.json`:
 
 ```json
 {
@@ -41,10 +42,13 @@ Or when installed locally, use `npm` with script targets in `package.json`:
   }
 }
 ```
+
 Then:
+
 ```sh
 npm run deps
 ```
+
 ### Updating only production dependencies
 
 To update only _production_ dependencies (on the `dependencies` field):
@@ -102,6 +106,26 @@ It should contain *JSON* and be structured as `package.json`:
 }
 ```
 
+### Author
+
+Add an `author` field to `.depsrc`:
+
+```json
+{
+  "author": "Jonathan Perry <jonathanperry@modernpoacher.com>"
+}
+```
+
+### Ignore
+
+Instruct *Deps* not to execute with an `ignore` field in `.depsrc`:
+
+```json
+{
+  "ignore": true
+}
+```
+
 Without a `.depsrc` configuration file, whenever *Deps* encounters an _exact_ version, it will assume that _an exact version should not be updated_.
 
 The `.depsrc` configuration file enables this behaviour to be changed.
@@ -128,4 +152,82 @@ Again, with the `.depsrc` configuration file as the example above:
 
 - If `package.json` defines `gulp` at version `4.0.2` then *Deps* will update to the latest version
 
-There is no other behaviour! *Deps* will update to the latest version.
+## *Deps* with the shell
+
+```bash
+deps \
+  --save-prod \ # Boolean
+  --save-dev \ # Boolean
+  --save-optional \ # Boolean
+  --save-bundle \ # Boolean
+  --registry '<REGISTRY>' \
+  --force # Boolean
+
+deps-execute \
+  --path '<PATH>' \
+  --from '<FROM>' \
+  --only '<ONLY>' \
+  --registry '<REGISTRY>' \
+  --force \ # Boolean
+  --message '<MESSAGE>' \
+  --author '<AUTHOR>'
+
+deps-install \
+  --prod \ # Boolean
+  --dev \ # Boolean
+  --optional \ # Boolean
+  --bundle \ # Boolean
+  --peer \ # Boolean
+  --save \ # Boolean
+  '--registry '<REGISTRY>' \
+  --force # Boolean
+
+deps-deps \
+  --path=. \
+  --from=. \
+  --only=.
+
+deps-wipe --path=.
+deps-push --path=.
+deps-head --path=.
+```
+
+## *Deps* with its own script targets
+
+```bash
+npm run deps -- \
+  --save-prod \ # Boolean
+  --save-dev \ # Boolean
+  --save-optional \ # Boolean
+  --save-bundle \ # Boolean
+  --registry '<REGISTRY>' \
+  --force # Boolean
+
+npm run deps-execute -- \
+  --path '<PATH>' \
+  --from '<FROM>' \
+  --only '<ONLY>' \
+  --registry '<REGISTRY>' \
+  --force \ # Boolean
+  --message '<MESSAGE>' \
+  --author '<AUTHOR>'
+
+npm run deps-install -- \
+  --prod \ # Boolean
+  --dev \ # Boolean
+  --optional \ # Boolean
+  --bundle \ # Boolean
+  --peer \ # Boolean
+  --save \ # Boolean
+  '--registry '<REGISTRY>' \
+  --force # Boolean
+
+npm run deps-deps -- \
+  --path=. \
+  --from=. \
+  --only=.
+
+npm run deps-wipe -- --path=.
+npm run deps-push -- --path=.
+npm run deps-head -- --path=.
+```

package/bin/execute/app.mjs

@@ -281,7 +281,7 @@ async function app () {
     .option('-o, --only [only]', 'Update only directory')
     .option('--registry [registry]', 'Installation registry')
     .option('--force [force]', 'Force installation`', false)
-    .option('-m, --message [author]', 'Git commit message')
+    .option('-m, --message [message]', 'Git commit message')
     .option('-a, --author [author]', 'Git commit author')
     .parse(argv)
 

package/bin/install/app.mjs

@@ -62,7 +62,7 @@ async function app () {
     .option('-O, --optional [optionalDependencies]', 'Install `optionalDependencies`', false)
     .option('-B, --bundle [bundleDependencies]', 'Install `bundleDependencies`', false)
     .option('-p, --peer [peerDependencies]', 'Install `peerDependencies`', false)
-    .option('-s, --save [save]', 'Install `peerDependencies`', false)
+    .option('-s, --save [save]', 'Save installed dependencies', false)
     .option('--registry [registry]', 'Installation registry')
     .option('--force [force]', 'Force installation`', false)
     .parse(argv)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -32,7 +32,14 @@
     "lint": "eslint . --ext .cjs --ext .mjs",
     "lint:fix": "npm run lint -- --fix",
     "test": "cross-env DEBUG_COLORS=yes NODE_ENV=test mocha test --recursive -r @babel/register --verbose --color",
-    "pre-commit": "npm run lint && npm run test"
+    "pre-commit": "npm run lint && npm run test",
+    "deps": "cross-env DEBUG_COLORS=yes NODE_ENV=production node bin/app.mjs",
+    "deps-execute": "cross-env DEBUG_COLORS=yes NODE_ENV=production node bin/execute/app.mjs",
+    "deps-install": "cross-env DEBUG_COLORS=yes NODE_ENV=production node bin/install/app.mjs",
+    "deps-deps": "cross-env DEBUG_COLORS=yes NODE_ENV=production bash bin/deps.sh",
+    "deps-wipe": "cross-env DEBUG_COLORS=yes NODE_ENV=production bash bin/wipe.sh",
+    "deps-push": "cross-env DEBUG_COLORS=yes NODE_ENV=production bash bin/push.sh",
+    "deps-head": "cross-env DEBUG_COLORS=yes NODE_ENV=production bash bin/head.sh"
   },
   "bin": {
     "deps": "bin/app.mjs",

package/src/common/git/index.mjs

@@ -9,6 +9,7 @@ import {
 } from 'child_process'
 
 import {
+  VERSION,
   PLATFORM
 } from '#deps/src/common/env'
 
@@ -38,7 +39,7 @@ const OPTIONS = {
 
 const log = debug('@modernpoacher/deps')
 
-log(`\`git\` (${PLATFORM}) is awake`)
+log(`\`git\` (${VERSION} - ${PLATFORM}) is awake`)
 
 const trim = (v) => v.split('\n').map((v) => v.trimEnd()).join('\n').trim()
 

package/src/common/index.mjs

@@ -7,6 +7,7 @@ import {
 } from 'path'
 
 import {
+  VERSION,
   PLATFORM
 } from '#deps/src/common/env'
 
@@ -20,7 +21,7 @@ export const NVM = resolve(PATH, 'nvm.sh')
 
 const log = debug('@modernpoacher/deps')
 
-log(`\`common\` (${PLATFORM}) is awake`)
+log(`\`common\` (${VERSION} - ${PLATFORM}) is awake`)
 
 const tidy = (v) => v.replace(/\n\n/gm, String.fromCharCode(10)).trim()
 

package/src/index.mjs

@@ -9,6 +9,7 @@ import {
 } from 'child_process'
 
 import {
+  VERSION,
   PLATFORM
 } from '#deps/src/common/env'
 
@@ -31,7 +32,7 @@ import {
 
 const log = debug('@modernpoacher/deps')
 
-log(`\`deps\` (${PLATFORM}) is awake`)
+log(`\`deps\` (${VERSION} - ${PLATFORM}) is awake`)
 
 const OPTIONS = {
   maxBuffer: 1024 * 2000,

package/src/install/index.mjs

@@ -4,15 +4,12 @@ import {
   normalize
 } from 'path'
 
-import {
-  platform
-} from 'os'
-
 import {
   exec
 } from 'child_process'
 
 import {
+  VERSION,
   PLATFORM
 } from '#deps/src/common/env'
 
@@ -32,7 +29,7 @@ import {
 
 const log = debug('@modernpoacher/deps:install')
 
-log(`\`install\` (${platform}) is awake`)
+log(`\`install\` (${VERSION} - ${PLATFORM}) is awake`)
 
 const OPTIONS = {
   maxBuffer: 1024 * 2000,

package/where-am-i.mjs

@@ -8,7 +8,7 @@ import {
   fileURLToPath
 } from 'node:url'
 
-const log = debug('@modernpoacher/deps')
+const log = debug('@modernpoacher/deps:where-am-i')
 
 const PATH = dirname(fileURLToPath(import.meta.url))