0.1.5 • Published 6 years ago
jshelf v0.1.5
JShelf
JShelf is a react project auto format tool, you can use it to format your react project structure easily.
features:
- configurable
- format directory and file names
- auto modify the module import and export
- parse module require to import
Installation
you can install jshelf by the npm recommend:
$ npm install jshelf --save-devUsage
- create a config file
jshelf.jsonfor your project, for example:
{
"root": "./src",
"ignore": ["./src/app/", "./src/lib/", "./src/util/"],
"rules": {
"directory": {
"case": "kebab"
},
"files": [
{
"test": "\\.js$|\\.jsx$",
"case": "camel",
"ignore": [
"index",
"logic",
"store",
"actions",
"util"
]
},
{
"test": "\\.less$",
"case": "mix",
"ignore": []
}
],
"default": {
"case": "mix",
"ignore": []
}
},
"words": [
"these",
"are",
"words",
"used",
"in",
"your",
"file",
"names",
]
}- run the command in your project's root directory
$ jshelfConfig options
| field name | type | required | comment |
|---|---|---|---|
| root | string | true | the root directory to be formated |
| ignore | array | false | the directorys you don't want to be formated but included in the root |
| rules | object | true | the rules according to which to format |
| rules.directory | object | false | directory rules\<rule item> |
| rules.files | array | false | files rules\<rule item> |
| rules.default | object | true | default rules\<rule item> |
| words | array | true | the words appeard in your file or directory name |
Rule item configs:
| field name | type | required | comment |
|---|---|---|---|
| case | string | true | format case selectable: camel, kebab, mix, snack |
| test | string | true | only file rules has this option, regular expression string to match the file |
| ignore | array | false | the file's name you don't want to format |
Cases
now you can format your file or directory name use one of the following cases:
| case | example | words | formated |
|---|---|---|---|
| kebab | 'kebabcase' | 'kebab', 'case' | kebab-case |
| snake | 'snakecase' | 'snake', 'case' | snake_case |
| camel | 'camelcase' | 'camel', 'case' | CamelCase |
| mix | 'mixcase' | 'mix', 'case' | mixCase |
Words
the words maintain a dictionary to format your project file and directory names, jshelf will spit your file or directory name according these words. before use jshelf, you must scan your project and find all the words you used in your directory and files, exclude ignored files.
for example, now you have a file named jshelfformatfile.js, if you want to formated it to jshelfFormatFile.js, your words config should be ['jshelf', 'format', 'file'] and the case is mix.