Skip to content

Commit

Permalink
Updated readme and yargs with new wizard options
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan Hotmann committed Jul 20, 2017
1 parent 51c8b1a commit a0de1f8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ The new file name does not need to contain a file extension. If you do not speci

### Options
```-i```, ```--info```: View online help
```-w```, ```--wizard```: Run a wizard to guide you through renaming files
```-u```, ```--undo```: Undo previous rename operation
```-r "RegEx"```: See [RegEx](#regex) section for more information
```-f```, ```--force```: Force overwrite without prompt when output file name already exists
```-s```, ```--sim```: Simulate rename and just print new file names
```-n```, ```--noindex```: Do not append an index when renaming multiple files. Use with caution.
```-v```, ```--verbose```: Print all rename operations completed. Prints the same information as the -s option but goes through with the renames.
```-v```, ```--verbose```: Print all rename operations to be completed and confirm before proceeding
```--notrim```: Do not trim whitespace at beginning or end of ouput file name
```-h```, ```--help```: Show help

Expand Down Expand Up @@ -112,11 +113,15 @@ Whenever you run rename for the first time a file ```~/.rename/replacements.js``
- yargs https://github.com/yargs/yargs
- globby https://github.com/sindresorhus/globby
- fs-extra https://github.com/jprichardson/node-fs-extra
- file-exists https://github.com/scottcorgan/file-exists
- prompt-sync https://github.com/0x00A/prompt-sync
- lodash https://lodash.com/
- node-dateformat https://github.com/felixge/node-dateformat
- named-js-regexp https://github.com/edvinv/named-js-regexp
- num2fraction https://github.com/yisibl/num2fraction
- jpeg-exif https://github.com/zhso/jpeg-exif
- opn https://github.com/sindresorhus/opn
- path-exists https://github.com/sindresorhus/path-exists
- chalk https://github.com/chalk/chalk
- cli-clear https://github.com/stevenvachon/cli-clear
- inquirer https://github.com/SBoudrias/Inquirer.js
- clipboardy https://github.com/sindresorhus/clipboardy
6 changes: 5 additions & 1 deletion bin.js
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ const argv = yargs
alias: 'info',
boolean: true,
describe: 'View online help'
}, 'w': {
alias: 'wizard',
boolean: true,
describe: 'Run a wizard to guide you through renaming files'
}, 'u': {
alias: 'undo',
boolean: true,
Expand All @@ -54,7 +58,7 @@ const argv = yargs
}, 'v': {
alias: 'verbose',
boolean: true,
describe: 'Print all rename operations completed'
describe: 'Print all rename operations to be completed and confirm before proceeding'
}, 'notrim': {
boolean: true,
describe: 'Do not trim whitespace at beginning or end of ouput file name'
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
"opn": "^5.1.0",
"path-exists": "^3.0.0",
"prompt-sync": "^4.1.4",
"rx": "^4.1.0",
"yargs": "^8.0.2"
}
}

0 comments on commit a0de1f8

Please sign in to comment.