cli-nano 1.2.1 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -69,7 +69,7 @@ const config: Config = {
69
69
  dryRun: {
70
70
  alias: 'd',
71
71
  type: 'boolean',
72
- describe: 'Show what would be done, but do not actually start the server',
72
+ describe: 'Show what would be executed but without starting the server',
73
73
  default: false, // optional default value
74
74
  },
75
75
  display: {
@@ -117,6 +117,7 @@ const config: Config = {
117
117
  helpFlagCasing: 'camel', // show help flag option in which casing (camel/kebab) (defaults to 'kebab')
118
118
  helpDescMinLength: 40, // min description length shown in help (defaults to 50)
119
119
  helpDescMaxLength: 120, // max description length shown in help (defaults to 100), will show ellipsis (...) when greater
120
+ helpUsageSeparator: ':', // defaults to "→"
120
121
  };
121
122
 
122
123
  const args = parseArgs(config);
@@ -196,7 +197,7 @@ See [examples/](examples/) for more usage patterns.
196
197
 
197
198
  ## Used by
198
199
 
199
- `cli-nano` is currently used in these other projects of mine (feel free to edit this list):
200
+ `cli-nano` is currently being used by the following projects, which is actually why I created this CLI tool, that I currently maintain as well (feel free to edit this list):
200
201
 
201
202
  - [native-copyfiles](https://github.com/ghiscoding/native-copyfiles)
202
203
  - [remove-glob](https://github.com/ghiscoding/remove-glob)
@@ -205,7 +206,7 @@ See [examples/](examples/) for more usage patterns.
205
206
 
206
207
  You can see below an example of a CLI help (which is the result of calling `--help` with the [config](#usage) shown above).
207
208
 
208
- Please note:
209
+ Please note that the following means:
209
210
 
210
211
  - `<option>` → required
211
212
  - `[option]` → optional
@@ -223,7 +224,7 @@ Arguments:
223
224
  port port to bind on [number]
224
225
 
225
226
  Options:
226
- -d, --dry-run Show what would be done, but do not actually start the server [boolean]
227
+ -d, --dry-run Show what would be executed but without starting the server [boolean]
227
228
  -e, --exclude pattern or glob to exclude (may be passed multiple times) [array]
228
229
  -V, --verbose print more information to console [boolean]
229
230
  -o, --open open browser when starting server [boolean]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cli-nano",
3
- "version": "1.2.1",
3
+ "version": "1.2.2",
4
4
  "description": "Small command-line tool similar to `yargs` or `parseArgs` from Node.js to create a CLI accepting positional arguments, flags and options.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",