release: 0.9.7-beta.0

Author: Rel1cx

CHANGELOG.md

@@ -1,13 +1,29 @@
-## v0.9.7-beta.0 (Draft)
+## v0.9.7-beta.0 (Thu Dec 14 2023)
 
 ### Release Notes
 
+#### Rule `named-convention/filename` add `extensions` option
+
+#### Rule `named-convention/filename-extension` add `extensions` option
+
+#### Rule `named-convention/filename-extension` rename `rule` option to `allow`
+
 ---
 
 #### 🏠 Internal
 
+- `@eslint-react/eslint-plugin-naming-convention`
+  - Rule `named-convention/filename` add `extensions` option.
+  - Rule `named-convention/filename-extension` rename `rule` option to `allow`.
+  - Rule `named-convention/filename-extension` add `extensions` option.
+
+- `@eslint-react/shared`
+  - Remove `JSX_EXTENSIONS` from `@eslint-react/shared`.
+
 - `@eslint-react/monorepo`
   - Update `bun` to `1.0.17`.
+  - Update `vitest` to `1.0.4`.
+  - Update `eslint-config-with-tsconfig` to `2.9.160`.
 
 #### Authors: 1
 

packages/eslint-plugin-naming-convention/src/rules/filename-extension.md

@@ -20,7 +20,7 @@ This rule enforces consistent file extensions for JSX files.
 
 ## Rule Options
 
-This rule has a string option:
-
-- `"always"`: (default) allow all file use JSX file extension.
-- `"as-needed"`: allow JSX file extension only if the file contains JSX syntax.
+- `allow`: When to allow a JSX filename extension.
+  - `"always"`: (default) allow all file use JSX file extension.
+  - `"as-needed"`: 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, it checks `.jsx`, `.tsx` and `.mtx` files.

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

