An ESLint plugin to check filenames with simple configuration.
This plugin is inspired by eslint-plugin-filenames.
-
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
-
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" }] } }
-
Run ESLint and lint your codes.
npm run eslint --ext .js . # or yarn run eslint --ext .js .