@singlepixellab/eslint-config 1.0.2 → 1.2.0

package/eslint.config.js

@@ -11,8 +11,6 @@ export default [
   // Global ignores should always be first
   ...ignores,
 
-  ...core,
-
   // styles: @stylistic/eslint-plugin
   ...styles,
 
@@ -25,6 +23,8 @@ export default [
   // eslint-plugin-react, eslint-plugin-react-hooks etc
   ...react,
 
+  ...core,
+
   // Prettier should be last to have the opportunity to override other configs
   ...prettier,
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singlepixellab/eslint-config",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "The ESLint rules and configs used by Single Pixel Lab",
   "author": "Single Pixel Lab",
   "keywords": [
@@ -32,7 +32,7 @@
     "inspect": "eslint --inspect-config"
   },
   "devDependencies": {
-    "@singlepixellab/prettier-config": "^1.0.0",
+    "@singlepixellab/prettier-config": "^1.1.0",
     "eslint": "^9.32.0",
     "prettier": "^3.6.2"
   },
@@ -41,7 +41,7 @@
     "@stylistic/eslint-plugin": "^5.2.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsdoc": "^51.4.1",
+    "eslint-plugin-jsdoc": "^52.0.2",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-prettier": "^5.5.3",
     "eslint-plugin-react": "^7.37.5",

package/rules/core.js

@@ -44,6 +44,9 @@ export default [
       // Require return statements for all code paths to avoid undefined returns
       "consistent-return": "error",
 
+      // Enforce consistent brace style for all control statements
+      "curly": ["error", "multi-line"],
+
       // Enforce calling super() in constructors to ensure proper initialization
       "constructor-super": "error",
 
@@ -266,6 +269,9 @@ export default [
       // Disallow unused labels to prevent dead code
       "no-extra-label": "error",
 
+      // Disallow assignments to native objects or read-only global variables
+      "no-global-assign": "error",
+
       // Disallow fallthroughs in `switch` to avoid bugs
       "no-fallthrough": "error",
 
@@ -522,8 +528,10 @@ export default [
       // Disallow initializing variables to undefined to avoid redundancy
       "no-undef-init": "error",
 
-      // Disallow use of undefined variable to prevent bugs
-      "no-undefined": "error",
+      // Disallow use of undefined variable to prevent bugs,
+      // we  use the no-global-assign and no-shadow-restricted-names rules to
+      // prevent undefined from being shadowed or assigned a different value
+      "no-undefined": "off",
 
       // Disallow dangling underscores in identifiers
       "no-underscore-dangle": [

package/rules/imports.js

@@ -103,13 +103,7 @@ export default [
 
       // Flags modules with exports that are unused or missing, helps maintain
       // clean and efficient code
-      "import/no-unused-modules": [
-        "error",
-        {
-          unusedExports: true,
-          missingExports: true,
-        },
-      ],
+      "import/no-unused-modules": "off",
 
       // Prevents mixing CommonJS-style exports with `import`, ensures
       // consistency in module style

package/rules/react.js

@@ -29,9 +29,26 @@ export default [
       ...reactPlugin.configs.flat["jsx-runtime"].rules,
       ...jsxA11y.flatConfigs.recommended.rules,
 
+      // Disallow usage of button elements without an explicit type attribute
+      "react/button-has-type": "error",
+
       // Prevent missing displayName in a React component definition
       "react/display-name": ["off", { ignoreTranspilerName: false }],
 
+      // Enforce arrow function type for function components, ensures
+      // consistency and avoids confusion between class and function components
+      "react/function-component-definition": [
+        "error",
+        {
+          namedComponents: "arrow-function",
+          unnamedComponents: "arrow-function",
+        },
+      ],
+
+      // Ensure destructuring and symmetric naming of useState hook value and
+      // setter variables
+      "react/hook-use-state": ["warn", { allowDestructuredState: true }],
+
       // Enforce boolean attributes notation in JSX
       "react/jsx-boolean-value": ["error", "never", { always: [] }],
 
@@ -48,7 +65,14 @@ export default [
       ],
 
       // Enforce or disallow spaces around equal sign
-      "react/jsx-equals-spacing": ["error", "always"],
+      "react/jsx-equals-spacing": ["warn", "never"],
+
+      // No jsx extension
+      // https://github.com/facebook/create-react-app/issues/87#issuecomment-234627904
+      "react/jsx-filename-extension": ["error", { extensions: [".js"] }],
+
+      // Enforce shorthand or standard form for React fragments
+      "react/jsx-fragments": ["warn", "syntax"],
 
       // Disable event handler naming conventions in JSX
       "react/jsx-handler-names": "off",
@@ -74,50 +98,35 @@ export default [
         },
       ],
 
+      // Disallows JSX context provider values from taking values that will
+      // cause needless rerenders
+      "react/jsx-no-constructed-context-values": "error",
+
+      // Disallow usage of javascript: URLs
+      "react/jsx-no-script-url": [
+        "error",
+        [
+          {
+            name: "Link",
+            props: ["href", "to"],
+          },
+        ],
+      ],
+
       // Prevent usage of unwrapped JSX strings
       "react/jsx-no-literals": "off",
 
+      // Disallow unnecessary fragments
+      "react/jsx-no-useless-fragment": "warn",
+
       // Enforce PascalCase for JSX components
       "react/jsx-pascal-case": ["error", { allowAllCaps: true }],
 
-      // Disable props sorting
-      "react/jsx-sort-props": "off",
-
-      // [Deprecated] Disable defaultProps declarations sorting
-      "react/jsx-sort-default-props": "off",
-
-      // No jsx extension
-      // https://github.com/facebook/create-react-app/issues/87#issuecomment-234627904
-      "react/jsx-filename-extension": ["error", { extensions: [".js"] }],
-
-      // This is no longer needed since React 17+ with the new JSX transform
-      // https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
-      "react/react-in-jsx-scope": "off",
-
-      // React 18.3.0 deprecated defaultProps for function components
-      // https://github.com/facebook/react/pull/25699
-      "react/require-default-props": "off",
-
-      // We recommend using TypeScript instead of checking prop types at runtime
-      // https://react.dev/reference/react/Component#static-proptypes
-      "react/prop-types": "off",
-
-      // Enforce arrow function type for function components, ensures
-      // consistency and avoids confusion between class and function components
-      "react/function-component-definition": [
-        "error",
-        {
-          namedComponents: "arrow-function",
-          unnamedComponents: "arrow-function",
-        },
-      ],
-
       // Allow prop spreading to enable flexible and reusable components
       "react/jsx-props-no-spreading": "off",
 
-      // Allow unescaped entities in JSX (e.g., apostrophes), prevents noise for
-      // common text content in JSX
-      "react/no-unescaped-entities": "off",
+      // Disallow usage of Array index in keys
+      "react/no-array-index-key": "error",
 
       // Allow use of `dangerouslySetInnerHTML`, needed in some cases and
       // the responsibility lies with the developer
@@ -132,9 +141,34 @@ export default [
       // Prevent usage of setState
       "react/no-set-state": "off",
 
+      // Allow unescaped entities in JSX (e.g., apostrophes), prevents noise for
+      // common text content in JSX
+      "react/no-unescaped-entities": "off",
+
       // Require ES6 class declarations over React.createClass
       "react/prefer-es6-class": ["error", "always"],
 
+      // We recommend using TypeScript instead of checking prop types at runtime
+      // https://react.dev/reference/react/Component#static-proptypes
+      "react/prop-types": "off",
+
+      // This is no longer needed since React 17+ with the new JSX transform
+      // https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
+      "react/react-in-jsx-scope": "off",
+
+      // React 18.3.0 deprecated defaultProps for function components
+      // https://github.com/facebook/react/pull/25699
+      "react/require-default-props": "off",
+
+      // Disallow extra closing tags for components without children
+      "react/self-closing-comp": [
+        "error",
+        {
+          component: true,
+          html: true,
+        },
+      ],
+
       // Enforce that all elements that require alternative text have meaningful
       // information
       "jsx-a11y/alt-text": [

package/rules/styles.js

@@ -64,7 +64,7 @@ export default [
       "@stylistic/function-call-argument-newline": ["warn", "consistent"],
 
       // Enforce consistent line breaks inside function parentheses
-      "@stylistic/function-paren-newline": ["warn", "multiline-arguments"],
+      "@stylistic/function-paren-newline": "off",
 
       // Enforce consistent spacing around `*` operators in generator functions
       "@stylistic/generator-star-spacing": [
@@ -73,7 +73,7 @@ export default [
       ],
 
       // Enforce the location of arrow function bodies
-      "@stylistic/implicit-arrow-linebreak": ["warn", "beside"],
+      "@stylistic/implicit-arrow-linebreak": "off",
 
       // Enforce consistent indentation
       "@stylistic/indent": [
@@ -170,10 +170,7 @@ export default [
       ],
 
       // Require one JSX element per line
-      "@stylistic/jsx-one-expression-per-line": [
-        "warn",
-        { allow: "single-child" },
-      ],
+      "@stylistic/jsx-one-expression-per-line": "off",
 
       // Enforce PascalCase for user-defined JSX components
       "@stylistic/jsx-pascal-case": "warn",
@@ -214,7 +211,7 @@ export default [
           condition: "parens-new-line",
           declaration: "parens-new-line",
           logical: "parens-new-line",
-          prop: "parens-new-line",
+          prop: "ignore",
           propertyValue: "parens-new-line",
           return: "parens-new-line",
         },
@@ -272,7 +269,7 @@ export default [
           code: 80,
           tabWidth: 2,
           ignoreUrls: true,
-          ignoreComments: false,
+          ignoreComments: true,
           ignoreRegExpLiterals: true,
           ignoreStrings: true,
           ignoreTemplateLiterals: true,
@@ -370,31 +367,7 @@ export default [
       ],
 
       // Enforce consistent line breaks after opening and before closing braces
-      "@stylistic/object-curly-newline": [
-        "warn",
-        {
-          ObjectExpression: {
-            minProperties: 4,
-            multiline: true,
-            consistent: true,
-          },
-          ObjectPattern: {
-            minProperties: 4,
-            multiline: true,
-            consistent: true,
-          },
-          ImportDeclaration: {
-            minProperties: 4,
-            multiline: true,
-            consistent: true,
-          },
-          ExportDeclaration: {
-            minProperties: 4,
-            multiline: true,
-            consistent: true,
-          },
-        },
-      ],
+      "@stylistic/object-curly-newline": "off",
 
       // Enforce consistent spacing inside braces
       "@stylistic/object-curly-spacing": ["warn", "always"],
@@ -413,8 +386,14 @@ export default [
       // Enforce consistent linebreak style for operators
       "@stylistic/operator-linebreak": [
         "warn",
-        "before",
-        { overrides: { "=": "none" } },
+        "after",
+        {
+          overrides: {
+            "=": "ignore",
+            "?": "before",
+            ":": "before",
+          },
+        },
       ],
 
       // Require or disallow padding within blocks

package/.eslintrc

@@ -1,3 +0,0 @@
-// This empty file is added because of an issue with eslint-plugin-import,
-// remove it when the below issue is fixed
-// https://github.com/import-js/eslint-plugin-import/issues/3079