0.9.0 • Published 12 months ago

eslint-plugin-filenames-simple v0.9.0

Weekly downloads
3,651
License
MIT
Repository
github
Last release
12 months ago

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

  • Node.js: >= 14.17
    • Unstable versions of Node.js are not actively supported.
  • ESLint: 7.x, 8.x

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