Chararos
Description
Usefull CLI commands for handle standard projects issues, like remove unecessary files or duplicate/rename files and folders
With Chararos you can:
- Destroy all folders that fill space.
- Select a target directory and remove all projects temporary files, like node_modules, bin or obj directory. Or choose your own directory to delete
- Rename all occurence of string, in directory or file name, from provided path
- Select a target directory, a name and his replace.
Install
$ npm i -g chararosUsage
$ chararos clean <directory> <opts>$ chararos rename <directory> <opts>---or---$ npx chararos <directory> <opts>$ npm install -g chararos$ chararos COMMANDrunning command...$ chararos (-v|--version|version)chararos/1.0.7 win32-x64 node-v10.16.0$ chararos --help [COMMAND]USAGE $ chararos COMMAND...Generic commands
Options
| Command | Description | Sample | Default |
|---|---|---|---|
-h / --help |
Get help | chararos -h |
|
--version |
Get CLI version | chararos -v/version |
Clean Command
Clean Arguments
- DIRECTORY set target directory. [REQUIRED]
Sample command chararos clean 'C:\Users\<usr_name>\Desktop\Projects' or chararos clean .
Clean Options
| Command | Description | Sample | Default |
|---|---|---|---|
-h / --help |
Get help | chararos clean -h |
|
--version |
Get CLI version | chararos clean --version |
|
-d / --dryrun |
Dry run process for getting forecast about folders to be removed | chararos clean <dir> -d |
false |
-n / --node |
Setup for remove node_modules |
chararos clean <dir> -n |
false |
-v / --vs |
Setup for remove bin and obj |
chararos clean <dir> -v |
false |
-f / --folder |
Looking for a specific folder to remove | chararos clean <dir> -f=<folder> |
Arguments 'rename'
- DIRECTORY set target directory. [REQUIRED]
- FROMNAME set name to replace. [REQUIRED]
- TONAME set new name. [REQUIRED]
Sample command chararos rename 'C:\Users\<usr_name>\Desktop\Projects' 'x' 'y' or chararos rename . 'x' 'y'
Options
| Command | Description | Sample | Default |
|---|---|---|---|
-h / --help |
Get help | chararos rename -h |
|
-v / --version |
Get CLI version | chararos rename --v |
|
-d / --dryrun |
Dry run process for getting forecast about folders to be removed | chararos rename <dir> -d |
false |
-s / --strict |
Looking for strict match | chararos rename <dir> <from> <to> -s |
false |
chararos clean DIRECTORY
clean folder from unnecessary files
USAGE
$ chararos clean DIRECTORY
ARGUMENTS
DIRECTORY directory
OPTIONS
-d, --dryrun make a dry run
-f, --folder=folder custom target folder to delete
-h, --help show CLI help
-n, --node cleanup node projects
-v, --vs cleanup vs projects
--version show CLI version
EXAMPLE
$ chararos clean '%YOUR-PATH%' -v
removing visual studio files
See code: src\commands\clean.ts
chararos help [COMMAND]
display help for chararos
USAGE
$ chararos help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
chararos rename DIRECTORY FROMNAME TONAME
rename folders name
USAGE
$ chararos rename DIRECTORY FROMNAME TONAME
ARGUMENTS
DIRECTORY directory
FROMNAME from name
TONAME to name
OPTIONS
-d, --dryrun make a dry run
-h, --help show CLI help
-s, --strict strict search
--version show CLI version
EXAMPLE
$ chararos rename '%YOUR-PATH%' "x" "y"
rename folders from 'x' to 'y'
See code: src\commands\rename.ts
Contributing
Feel free to add new feature and enhancement