@prowise/eslint-config-linting-rules 2.1.7 → 2.2.0

package/front-react.js

@@ -1,5 +1,6 @@
 import globals from "globals";
 import base from "./base.js";
+import jsx from "./rules/jsx-pascal-case-rule.js";
 import react from "./rules/plugin-react-rules.js";
 import typescript from "./rules/plugin-typescript-rules.js";
 import vitest from "./rules/plugin-vitest-rules.js";
@@ -10,7 +11,7 @@ export default [
     react,
     vitest,
     {
-        plugins: { "@typescript-eslint": typescript.plugins["@typescript-eslint"] },
+        plugins: { "@typescript-eslint": typescript.plugins["@typescript-eslint"], jsx },
         settings: { react: { version: "detect" } },
         languageOptions: {
             globals: {
@@ -21,22 +22,12 @@ export default [
         },
         rules: {
             "style/quote-props": ["error", "as-needed", { keywords: false, unnecessary: true, numbers: false }],
-            // override the default typescript rule to allow PascalCase function names for function components in React
             "@typescript-eslint/naming-convention": [
                 "error",
-                {
-                    selector: "variable",
-                    format: ["camelCase", "PascalCase", "UPPER_CASE"],
-                },
-                {
-                    selector: "function",
-                    format: ["camelCase", "PascalCase"],
-                },
-                {
-                    selector: "typeLike",
-                    format: ["PascalCase"],
-                },
+                { selector: "variable", format: ["camelCase", "PascalCase", "UPPER_CASE"] },
+                { selector: "typeLike", format: ["PascalCase"] },
             ],
+            "jsx/jsx-element-pascal-case": "error",
         },
     },
 ];

package/next.js

@@ -1,5 +1,6 @@
 import globals from "globals";
 import base from "./base.js";
+import jsx from "./rules/jsx-pascal-case-rule.js";
 import next from "./rules/plugin-next-rules.js";
 import react from "./rules/plugin-react-rules.js";
 import typescript from "./rules/plugin-typescript-rules.js";
@@ -12,6 +13,7 @@ export default [
     next,
     vitest,
     {
+        plugins: { "@typescript-eslint": typescript.plugins["@typescript-eslint"], jsx },
         settings: { react: { version: "detect" } },
         languageOptions: {
             globals: {
@@ -23,22 +25,12 @@ export default [
         },
         rules: {
             "style/quote-props": ["error", "as-needed", { keywords: false, unnecessary: true, numbers: false }],
-            // override the default typescript rule to allow PascalCase function names for function components in React
             "@typescript-eslint/naming-convention": [
                 "error",
-                {
-                    selector: "variable",
-                    format: ["camelCase", "PascalCase", "UPPER_CASE"],
-                },
-                {
-                    selector: "function",
-                    format: ["camelCase", "PascalCase"],
-                },
-                {
-                    selector: "typeLike",
-                    format: ["PascalCase"],
-                },
+                { selector: "variable", format: ["camelCase", "PascalCase", "UPPER_CASE"] },
+                { selector: "typeLike", format: ["PascalCase"] },
             ],
+            "jsx/jsx-element-pascal-case": "error",
         },
     },
 ];

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"2.1.7","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js","./next":"./next.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@next/eslint-plugin-next":"^15.1.3","@stylistic/eslint-plugin":"^2.12.1","confusing-browser-globals":"^1.0.11","eslint":"^9.17.0","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-file-progress":"^3.0.1","eslint-plugin-import-x":"^4.6.1","eslint-plugin-jest":"^28.10.0","eslint-plugin-jsdoc":"^50.6.1","eslint-plugin-jsx-a11y":"^6.10.2","eslint-plugin-n":"^17.15.1","eslint-plugin-prefer-arrow-functions":"^3.4.1","eslint-plugin-react":"^7.37.3","eslint-plugin-react-hooks":"^5.1.0","eslint-plugin-solid":"^0.14.5","eslint-plugin-vitest":"^0.5.4","globals":"^15.14.0","typescript-eslint":"^8.19.1"},"devDependencies":{"@eslint/config-inspector":"^0.7.0"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"2.2.0","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js","./next":"./next.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@next/eslint-plugin-next":"^15.1.7","@stylistic/eslint-plugin":"^4.1.0","confusing-browser-globals":"^1.0.11","eslint":"^9.21.0","eslint-import-resolver-typescript":"^3.8.3","eslint-plugin-file-progress":"^3.0.1","eslint-plugin-import-x":"^4.6.1","eslint-plugin-jsdoc":"^50.6.3","eslint-plugin-jsx-a11y":"^6.10.2","eslint-plugin-n":"^17.15.1","eslint-plugin-prefer-arrow-functions":"^3.6.2","eslint-plugin-react":"^7.37.4","eslint-plugin-react-hooks":"^5.1.0","eslint-plugin-solid":"^0.14.5","eslint-plugin-vitest":"^0.5.4","globals":"^16.0.0","typescript-eslint":"^8.25.0"},"devDependencies":{"@eslint/config-inspector":"^1.0.0"}}

package/rules/jsx-pascal-case-rule.js

@@ -0,0 +1,51 @@
+/* eslint-disable jsdoc/require-jsdoc */
+const jsxElementRule = {
+    meta: {
+        type: "stylistic",
+        docs: { description: "Enforce PascalCase for any function which returns a JSX element" },
+        schema: [],
+    },
+
+    create: (context) => {
+        function isJSX(node) {
+            return node && node.type === "JSXElement";
+        }
+
+        function isPascalCase(name) {
+            return /^[A-Z][a-zA-Z0-9]*$/.test(name) &&
+                // allow exceptions for the following names
+                !["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"].includes(name);
+        }
+
+        function checkFunction(node) {
+            if (!node.id || !node.id.name) return;
+            const functionName = node.id.name;
+            const returnStatement = node.body.body.find((stmt) => stmt.type === "ReturnStatement");
+
+            if (!isJSX(returnStatement?.argument) && isPascalCase(functionName)) {
+                context.report({ node, message: `Function-name "${functionName}" must be camelCase` });
+            }
+
+            if (isJSX(returnStatement?.argument) && !isPascalCase(functionName)) {
+                context.report({ node, message: `JSX element-name "${functionName}" must be PascalCase` });
+            }
+        }
+
+        return {
+            FunctionDeclaration: checkFunction,
+            ArrowFunctionExpression: (node) => {
+                if (node.parent.type === "VariableDeclarator") {
+                    const functionName = node.parent.id.name;
+                    if (!isJSX(node.body) && isPascalCase(functionName)) {
+                        context.report({ node, message: `Function-name "${functionName}" must be camelCase` });
+                    }
+                    if (isJSX(node.body) && !isPascalCase(functionName)) {
+                        context.report({ node, message: `JSX element-name "${functionName}" must be PascalCase` });
+                    }
+                }
+            },
+        };
+    },
+};
+
+export default { rules: { "jsx-element-pascal-case": jsxElementRule } };

package/rules/plugin-react-rules.js

@@ -661,7 +661,7 @@ export default {
          * Enforce PascalCase for user-defined JSX components
          * https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md.
          */
-        "react/jsx-pascal-case": ["error", { allowAllCaps: true, allowNamespace: true, ignore: [] }],
+        // "react/jsx-pascal-case": ["error", { allowAllCaps: true, allowNamespace: true, ignore: [] }],
 
         /**
          * Disallow multiple spaces between inline JSX props 🔧

package/rules/plugin-jest-rules.js

@@ -1,66 +0,0 @@
-import jestPlugin from "eslint-plugin-jest";
-import globals from "globals";
-import { commonRules } from "./test-rules.js";
-
-export default {
-    plugins: { jest: jestPlugin },
-
-    languageOptions: {
-        globals: {
-            process: true,
-            ...globals.jest,
-        },
-    },
-
-    rules: {
-        ...commonRules("jest"),
-
-        /**
-         * Disallow confusing usages of jest.setTimeout
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-confusing-set-timeout.md
-         */
-        // "jest/no-confusing-set-timeout": "off",
-
-        /**
-         * Disallow use of deprecated functions ✅ 🔧
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-deprecated-functions.md
-         */
-        "jest/no-deprecated-functions": "error",
-
-        /**
-         * Disallow using a callback in asynchronous tests and hooks ✅
-         * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-done-callback.md
-         */
-        "jest/no-done-callback": "warn",
-
-        /**
-         * Disallow using exports in files containing tests ✅
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-export.md
-         */
-        "jest/no-export": "error",
-
-        /**
-         * Disallow Jasmine globals ✅ 🔧
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-jasmine-globals.md
-         */
-        "jest/no-jasmine-globals": "error",
-
-        /**
-         * Disallow specific jest. methods
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-restricted-jest-methods.md
-         */
-        // "jest/no-restricted-jest-methods": "off",
-
-        /**
-         * Disallow using jest.mock() factories without an explicit type parameter
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-untyped-mock-factory.md
-         */
-        // "jest/no-untyped-mock-factory": "off",
-
-        /**
-         * Require promises that have expectations in their chain to be valid ✅
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect-in-promise.md
-         */
-        "jest/valid-expect-in-promise": "error",
-    },
-};