dukeluo/eslint-plugin-check-filePublic

NotificationsYou must be signed in to change notification settings
Fork24
Star580

ESLint rules for consistent filename and folder. Allows you to enforce a consistent naming pattern for the filename and folder.

www.npmjs.com/package/eslint-plugin-check-file

License

Apache-2.0 license

580 stars 24 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 233 Commits
.github		.github
.husky		.husky
docs/rules		docs/rules
examples/basic		examples/basic
lib		lib
tests/lib/rules		tests/lib/rules
.commitlintrc		.commitlintrc
.editorconfig		.editorconfig
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
.tool-versions		.tool-versions
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
eslint.config.js		eslint.config.js
package-lock.json		package-lock.json
package.json		package.json
rollup.config.js		rollup.config.js
tea.yaml		tea.yaml
tsconfig.json		tsconfig.json

Repository files navigation

eslint-plugin-check-file

An ESLint plugin that enforces consistent naming conventions for files and folders in your project. It helps maintain a clean and organized codebase by allowing you to define and enforce specific patterns for filenames and directory structures.

Installation

You'll first need to installESLint:

npm i eslint --save-dev

Next, installeslint-plugin-check-file:

npm install eslint-plugin-check-file --save-dev

Usage

This plugin supports ESLint'sflat configuration. Here's a complete example:

importcheckFilefrom'eslint-plugin-check-file';exportdefault[{// optional: add this processor to files which not processed by other processors but still require lintingfiles:['**/*.yaml','**/*.webp'],processor:'check-file/eslint-processor-check-file',},{files:['src/**/*.*'],plugins:{'check-file':checkFile,},rules:{'check-file/no-index':'error','check-file/filename-blocklist':['error',{'**/*.model.ts':'*.models.ts','**/*.util.ts':'*.utils.ts',},],'check-file/folder-match-with-fex':['error',{'*.test.{js,jsx,ts,tsx}':'**/__tests__/','*.styled.{jsx,tsx}':'**/components/',},],'check-file/filename-naming-convention':['error',{'**/*.{jsx,tsx}':'PASCAL_CASE','**/*.{js,ts}':'CAMEL_CASE',},],'check-file/folder-naming-convention':['error',{'src/components/*/':'PASCAL_CASE','src/!(components)/**/!(__tests__)/':'CAMEL_CASE',},],},},];

Supported Rules

check-file/no-index: A file cannot be named "index"
check-file/filename-blocklist: Blocklist filenames by pattern
check-file/folder-match-with-fex: Enforce a consistent naming pattern for folder names for specified files
check-file/filename-naming-convention: Enforce a consistent naming pattern for filenames for specified files
check-file/folder-naming-convention: Enforce a consistent naming pattern for folder names for specified folders