Hi there! I'm currently have the following eslint config:

{
    // ...
    "check-file/filename-naming-convention": [
        "error",
        {
            "**/*.ts": "KEBAB_CASE"
        }
    ]
}

And it's working fine with regular (single wildcard) files:

.
├── sample-sample.ts
└── sample.ts

But in multiple wildcards, it throws errors for it:

.
├── sample.test.ts
├── sample-test.spec.ts
├── sample.d.css.ts
├── sample.config.ts
└── sample.d.ts

Hi in our project we use SNAKE CASE and we have some files named like this:

0123.js
0001_file.js

Eslint shows these files like errors. Is there a reason why the file names can't start with number or be numbers only ?

/**
 * @example hello, hello_world
 */
const SNAKE_CASE = '+([a-z])*([a-z0-9])*(_+([a-z0-9]))';

It doesn't seem to check for vue related items, similar to index.vue

Describe the bug

When I configure the filename rule to be able to add a rule on .md files, the rule does not work.

Expected behavior

.md files are linted.

Plugin configuration

'check-fike/filename-naming-convention': ['error', {
  '**/*.{md}': '+([a-z])',
}],

Project structure

.
└── my-app/
    └── READme.md

Desktop (please complete the following information):

• OS: Windows

Additional context

When I set the READme.md extension to .js, it works.

Seems like it's only works for js, jsx, ts and tsx extensions.

Describe the bug
Plugin does not work on file extension such as .png and .jpg. (Though they do not really fall under eslint scope, wanted to check if they are supported)

Expected behavior

Below command is not able catch error in the images folder whose .png are not in KEBAB_CASE. Refer the folder code structure. I have also tried keeping only one rule but it fails too. But if you specify hardcoded full path to image file, lint is able to catch error. (For ex. "images/folder/imageCamelCase.png": "KEBAB_CASE" will work)

    "check-file/filename-naming-convention": [
      "error",
      {
        "*.{png}":"KEBAB_CASE", 
        "images/**/*.png": "KEBAB_CASE"
      }
    ],

Plugin configuration

• Posted above.

Project structure

.
├── create_folder_file.sh
├── kebab-case
│   ├── images
│   │   ├── folder1
│   │     └── imageCamelCase.png
│   │   ├── folder2
│   │      └── image-Some_case.png
│   └── index.js
├── package-lock.json
├── .eslintrc.cjs
├── package.json
 ── index.js

Desktop (please complete the following information):

• OS: MacOS

Additional context
Trying to lint the .png extension and ensuring all are named in KEBAB_CASE.

With 'check-file/no-index': 'error', index.config.ts is allowed.

Describe the bug
The new pattern:

module.exports = {
  plugins: ['check-file'],
  rules: {
    'check-file/filename-blocklist': [
      'error',
      { '*.models.ts': '*.model.ts' },
      {
        errorMessage:
          'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
      },
    ],
  },
};

