GitHub - DukeLuo/eslint-plugin-check-file: ESLint rules for consistent filename...
source link: https://github.com/DukeLuo/eslint-plugin-check-file
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
eslint-plugin-check-file
ESLint rules for consistent filename and folder. Allows you to enforce a consistent naming pattern for the filename and folder.
Installation
You'll first need to install ESLint:
npm i eslint --save-dev
Next, install
eslint-plugin-check-file
:
npm install eslint-plugin-check-file --save-dev
Usage
Add check-file
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"check-file"
]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"check-file/folder-match-with-fex": [
"error",
{
"*.test.{js,jsx,ts,tsx}": "**/__tests__/",
"*.styled.{jsx,tsx}": "**/pages/"
}
],
"check-file/filename-naming-convention": [
"error",
{
"**/*.{jsx,tsx}": "CAMEL_CASE",
"**/*.{js,ts}": "KEBAB_CASE"
}
],
"check-file/no-index": "error",
"check-file/folder-naming-convention": [
"error",
{
"src/**/": "CAMEL_CASE",
"mocks/*/": "KEBAB_CASE"
}
],
"check-file/filename-blocklist": [
"error",
{
"**/*.model.ts": "*.models.ts",
"**/*.util.ts": "*.utils.ts"
}
]
}
}
Supported Rules
- check-file/folder-match-with-fex: Enforce a consistent naming pattern for the folder of the specified file extension
- check-file/filename-naming-convention: Enforce a consistent naming pattern for the filename of the specified file
- check-file/no-index: A file cannot be named "index"
- check-file/folder-naming-convention: Enforce a consistent naming pattern for the name of the specified folder
- check-file/filename-blocklist: Blocklist file names by pattern
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK