https://github.com/papb/batch-rename-by-function
Batch rename files and folders by providing a JS function
https://github.com/papb/batch-rename-by-function
batch cli javascript rename
Last synced: 2 months ago
JSON representation
Batch rename files and folders by providing a JS function
- Host: GitHub
- URL: https://github.com/papb/batch-rename-by-function
- Owner: papb
- License: mit
- Created: 2017-11-19T22:08:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-10T16:49:51.000Z (over 6 years ago)
- Last Synced: 2025-01-09T15:55:58.541Z (9 months ago)
- Topics: batch, cli, javascript, rename
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
batch-rename-by-function
========================
[](https://nodei.co/npm/batch-rename-by-function/)
[![NPM version][npm-version-badge]][npm-url]
[![License][license-badge]][license-url]
[![NPM downloads][npm-downloads-badge]][npm-url]
[![Dependency Status][dependency-status-badge]](https://david-dm.org/papb/batch-rename-by-function)
[![Dev Dependency Status][dev-dependency-status-badge]](https://david-dm.org/papb/batch-rename-by-function)
[![Open Issues][open-issues-badge]](https://github.com/papb/batch-rename-by-function/issues)
[![Closed Issues][closed-issues-badge]](https://github.com/papb/batch-rename-by-function/issues?q=is%3Aissue+is%3Aclosed)
[![contributions welcome][contrib-welcome-badge]](https://github.com/papb/batch-rename-by-function/issues)
Batch rename files and folders by providing a JS function.
# How to use
```
npm install -g batch-rename-by-function
```
Navigate to the folder you want, and create a JS file there, `my-renamer.js`, like this:
```javascript
module.exports = filename => filename.replace("Season 1 - ", "Season 01 - ");
```
And then execute
```
batch-rename-by-function my-renamer.js
```
to see all the changes that would be made (without actually renaming anything, hence `dry-run`), and if that's really what you want, execute
```
batch-rename-by-function my-renamer.js --no-dry-run
```
to perform the actual renaming. Note that `batch-rename-by-function` acts on every file/folder in the current working directory, and runs in `dry-run` mode (i.e. simulation mode) by default. To actually rename files, the `--no-dry-run` options must be set (or its alias `--force` or even `-F`).
The file `my-renamer.js` doesn't have to be in the same folder as the renames (just give the relative path for it). Also, `batch-rename-by-function` will automatically skip your JS file (in this example, `my-renamer.js`) if it is present in the current directory (instead of trying to rename it as well).
To rename recursively, i.e., rename nested files/folders as well, just use the `--recursive` option (or its alias, `--nested`). This way nested files/folders will be navigated too.
The renaming function also receives a second parameter, `data`, which is an object that can be useful:
```javascript
module.exports = (filename, data) => {
// Skip folders
if (data.isDirectory) return filename;
// Use data.parentFolder to get the relative path to the parent folder
// Use data.depth to know how deep you are in the recursive calls
// (recall to use the --recursive option to rename recursively)
// ...
};
```
The commands `batch-rename-by-function --help` and `batch-rename-by-function --version` are also available:
```
Usage: batch-rename-by-function path/to/my/renamer/file.js
Applies the function exported by the given JS file on every file present in
the current folder, except the given JS file (if present), including folders.
The renaming function receives two parameters. The first is the name of the
object (file/directory), and the second is a data object with three fields:
isDirectory (boolean), depth (int) and parentFolder (string).
Options:
--help Show help [boolean]
--version Show version number [boolean]
--recursive, --nested Whether to rename nested files
[boolean] [default: false]
--no-dry-run, --force, -F Perform the actual renaming (if omitted, a dry-run
will occur instead, i.e., just a simulation of the
renamings). [boolean] [default: false]
Examples:
batch-rename-by-function myRenamer.js
```
# Why `batch-rename-by-function`?
A comparison with [`renamer`](https://github.com/75lb/renamer), a more known module for batch renaming:
* `batch-rename-by-function` allows you to write arbitrarily complicated javascript to calculate the new names for your files in a very straightforward way, while to do this with `renamer` you would have to develop a custom plugin.
* You don't have to know JavaScript to use `renamer`, but you must know it to use `batch-rename-by-function`.
# Acknowledgements
Thanks Rubens Mariuzzo for [this great guide on creating CLI utilities in NodeJS](https://x-team.com/blog/a-guide-to-creating-a-nodejs-command/).
# Contributing
Any contribution is very welcome. Feel free to open an issue about anything: questions, suggestions, feature requests, bugs, improvements, mistakes, whatever. I will be always looking.
# Changelog
The changelog is available in [CHANGELOG.md](CHANGELOG.md).
# License
MIT (c) Pedro Augusto de Paula Barbosa
[npm-url]: https://npmjs.org/package/batch-rename-by-function
[npm-version-badge]: https://badgen.net/npm/v/batch-rename-by-function
[dependency-status-badge]: https://badgen.net/david/dep/papb/batch-rename-by-function
[dev-dependency-status-badge]: https://badgen.net/david/dev/papb/batch-rename-by-function
[npm-downloads-badge]: https://badgen.net/npm/dt/batch-rename-by-function
[open-issues-badge]: https://badgen.net/github/open-issues/papb/batch-rename-by-function
[closed-issues-badge]: https://badgen.net/github/closed-issues/papb/batch-rename-by-function
[contrib-welcome-badge]: https://badgen.net/badge/contributions/welcome/green
[license-badge]: https://badgen.net/npm/license/batch-rename-by-function
[license-url]: LICENSE