From c09357a5f32023c89e9450ea56e54b360223a3dc Mon Sep 17 00:00:00 2001 From: AdrieanKhisbe Date: Thu, 17 Oct 2024 15:33:33 +0200 Subject: [PATCH] Update documentation and README :open_book: --- README.md | 6 ++++++ src/index.js | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 01a9ec8b..3560fe54 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,12 @@ Options: -d, --default-config, --default Override update-node configuration default path [boolean] -c, --clean Run on a clean state [boolean] + -i, --run-npm-install Run npm install after patching + package.json (default, disable with + --no-run-npm-install) + [boolean] [default: true] + -b, --pre-commit-bump-command Command to run before to commit (changes + will be commited) [array] -p, --pre-clean-command Run before to clean state [array] -P, --post-clean-command Run on a clean state [array] -f, --force Git Push with force changes diff --git a/src/index.js b/src/index.js index c66472f4..c46ce40b 100644 --- a/src/index.js +++ b/src/index.js @@ -130,7 +130,8 @@ const yargs = require('yargs') alias: 'c' }) .option('run-npm-install', { - describe: 'Command to run before to commit (disable with --no-run-npm-install)', + describe: + 'Run npm install after patching package.json (default, disable with --no-run-npm-install)', boolean: true, alias: 'i', default: true