v1.0.0

Renamer has been completely rewritten but retains its core behaviour and "feel".

Breaking changes since v0.7.0

• It requires node v8.9.0 or above.
• The programmatic API has been rewritten. Documentation for the new API is here.
• --regex and --insensitive options removed, you now specify a regular expression literal. For example, --find '/something/ig'.
• The number replacing the {{index}} token is now incremented per file-renamed-successfully, rather than per file.

New features

• Added the ability to specify which --path-element should be renamed.
• Plugin system added.
• --force mode added, fixes #17.
• --view long and --view diff added.
• A file list can now be passed into stdin, facilitating use of tools like find to build the input file list. Users now have control over the input file order and therefore {{index}} value. Fixes #31.

Documentation

• Wiki added.
• API docs added.

Upgrade notes

Quite a lot has changed so it's worth reading the new documentation. Nevertheless, the core user-experience remains largely the same: you set a --find, --replace, some files, check the --dry-run then rename.