@@ -32,7 +32,7 @@ ruleTester.run(RULE_NAME, rule, {
     {
       filename: "react.tsx",
       code: withoutJSX,
-      options: [{ rule: "always" }],
+      options: [{ allow: "always" }],
     },
   ],
   invalid: [
@@ -49,12 +49,27 @@ ruleTester.run(RULE_NAME, rule, {
     {
       filename: "react.tsx",
       code: withoutJSX,
-      options: [{ rule: "as-needed" }],
+      options: [{ allow: "as-needed" }],
       errors: [
         {
           messageId: "FILE_NAME_EXTENSION_UNEXPECTED",
         },
       ],
     },
+    {
+      filename: "react.tsx",
+      code: withJSXElement,
+      options: [
+        {
+          allow: "as-needed",
+          extensions: ["mtx"],
+        },
+      ],
+      errors: [
+        {
+          messageId: "FILE_NAME_EXTENSION_INVALID",
+        },
+      ],
+    },
   ],
 });

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

@@ -2,7 +2,7 @@ import { MutRef, P } from "@eslint-react/tools";
 import type { ESLintUtils } from "@typescript-eslint/utils";
 import type { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
 
-import { createRule, isJSXFile } from "../utils";
+import { createRule } from "../utils";
 
 export const RULE_NAME = "filename-extension";
 
@@ -13,7 +13,8 @@ type Cond = "always" | "as-needed";
 /* eslint-disable no-restricted-syntax */
 type Options = readonly [
   | {
-    rule?: Cond;
+    allow?: Cond;
+    extensions?: readonly string[];
     // Reserved for future use
     // excepts?: readonly string[];
   }
@@ -22,7 +23,10 @@ type Options = readonly [
 ];
 /* eslint-enable no-restricted-syntax */
 
-const defaultOptions = ["as-needed"] as const satisfies Options;
+const defaultOptions = [{
+  allow: "as-needed",
+  extensions: ["jsx", "tsx", "mtx"],
+}] as const satisfies Options;
 
 const schema = [
   {
@@ -35,10 +39,17 @@ const schema = [
         type: "object",
         additionalProperties: false,
         properties: {
-          rule: {
+          allow: {
             type: "string",
             enum: ["always", "as-needed"],
           },
+          extensions: {
+            type: "array",
+            items: {
+              type: "string",
+            },
+            uniqueItems: true,
+          },
         },
       },
     ],
@@ -55,14 +66,17 @@ export default createRule<Options, MessageID>({
     },
     schema,
     messages: {
-      FILE_NAME_EXTENSION_INVALID: "JSX files must have a `.jsx` or `.tsx` extension",
-      FILE_NAME_EXTENSION_UNEXPECTED: "use `.jsx` or `.tsx` extension as needed",
+      FILE_NAME_EXTENSION_INVALID: "JSX file extension is required",
+      FILE_NAME_EXTENSION_UNEXPECTED: "use JSX file extension as needed",
     },
   },
   defaultOptions,
   create(context) {
     const options = context.options[0] ?? defaultOptions[0];
-    const cond = P.isString(options) ? options : options.rule ?? "as-needed";
+    const allow = P.isObject(options) ? options.allow : options;
+    const extensions = P.isObject(options) && "extensions" in options
+      ? options.extensions
+      : defaultOptions[0].extensions;
 
     const filename = context.getFilename();
     const hasJSXNodeRef = MutRef.make<boolean>(false);
@@ -75,11 +89,13 @@ export default createRule<Options, MessageID>({
         MutRef.set(hasJSXNodeRef, true);
       },
       "Program:exit"(node) {
-        const fileNameExt = filename.slice(filename.lastIndexOf("."));
-        const isJSX = isJSXFile(fileNameExt);
+        const fileNameExt = filename
+          .slice(filename.lastIndexOf("."))
+          .replace(".", "");
+        const isJSXExt = extensions.includes(fileNameExt);
         const hasJSXCode = MutRef.get(hasJSXNodeRef);
 
-        if (!isJSX && hasJSXCode) {
+        if (hasJSXCode && !isJSXExt) {
           context.report({
             messageId: "FILE_NAME_EXTENSION_INVALID",
             node,
@@ -89,9 +105,9 @@ export default createRule<Options, MessageID>({
         }
 
         if (
-          isJSX
-          && !hasJSXCode
-          && cond === "as-needed"
+          !hasJSXCode
+          && isJSXExt
+          && allow === "as-needed"
         ) {
           context.report({
             messageId: "FILE_NAME_EXTENSION_UNEXPECTED",

packages/eslint-plugin-naming-convention/src/rules/filename.md

@@ -67,3 +67,4 @@ src/components/example-component.tsx
   - `kebab-case`: kebab-case
   - `snake_case`: snake_case
 - `excepts`: List of file names that should be ignored by this rule.
+- `extensions`: List of file extensions that should be checked by this rule. By default, it checks `.jsx`, `.tsx` and `.mtx` files.

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

@@ -5,7 +5,7 @@ import type { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
 import type { ReportDescriptor } from "@typescript-eslint/utils/ts-eslint";
 import path from "pathe";
 
-import { createRule, isJSXFile } from "../utils";
+import { createRule } from "../utils";
 
 export const RULE_NAME = "filename";
 
@@ -14,6 +14,7 @@ export type MessageID = "FILENAME_CASE_MISMATCH" | "FILENAME_CASE_MISMATCH_SUGGE
 /* eslint-disable no-restricted-syntax */
 type Options = readonly [
   | {
+    extensions?: readonly string[];
     excepts?: readonly string[];
     rule?: "PascalCase" | "camelCase" | "kebab-case" | "snake_case";
   }
@@ -24,6 +25,7 @@ type Options = readonly [
 
 const defaultOptions = [
   {
+    extensions: ["jsx", "tsx", "mtx"],
     excepts: ["index"],
     rule: "PascalCase",
   },
@@ -40,6 +42,11 @@ const schema = [
         type: "object",
         additionalProperties: false,
         properties: {
+          extensions: {
+            type: "array",
+            items: { type: "string" },
+            uniqueItems: true,
+          },
           excepts: {
             type: "array",
             items: { type: "string", format: "regex" },
@@ -59,7 +66,7 @@ export default createRule<Options, MessageID>({
   meta: {
     type: "suggestion",
     docs: {
-      description: "enforce naming convention for JSX file names",
+      description: "enforce naming convention for JSX filenames",
       requiresTypeChecking: false,
     },
     schema,
@@ -75,11 +82,16 @@ export default createRule<Options, MessageID>({
     const options = context.options[0] ?? defaultOptions[0];
     const rule = P.isString(options) ? options : options.rule ?? "PascalCase";
     const excepts = P.isString(options) ? [] : options.excepts ?? [];
+    const extensions = P.isObject(options) && "extensions" in options
+      ? options.extensions
+      : defaultOptions[0].extensions;
 
     const filename = context.getFilename();
-    const fileNameExt = filename.slice(filename.lastIndexOf("."));
+    const fileNameExt = filename
+      .slice(filename.lastIndexOf("."))
+      .replace(".", "");
 
-    if (!isJSXFile(fileNameExt)) {
+    if (!extensions.includes(fileNameExt)) {
       return {};
     }
 

packages/eslint-plugin-naming-convention/src/utils/index.ts

@@ -1,2 +1 @@
 export * from "./create-rule";
-export * from "./is-jsx-file";

packages/eslint-plugin-naming-convention/src/utils/is-jsx-file.ts

@@ -39,7 +39,6 @@
 - [GITHUB\_URL](README.md#github_url)
 - [HostHTMLComponentTypes](README.md#hosthtmlcomponenttypes)
 - [HostSVGComponentTypes](README.md#hostsvgcomponenttypes)
-- [JSX\_EXTENSIONS](README.md#jsx_extensions)
 - [NPM\_SCOPE](README.md#npm_scope)
 - [RE\_JAVASCRIPT\_PROTOCOL](README.md#re_javascript_protocol)
 - [ReactHostHTMLComponent](README.md#reacthosthtmlcomponent)
@@ -260,12 +259,6 @@ Rule severity.
 
 ---
 
-### JSX\_EXTENSIONS
-
-• `Const` **JSX\_EXTENSIONS**: `string`[]
-
----
-
 ### NPM\_SCOPE
 
 • `Const` **NPM\_SCOPE**: `"@eslint-react"`

packages/shared/docs/README.md

@@ -4,8 +4,6 @@ export const GITHUB_URL = "https://github.com/rel1cx/eslint-react/blob/main";
 
 export const WEBSITE_URL = "https://eslint-react.rel1cx.io";
 
-export const JSX_EXTENSIONS = [".jsx", ".tsx"];
-
 // @see https://github.com/facebook/react/blob/6db7f4209e6f32ebde298a0b7451710dd6aa3e19/packages/react-dom-bindings/src/shared/sanitizeURL.js#L22
 // dprint-ignore
 // eslint-disable-next-line no-control-regex