UNPKG

1.94 kBMarkdownView Raw
1# node-mv
2
3This is a utility command line tool for renaming or moving a node.js file. It will update all the files
4under the current folder to have correct reference to the moved file. And also it will update all the file paths
5required in the renamed/moved file.
6
7Note: Both js and coffee files are supported.
8 1. Both js and coffee files are supported.
9
10## How to get it?
11
12```bash
13npm install node-mv -g
14```
15
16## How to run it?
17
18### Run it without any options
19```bash
20node-mv sample.js sample-renamed.js
21```
22
23### Exclude dir/files
24
25You can pass a list of regex to `--excludes` to exclude folders or files you don't want the program to search
26
27```bash
28node-mv sample.js sample-renamed.js --excludes=/build/
29```
30
31### Git support
32
33If you source file is under git repo, use `--git` option
34
35
36```bash
37node-mv sample.js sample-renamed.js --git
38```
39
40## License
41The MIT License (MIT)
42
43Copyright (c) 2014 viruschidai@gmail.com
44
45Permission is hereby granted, free of charge, to any person obtaining a copy
46of this software and associated documentation files (the "Software"), to deal
47in the Software without restriction, including without limitation the rights
48to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
49copies of the Software, and to permit persons to whom the Software is
50furnished to do so, subject to the following conditions:
51
52The above copyright notice and this permission notice shall be included in
53all copies or substantial portions of the Software.
54
55THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
56IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
57FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
58AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
59LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
60OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
61THE SOFTWARE.