rename-module/README.md

Rename project module, name and text

# RenameModule project

This script override all text occurrences and its variations by another pattern, in folder.

## Parameters
* Path    (-p  or -path  ) Indicates the folder, this script will work inside.
* OldText (-o  or -old   ) Text to be overridden.
* NewText (-n  or -new   ) Text to override old text.
* Prefix  (-pf or -prefix) Prefix to be overridden with old.
* Suffix  (-sf or -suffix) Suffix to be overridden with old.
* Data    (-d or -data)    Text, to script work inside.
	
## Example replaces
* OldName -> NewName
* old_name -> new_name
* Oldname -> NewName
* OLD_NAME -> NEW_NAME
* ...
	
## Script call

### JS file use

	node index.js -p './path/to/module' -o 'oldName' -n 'newName' -pf '{{' -sf '}}'
	node index.js './path/to/module' 'oldName' 'newName' '{{' '}}'

### NPM global install use

	rename-module -p './path/to/module' -o 'oldName' -n 'newName' -pf '{{' -sf '}}'
	rename-module './path/to/module' 'oldName' 'newName' '{{' '}}'

## Configuration
	
Rename Module Project uses 'cfg.json' as config file.
This file determine a format order to rename files and replace content.
For example html files priorize kebabcase, some projects has name file  in snakecase pattern.
You can create a custom config json file and link it with `RENAME_MODULE_CFG_FILE` env variable.

### Config file
	
In config file can be defined the sequence to replace in folder 'dir' file 'file'
In file is defined the sequence by extension '__<file-extension>'
Default sequences is defined in '__' key
The format options allowed are 'snakeCase', 'kebabCase', 'snakeCase upperCase', 'kebabCase upperCase',
'snakeCase lowerCase', 'kebabCase lowerCase', 'upperCase', 'upperFirst camelCase', 'camelCase',
'upperFirst', 'capitalize','lowerCase', 'value'.
Templates are defined in 'template' section and it can be reuse for many format, thats is linking this name

#### Example:

	{
		"__": {
			"name": [
				"snakeCase",
				"kebabCase",
				"snakeCase upperCase",
				"kebabCase upperCase",
				"snakeCase lowerCase",
				"kebabCase lowerCase",
				"upperCase",
				"upperFirst camelCase",
				"camelCase",
				"upperFirst",
				"capitalize",
				"lowerCase",
				"value"
			]
		},
		"dir": null,
		"file": {
			"__": {
				"body": ["..."],
				"name": ["..."]
			},
			"__html": {
				"body": ["..."],
				"name": ["..."]
			},
			"__txt": "templateName"
		},
		"template":  {
			"templateName":{
					"body": ["..."],
					"name": ["..."]
				}
		}
	}

	
## History

* 1.0.0 - First version
* 2.0.0 - Use of config file for order formats replaces, bug fix
* 3.0.0 - Use of config object to pass all parameters through replace methods, 
				prefix option, suffix option, replace data instead file content option, bug fix, readme fix