Skip to content

An ESLint plugin to check filenames with simple configuration

License

Notifications You must be signed in to change notification settings

khealth/eslint-plugin-filenames-simple

 
 

Repository files navigation

ESLint plugin filenames simple

npm version Build Status Maintainability Test Coverage

An ESLint plugin to check filenames with simple configuration.
This plugin is inspired by eslint-plugin-filenames.

Requirements

Getting started

  1. Install ESLint and this plugin via npm/yarn

    npm i --save-dev eslint eslint-plugin-filenames-simple
    # or
    yarn add -D eslint eslint-plugin-filenames-simple
  2. Modify your .eslintrc file to load the plugin and enable the rules.

    // select one of the following
    {
      "extends": [
        "plugin:filenames-simple/recommended"       // for pure ECMAScript/TypeScript project
        "plugin:filenames-simple/recommended-react" // for React.js project
        "plugin:filenames-simple/recommended-vue"   // for Vue.js project
      ]
    }
    // or configure manually
    {
      "plugins": [
        "filenames-simple"
      ],
      "rules": {
        "filenames-simple/extension": "error",
        "filenames-simple/naming-convention": ["error", { "rule": "kebab-case" }]
      }
    }
  3. Run ESLint and lint your codes.

    npm run eslint --ext .js .
    # or
    yarn run eslint --ext .js .

Available rules

CHANGELOG

CHANGELOG

LICENSE

MIT

About

An ESLint plugin to check filenames with simple configuration

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.5%
  • JavaScript 0.5%