Merge pull request #579 from github/legacy-filenames

Go back to legacy eslint-filenames-plugin for <v9

README.md

@@ -55,6 +55,11 @@ export default [
 ]
 ```
 
+> [!NOTE]
+> If you configured the `filenames/match-regex` rule, please note we have adapted the match regex rule into `eslint-plugin-github` as the original `eslint-filenames-plugin` is no longer maintained and needed an ESLint v9 update. Please update the name to `github/filenames-match-regex` and keep the same configuration. For e.g.:
+>
+> `'github/filenames-match-regex': ['error', '^[a-z0-9-]+(.[a-z0-9-]+)?$']`
+
 The available configs are:
 
 - `internal`
@@ -120,7 +125,7 @@ This config will be interpreted in the following way:
 | [async-currenttarget](docs/rules/async-currenttarget.md)                                                 | disallow `event.currentTarget` calls inside of async functions                                                           | 🔍 |    |    |
 | [async-preventdefault](docs/rules/async-preventdefault.md)                                               | disallow `event.preventDefault` calls inside of async functions                                                          | 🔍 |    |    |
 | [authenticity-token](docs/rules/authenticity-token.md)                                                   | disallow usage of CSRF tokens in JavaScript                                                                              | 🔐 |    |    |
-| [filenames-match-regex](docs/rules/filenames-match-regex.md)                                             | ensure filenames match a regex naming convention                                                                         | ✅  |    |    |
+| [filenames-match-regex](docs/rules/filenames-match-regex.md)                                             | ensure filenames match a regex naming convention                                                                         |    |    |    |
 | [get-attribute](docs/rules/get-attribute.md)                                                             | disallow wrong usage of attribute names                                                                                  | 🔍 | 🔧 |    |
 | [js-class-name](docs/rules/js-class-name.md)                                                             | enforce a naming convention for js- prefixed classes                                                                     | 🔐 |    |    |
 | [no-blur](docs/rules/no-blur.md)                                                                         | disallow usage of `Element.prototype.blur()`                                                                             | 🔍 |    |    |

docs/rules/filenames-match-regex.md

@@ -1,12 +1,10 @@
 # Ensure filenames match a regex naming convention (`github/filenames-match-regex`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
-
 <!-- end auto-generated rule header -->
 
 ## Rule Details
 
-Rule to ensure that filenames match a convention, with a default of camelCase.
+Rule to ensure that filenames match a convention, with a default of camelCase for ESLint v9+.
 
 👎 Examples of **incorrect** filename for this default rule:
 

lib/configs/recommended.js

@@ -8,7 +8,7 @@ module.exports = {
   env: {
     es6: true,
   },
-  plugins: ['github', 'prettier', 'eslint-comments', 'import', 'i18n-text', 'no-only-tests'],
+  plugins: ['github', 'prettier', 'eslint-comments', 'import', 'filenames', 'i18n-text', 'no-only-tests'],
   rules: {
     'constructor-super': 'error',
     'eslint-comments/disable-enable-pair': 'off',
@@ -18,7 +18,7 @@ module.exports = {
     'eslint-comments/no-unused-disable': 'error',
     'eslint-comments/no-unused-enable': 'error',
     'eslint-comments/no-use': ['error', {allow: ['eslint', 'eslint-disable-next-line', 'eslint-env', 'globals']}],
-    'github/filenames-match-regex': ['error', '^[a-z0-9-]+(.[a-z0-9-]+)?$'],
+    'filenames/match-regex': ['error', '^[a-z0-9-]+(.[a-z0-9-]+)?$'],
     'func-style': ['error', 'declaration', {allowArrowFunctions: true}],
     'github/array-foreach': 'error',
     'github/no-implicit-buggy-globals': 'error',

package.json

@@ -35,10 +35,13 @@
     "@eslint/eslintrc": "^3.1.0",
     "@eslint/js": "^9.14.0",
     "@github/browserslist-config": "^1.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
     "aria-query": "^5.3.0",
     "eslint-config-prettier": ">=8.0.0",
     "eslint-plugin-escompat": "^3.11.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-filenames": "^1.3.2",
     "eslint-plugin-i18n-text": "^1.0.1",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-jsx-a11y": "^6.7.1",