README.md

ESLint plugin filenames simple

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

   • https://eslint.org/docs/user-guide/getting-started#installation-and-usage

   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

• extension
• named-export
• naming-convention
• no-index
• pluralize
• typescript-module-declaration

CHANGELOG

CHANGELOG

LICENSE

MIT