From 5ebc5815f60febded59e9bf4597ba6fdce242bc7 Mon Sep 17 00:00:00 2001 From: Grace Park Date: Tue, 26 Nov 2024 18:54:47 +0000 Subject: [PATCH] update readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e98fc8e0..673d85bc 100644 --- a/README.md +++ b/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`