still requires an expected Glob { '*.models.ts': '*.model.ts' }, despite the errorMessage Not using it at all. In addition the previous PR where a non-glob string could be used in the value {'*models.ts: reson models is not allowed}` also allowed a different reason for each block. The current implementation should at least allow an empty string in value when errorMessage is defined.
It just doesn't make sense to still have to provide a suggested Glob pattern that must pass a glob matching pattern, when it isn't used at all.

Expected behavior

module.exports = {
  plugins: ['check-file'],
  rules: {
    'check-file/filename-blocklist': [
      'error',
      { '*.models.ts':  'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details'
       '*.otherthing.ts':  'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see aDifferent.md for details'
      },
      {
        errorMessage: true 
        },
    ],
  },
};

should work and not return the error " 1:1 error There is an invalid pattern "The file "{{ target }}" is blocked since it since it matches the blocklisted pattern", please double-check it and try again check-file/filename-blocklist"

OR at least:

module.exports = {
  plugins: ['check-file'],
  rules: {
    'check-file/filename-blocklist': [
      'error',
      { '*.models.ts': '' },
      {
        errorMessage:
          'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
      },
    ],
  },
};

should work and not return the error " 1:1 error There is an invalid pattern "The file "{{ target }}" is blocked since it since it matches the blocklisted pattern", please double-check it and try again check-file/filename-blocklist"

Desktop (please complete the following information):

• OS: macOS

Additional context
Add any other context about the problem here.

Feature request
Support Next.JS folder and file naming convention as a named rule.

Acceptance criteria
Folder and file names within a certain directory eg. pages are to be considered valid if at least one of the following conventions hold true:

• kebab-case (regular pages-folders), eg. posts or web-posts
• camelCase enclosed in [], eg. [postId]
• or camelCase enclosed in [...], where this must be a leaf node, eg. [...slug]
• or camelCase enclosed in [[...]], where this must be a leaf node, eg. [[...slug]]

Current workaround

• Define own glob pattern.

Further documentation
https://nextjs.org/docs/routing/dynamic-routes

Describe the bug
For file name like g2tClass, current CAMEL_CASE that cannot support very well

Expected behavior
Current if the 2nd char of the file is a number, then no matter what pattern it is, it cannot be recongized as CAMEL_CASE.
I have tried g2tClass.js g2TClass.js and G2TClass.js, all of them failed the CAMCL_CASE, and I expect either g2tClass.js g2TClass.js can pass the case

Plugin configuration
"check-file/filename-naming-convention": ["error", {
"/classes/": "CAMEL_CASE",
}],

Project structure
If applicable, add a minimal reproducible project structure generated by the tree cmd like the one below.

.
├── create_folder_file.sh
├── classes
│   ├── classes
│   └── g2tClass.js
├── package-lock.json
├── package.json
└── src
    └── kebab-case
        └── index.js

Desktop (please complete the following information):
Linux

Additional context
Correct me if this is my mistake

Describe the bug
I'm currently working in a monorepo and want to enforce the Kebab Case convention for my domains folder but exclude all the __tests__ folders inside it.
I've tried to use the expression described in the documentation but it does not work as expected on my project.
If I use the full path, it works as expected. But if I change the intermediate folders for /**/, then it doesn't work.

Expected behavior
Files inside the __tests__ should not throw check-file/folder-naming-convention error

Plugin configuration

[.eslintrc.base.json]
...
    "check-file/folder-naming-convention": [
      "error",
      {
        "domains/**/!(__tests__)/**": "KEBAB_CASE", // this doesn't work
        "domains/sub-domain-a/src/!(__tests__)/**": "KEBAB_CASE", // this works
        "domains/**/src/!(__tests__)/**": "KEBAB_CASE", // this works but I want to have a more flexible configuration
      },
    ],

Project structure
If applicable, add a minimal reproducible project structure generated by the tree cmd like the one below.

.
├── domains
│   ├── sub-domain-a
│   │   ├── src
│   │   │   └── __tests__
│   │   │   │   └── test.ts
│   ├── sub-domain-b
│   │   ├── app
│   │   │   └── __tests__
│   │   │   │   └── test.js
│   ├── sub-domain-c
│   │   ├── feature-a
│   │   │   ├── src
│   │   │   │   └── __tests__
│   │   │   │   │   └── test.js
├── libs
├── scripts
├── package-lock.json
├── package.json
└── .eslintrc.base.json

Desktop:

• OS: macOS Sonoma

great project!

for some reason I get this error:

seeds/01-applications.ts
  1:1  error  The filename "seeds/01-applications.ts" does not match the "KEBAB_CASE" style  check-file/filename-naming-convention

for this config:

"check-file/filename-naming-convention":[
			"error",
			{
				"**/*.{js,ts}":"KEBAB_CASE"
			},
			{
				"ignoreMiddleExtensions": true
			}
		],
		"check-file/folder-naming-convention":[
			"error",
			{
				"app/**/":"KEBAB_CASE",
				"test/!(__fixtures__)/**/":"KEBAB_CASE"
			}
		]

Project structure
I would like to support both canonical configurations. as follows:

└── src
    └── kebabCase.js
    └── kebab-case.js

Whether the following configurations are supported：

 "src/**/!(App).vue": "KEBAB_CASE|PASCAL_CASE",

Hey. Thank you for this plugin !

Is it possible to have a naming convention rule for Folders, that takes into account the parent folder name ?
I know it's possible to enforce fileNames to contain the name of the parentFolder. But is it possbile for folders ?
Eg. something like :

"src/folder/*/*": "<1>"

With a structure like :

└── src
    └── folder
        └── sub-folder
             └── sub-folder.sub-sub-foldername

Also. the final rule should match folders with 'parentFolderName.kebab-case' . So a combination between parentFolder name and kebab-case afterwards

Hi, is there any chance to provide custom error message rule for filename-naming-convention?
Currently, especially when used with prefined match syntax - error message is very misleading/unclear
We would get error like

 error  The filename "MyComponent.tsx" does not match the "<1>" pattern  check-file/filename-naming-convention

What I would like to have instead is the ability to define custom error message (even hard coded, without dynamic parts like exact file name or so)

Error like this would be much more helpful

 error  The filename doesn't match file naming convention defined for this project. See contribute.md for details

Hi there!

I've been trying to make a glob pattern that would match what this regex matches for a while:

^(?:\[[a-z]+(?:-[a-z]+)*]|(?:[a-z]+(?:-[a-z]+)*))$

But unfortunately, I can't figure it out.

I have seen #20 and I agree with you that it should not be part of the library, but I would like to ask for your help for a glob that would match what's needed, if it's possible. If not, would you consider supporting regexes?

Test data

Should pass

some
some-string
[some-string]
[some]

Should not pass

[some-string
some-string]
[some]-string

Thank you for the tool. I would happily submit a PR that documents these custom globs for Next.js if we can make some.

I've setup this proj: a folder with an invalid name contains two files. When linting, the folder is reported twice as not matching its rule.

$ find src/
src/
src/Bar
src/Bar/a.ts
src/Bar/b.ts
$ cat .eslintrc.yml
env:
  es2021: true
  node: true
overrides: [ ]
parser: '@typescript-eslint/parser'
parserOptions:
  ecmaVersion: latest
  sourceType: module
plugins:
  - 'check-file'
rules: {
  'check-file/folder-naming-convention': [ 'warn', { 'src/**': 'KEBAB_CASE' } ],
}
$ cat package.json
{
  "name": "bar",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\""
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@typescript-eslint/parser": "^5.59.11",
    "eslint": "^8.42.0",
    "eslint-plugin-check-file": "^2.4.0",
    "typescript": "^4.9.3",
    "typescript-eslint": "^0.0.1-alpha.0"
  }
}
$ npm run lint

