feat(plugins/naming-convention):add 'ignoreFilesWithoutCode' option to 'filename-extension'

Author: Rel1cx

packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename-extension.ts

@@ -18,13 +18,15 @@ type Options = readonly [
   | {
     allow?: Allow;
     extensions?: readonly string[];
+    ignoreFilesWithoutCode?: boolean;
   },
 ];
 /* eslint-enable no-restricted-syntax */
 
 const defaultOptions = [{
   allow: "as-needed",
   extensions: [".jsx", ".tsx"],
+  ignoreFilesWithoutCode: false,
 }] as const satisfies Options;
 
 const schema = [
@@ -49,6 +51,9 @@ const schema = [
             },
             uniqueItems: true,
           },
+          ignoreFilesWithoutCode: {
+            type: "boolean",
+          },
         },
       },
     ],
@@ -98,6 +103,9 @@ export default createRule<Options, MessageID>({
           return;
         }
 
+        const hasCode = node.body.length > 0;
+        const ignoreFilesWithoutCode = isObject(options) && options.ignoreFilesWithoutCode;
+        if (!hasCode && ignoreFilesWithoutCode) return;
         if (
           !hasJSXCode
           && isJSXExt

website/pages/docs/rules/naming-convention-component-name.mdx

@@ -36,7 +36,7 @@ function ExampleComponent() {
 
 ## Rule Options
 
-- `rule`: The rule to apply to the file name. Can be one of the following:
+- `rule`: The rule to apply to the file name. Default is `"PascalCase"`. Possible values:
   1. `PascalCase`: PascalCase
   2. `CONSTANT_CASE`: CONSTANT_CASE
 - `excepts`: (optional) An array of component names that are allowed to not follow the rule.

website/pages/docs/rules/naming-convention-filename-extension.mdx

@@ -14,10 +14,11 @@ This rule enforces consistent file extensions for JSX files.
 
 ## Rule Options
 
-- `allow`: When to allow a JSX filename extension.
+- `allow`: When to allow a JSX filename extension. Default is `"as-needed"`. Possible values:
   1. `"always"`: allow all file use JSX file extension.
-  2. `"as-needed"`: (default) allow JSX file extension only if the file contains JSX syntax.
-- `extensions`: List of file extensions that should be checked by this rule. By default, The default value is `[".jsx", ".tsx"]` which checks only `.jsx` and `.tsx` files.
+  2. `"as-needed"`: allow JSX file extension only if the file contains JSX syntax.
+- `extensions`: List of file extensions that should be treated as JSX files. Default is `[".jsx", ".tsx"]`.
+- `ignoreFilesWithoutCode`: When set to `true`, this rule will ignore files that do not contain JSX syntax. Default is `true`.
 
 ## Rule Options Examples
 

website/pages/docs/rules/naming-convention-filename.mdx

@@ -50,8 +50,8 @@ src/components/example-component.tsx
 
 ## Rule Options
 
-- `rule`: The rule to apply to the file name. Can be one of the following:
-  1. `PascalCase`: PascalCase (default)
+- `rule`: The rule to apply to the file name. Default is `"PascalCase"`. Possible values:
+  1. `PascalCase`: PascalCase
   2. `camelCase`: camelCase
   3. `kebab-case`: kebab-case
   4. `snake_case`: snake_case