eslint-plugin-filename-consistency/README.md

Eslint rule for consistent file and folder names

# eslint-plugin-filename-consistency

## Enabling the plugin

Modify your `.eslintrc` file to load the plugin and enable the rules you want to use.

```json
{
  "plugins": [
    "filename-consistency"
  ],
  "rules": {
    "filename-consistency/match": "error"
  }
}
```

## Rules

### Consistent files and folders names (`match`)

A rule to enforce a certain file and folder naming convention.

The convention can be configured using the name of case (the default is `camel`).

Read more about this rule [here](docs/rules/match.md)