> [email protected] lint
> eslint "{src,apps,libs,test}/**/*.ts"


C:\Users\amitd\AppData\Local\Temp\bar\src\Bar\a.ts
  1:1  warning  The folder "Bar" does not match the "KEBAB_CASE" pattern  check-file/folder-naming-convention

C:\Users\amitd\AppData\Local\Temp\bar\src\Bar\b.ts
  1:1  warning  The folder "Bar" does not match the "KEBAB_CASE" pattern  check-file/folder-naming-convention

✖ 2 problems (0 errors, 2 warnings)

Im currently matching **/*.{jsx,tsx,js,ts} and i want to ignore *.page.tsx files. How can i do that?

**/*!(.page).{jsx,tsx,js,ts} does not work :(

We use PascalCase.tsx for components in our React projects. We also use camelCase for hooks.

Would be nice to be able to enforce this:

{
  "**/*.{jsx,tsx}": ["PASCAL_CASE", "CAMEL_CASE"]
}

Thanks!

Steps to reproduce

• Follow the installation process
• Add rule

   "check-file/folder-naming-convention": [
      "error",
      {
        "*/!(__tests__)/**/": "KEBAB_CASE"
      }
    ]

• Create a folder with "NotKebabCase" and create "index.js" inside it
• Run a linter

Current behavior

No error is reported

Expected behavior

"NotKebabCase" folder should be reported as eslint error

https://github.com/DukeLuo/eslint-plugin-check-file/blob/ac5fa6b851f29c5cb2e69dd3665fccd94becf809/lib/utils/filename.js#L11

https://github.com/DukeLuo/eslint-plugin-check-file/blob/ac5fa6b851f29c5cb2e69dd3665fccd94becf809/lib/utils/filename.js#L17

The windows style path is D:\\path-to\\dir\\filename.js, is it possible to use path.basename, path.dirname ?

这两个函数不兼容 windows 系统的路径风格，应该可以用 path.basename 和 path.dirname 替代

Hello!

Does this plugin support Flat config? (eslint.config.js). Since the other config files will be deprecated after ESLint v9.0.0, it would be great if we could use it with the new config. (Sorry if it is already available. I might have missed)

Currently, if I import the plugin to the new config file, it shows error as

import eslintCheckFile from 'eslint-plugin-check-file';
       ^^^^^^^^^^^^^^^
SyntaxError: The requested module 'eslint-plugin-check-file' does not provide an export named 'default'

// eslint.config.js
import eslintCheckFile from 'eslint-plugin-check-file';
export default [
	...eslintCheckFile,
];

I would like to use KEBAB_CASE for almost all files and overall it seems to work well, however I think some cases are matched too loosely.
This is my config:

“check-file/filename-naming-convention”: [
    “error”,
    {
        “*.{js,ts,jsx,tsx,json}“: “KEBAB_CASE”
    }
],
“check-file/folder-naming-convention”: [
    “error”,
    {
        “src/**“: “KEBAB_CASE”,
        “packages/**“: “KEBAB_CASE”
    }
]

However I think these errors are false positives:

1:1 error The filename “babel.config.js” does not match the “KEBAB_CASE” style check-file/filename-naming-convention
7:1 error The filename “jest.config.js” does not match the “KEBAB_CASE” style check-file/filename-naming-convention
3:1 error The filename “index.test.ts” does not match the “KEBAB_CASE” style check-file/filename-naming-convention
3:1 error The filename “index.spec.ts” does not match the “KEBAB_CASE” style check-file/filename-naming-convention
3:1 error The filename “some-test.spec.ts” does not match the “KEBAB_CASE” style check-file/filename-naming-convention

Also I could not make it work with other cases:

3:1 error The filename “some-test.spec.ts” does not match the “CAMEL_CASE” style check-file/filename-naming-convention
3:1 error The filename “some_test.spec.ts” does not match the “SNAKE_CASE” style check-file/filename-naming-convention

I could not find away to adjust the file matching to make it work or exclude the rule for these files without disabling eslint for them entirely.

I think .config, .test and .spec should be valid for KEBAB_CASE and most other as well.

Any suggestions to change my config or could this be improved in the file name matching?

First of all, thank you for creating this.

Here are my current rules:

{
  "check-file/folder-naming-convention": [
    "error",
    {
      "*": "KEBAB_CASE"
    }
  ],
  "check-file/filename-naming-convention": [
    "error",
    {
      "*": "KEBAB_CASE"
    }
  ]
}

As you can see, the file name foB didn't throw the error:

But if I change the rules to:

{
  "check-file/folder-naming-convention": [
    "error",
    {
      "*": "KEBAB_CASE"
    }
  ],
  "check-file/filename-naming-convention": [
    "error",
    {
      "**": "KEBAB_CASE"
    }
  ]
}

Now it works as expected:

Notice the file pattern uses ** whereas the folder pattern uses *, is this inconsistency intentional or a bug?

We in our team have a rule, that we put all *Utils files under utils folder. But sometimes new team members create helpers folders.

How can I check with this plugin that there is no helpers folders in the repo?

Hi!

I notice issue with 'check-file/folder-naming-convention' (v1.2.0).

With this settings:

 rules: {
    'check-file/folder-naming-convention': [
      'error',
      {
        'src/**': 'KEBAB_CASE',
      },
    ],
  },

I got errors on folders with correct kebab-case name:

Users/adrian/Workspace/my-project/src/app/components/announcement/modal/modal.component.ts
  9:5  error  The folder "modal.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

/Users/adrian/Workspace/my-project/src/app/components/status-dot/status-dot.component.ts
  0:1  error  The folder "status-dot.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

/Users/adrian/Workspace/my-project/src/app/page/authorized-area/account/activities/activities.component.ts
  16:5  error  The folder "activities.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

/Users/adrian/Workspace/my-project/src/app/page/authorized-area/export/download-history/download-history.component.ts
  18:5  error  The folder "download-history.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

/Users/adrian/Workspace/my-project/src/app/page/authorized-area/export/last-update/last-update.component.ts
  16:5  error  The folder "last-update.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

/Users/adrian/Workspace/my-project/src/app/page/authorized-area/export/list/item/item.component.ts
  21:5  error  The folder "item.component.ts" does not match the "KEBAB_CASE" style  check-file/folder-naming-convention

I used also regex +([a-z0-9])*(-+([a-z0-9])) but still the same result.

Describe the bug
cannot exclude folders named tests

Expected behavior
'check-file/folder-naming-convention' : I would like to check every name's folder except tests

Project structure

Here is how I am using it :
'check-file/folder-naming-convention': [
'error',
{
'src/components!(tests)/**/': 'CAMEL_CASE',
},
],

When using KEBAB_CASE filename convention. It is not uncommon to use the .test.js file extension as a filename convention for tests.

 └── src
     └── my-module.js
 └── tests
     └── my-module.test.js

However, this causes the KEBAB_CASE filename enforcement to fail for { "**/*.js": "KEBAB_CASE" } This can currently be worked around with a custom Regex, however, I wanted to bring attention to this.

Is this desired behavior?

Describe the bug
check-file/filename-naming-convention application is not working as expected with custom matching

Expected behavior
I expected it to work with custom glob matching

Plugin configuration

  "check-file/filename-naming-convention": [
      "error",
      {
        "**/tests/e2e/*": "*.{spec,test}.e2e.ts",
      },
    ]

Desktop (please complete the following information):

• OS: macos

Additional context
It prints the error The filename "my-controller.spec.e2e.ts" does not match the "*.{spec,test}.e2e.ts" pattern
Even thought console.log(micromatch.isMatch('my-controller.spec.e2e.ts', '*.{spec,test}.e2e.ts')) // returns true
Is there anything i am doing wrong or is there a bug with this?

Describe the bug
Given a config like

		'check-file/folder-naming-convention': [
			'error',
			{
				'src/pages/**': 'KEBAB_CASE'',
				'src/!(pages)/**': 'CAMEL_CASE',
			}
               ]

Then the following folder-names are considered valid:

• src/pages/first-page/**
• src/components/visual/interactiveButton/**
• src/components/visual/interactive-button/**

Expected behavior

• src/components/visual/interactive-button/** should not be valid, because interactive-buttonis violating the CAMEL_CASE rule.

Project structure

.
└── src
    └── components
        └── visual
            └── interactive-button // should fail here!
                 └── SomeFile.tsx
            └── interactiveButton // should be the only valid format
                 └── SomeFile.tsx
    └── pages
        └── first-page
            └── page.tsx

Desktop (please complete the following information):

• OS: Ubuntu 23.04

Additional information
This bug only exist if the exclusion is applied on a sub-folder. It doesn't exist if the root-folder (here src) is excluded.

The micromatch.capture seems to always return unix path style，but getAllFolders using path.sed. So in windows getAllFolders doesn't work.

https://github.com/DukeLuo/eslint-plugin-check-file/blob/b2a6cc422355a673533c2a77922696e288330688/lib/rules/folder-naming-convention.js#L74-L75