https://github.com/peterroe/renames
A good helper for batch renaming files.
https://github.com/peterroe/renames
Last synced: 11 months ago
JSON representation
A good helper for batch renaming files.
- Host: GitHub
- URL: https://github.com/peterroe/renames
- Owner: peterroe
- Created: 2022-07-17T15:01:34.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T15:58:16.000Z (almost 4 years ago)
- Last Synced: 2023-03-04T01:14:01.549Z (over 3 years ago)
- Language: TypeScript
- Size: 99.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## renames
A good helper for batch renaming files.
## Install
```sh
$ npm i -g renames
```
## Usage
```shell
$ renames --dir # preview
$ renames --dir --write # write to disk
```
**example 1:**
Suppose you now have the following directory structure:
```shell
├─ components
│ ├─ ListPost.tsx
│ ├─ NavBar.tsx
│ ├─ ToggleTheme.tsx
```
Just run `renames` and it will rename all files in the directory to match the new file name.
```shell
renames "([A-Z])([a-z]*)([A-Z])([a-z]*).tsx" "([a-z])([a-z]*)-([a-z])([a-z]*).tsx" --dir ./components --write
```
```shell
├─ components
│ ├─ list-post.tsx
│ ├─ nav-bar.tsx
│ ├─ toggle-theme.tsx
```
**example 2:**
```shell
├─ tests
│ ├─ sort_test.js
│ ├─ match_test.js
│ ├─ index_test.js
```
```shell
renames "([a-z]*)_([a-z]*).js" "([a-z]*).([a-z]*).ts" --dir ./tests --write
```
```shell
├─ tests
│ ├─ sort.test.ts
│ ├─ match.test.ts
│ ├─ index.test.ts
```
**example 3:**
```shell
├─ src
│ ├─ qBar.js
│ ├─ BFoo.js
│ ├─ zBaz.js
```
```shell
'([qB]+)([A-Z])([a-z]*).js' '()([A-Z])([a-z]*).js' --dir src --write
```
```shell
├─ src
│ ├─ ar.js
│ ├─ Foo.js
│ ├─ zBaz.js
```
## Base patten rule
| patten | description |
| -- | -- |
| `()` | match an expression |
| `[a-z]` | match a lowercase letter |
| `[A-Z]` | match an uppercase letter |
| `*` | match any number of characters |
| `?` | match zero or one character |
| `+` | match one or more characters |
## Notice
In the `` and ``, the number of `()` must be equal.
Such as if you want:
```shell
├─ src
│ ├─ sLog.ts
│ ├─ qWitch.ts
│ ├─ Index.ts
│ ├─ App.ts
```
Transform to:
```shell
├─ src
│ ├─ Log.ts
│ ├─ Witch.ts
│ ├─ Index.ts
│ ├─ App.ts
```
You should run:
```diff
- renames '([a-z]?)([A-Z])([a-z]*).js' '([A-Z])([a-z]*).js --dir ./src --write // ❌
+ renames '([a-z]?)([A-Z])([a-z]*).js' '()([A-Z])([a-z]*).js' --dir ./src --write // ✅
```