Skip to content

amirzenoozi/eslint-plugin-filename-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-plugin-filename-checker

Check File Names Format

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-filename-checker:

$ npm install eslint-plugin-filename-checker --save-dev

or If you use Yarn:

$ yarn add -D eslint-plugin-filename-checker

Usage

Add filename-checker to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "filename-checker"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
      "filename-checker/file-format": [ "error", { "regex": "Your RegEx" }]
    }
}

Supported Rules

  • Fill in provided rules here