@elementx-ai/eslint-config 7.2.2 → 8.0.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 This repository adheres to semantic versioning and follows the conventions of [keepachangelog.com](http://keepachangelog.com)
 
+## [8.0.1](https://github.com/elementx-ai/eslint-config/compare/v8.0.0...v8.0.1) (2025-01-08)
+
+
+### Bug Fixes
+
+* Update README ([#29](https://github.com/elementx-ai/eslint-config/issues/29)) ([b356bc7](https://github.com/elementx-ai/eslint-config/commit/b356bc7ed3e5df0f2c59815bf7b2d60ed79a481d))
+
+## [8.0.0](https://github.com/elementx-ai/eslint-config/compare/v7.2.2...v8.0.0) (2025-01-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* Upgrade eslint-config to use new flat file configuration structure ([#27](https://github.com/elementx-ai/eslint-config/issues/27))
+
+### Features
+
+* Upgrade eslint-config to use new flat file configuration structure ([#27](https://github.com/elementx-ai/eslint-config/issues/27)) ([8d27e29](https://github.com/elementx-ai/eslint-config/commit/8d27e29196e4e1d480672d0949334346a64f8a48))
+
 ## [7.2.2](https://github.com/elementx-ai/eslint-config/compare/v7.2.1...v7.2.2) (2025-01-05)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # ElementX's Eslint Config
 
-This package provides ElementX's .eslintrc.yaml as an extensible [shared config](https://eslint.org/docs/developer-guide/shareable-configs) :sparkles:
+This package provides ElementX's eslint config as an extensible [shared config](https://eslint.org/docs/developer-guide/shareable-configs) :sparkles:
 
 ## Install and Setup
 
@@ -12,11 +12,21 @@ npm i -D eslint @elementx-ai/eslint-config
 
 ## Usage
 
-Create a `.eslintrc.yaml` file in the root of the repo you are working on and extend the preset/config you wish to use
+Create a `eslint.config.js` file in the root of the repo you are working on and import the config you wish to use
 
-e.g. using the `typescript` linting rules (additional rules can be added to this `extends` list)
+e.g. using the `ts` linting rules (additional rules can be added to the array)
 
-```yaml
-extends:
-  - "@elementx-ai/eslint-config/configs/typescript"
+```js
+// eslint.config.js
+import ts from "@elementx-ai/eslint-config/configs/ts";
+
+export default [
+    ...ts,
+    // anything from here will override myconfig
+    {
+        rules: {
+            "no-unused-vars": "warn"
+        }
+    }
+];
 ```

package/configs/js.js

@@ -0,0 +1,5 @@
+import common from "../lib/common.js";
+
+export default [
+  ...common,
+];

package/configs/jsx.js

@@ -0,0 +1,4 @@
+import common from "../lib/common";
+import react from "../lib/react.js";
+
+export default [...common, ...react];

package/configs/ts.js

@@ -0,0 +1,7 @@
+import common from "../lib/common.js";
+import typescript from "../lib/typescript.js";
+
+export default [
+  ...common,
+  ...typescript,
+];

package/configs/tsx.js

@@ -0,0 +1,5 @@
+import common from "../lib/common.js";
+import react from "../lib/react.js";
+import typescript from "../lib/typescript.js";
+
+export default [...common, ...typescript, ...react];

package/eslint.config.js

@@ -0,0 +1,16 @@
+import importPlugin from "eslint-plugin-import";
+
+import config from "./index.js";
+
+export default [
+  ...config,
+  {
+    plugins: {
+      "import": importPlugin,
+    },
+    rules: {
+      "import/no-default-export": "off",
+      "import/prefer-default-export": ["error", { target: "any" }],
+    },
+  },
+];

package/index.js

@@ -1,3 +1,5 @@
-module.exports = {
-    "extends": [ "./configs/node" ],
-};
+import node from "./configs/js.js";
+
+export default [
+  ...node,
+];

package/lib/common.js

@@ -1,116 +1,127 @@
-module.exports = {
-  extends: ["eslint:recommended"],
-  env: {
-    node: true,
-    es6: true,
-    mocha: true,
-  },
-  plugins: ["prefer-arrow", "import"],
-  rules: {
-    complexity: ["error", 10],
-    eqeqeq: ["error", "smart"],
-    quotes: ["error", "double", { allowTemplateLiterals: true }],
-    curly: ["error", "all"],
-    "linebreak-style": ["error", "unix"],
-    "brace-style": ["error", "1tbs"],
-    "eol-last": ["error", "always"],
-    "space-in-parens": ["error", "never"],
-    "no-multi-spaces": ["error"],
-    "no-trailing-spaces": ["error"],
-    "object-curly-spacing": ["error", "always"],
-    "array-bracket-spacing": ["error", "never"],
-    "space-before-blocks": ["error"],
-    "import/no-default-export": "error",
-    "arrow-body-style": ["error", "as-needed"],
-    "no-return-await": ["error"],
-    "default-case-last": ["error"],
-    "no-console": "off",
-    "linebreak-style": "off",
-    "no-multiple-empty-lines": ["error", { max: 1, maxBOF: 0, maxEOF: 0 }],
-    "comma-spacing": ["error", { before: false, after: true }],
-    "generator-star-spacing": ["error", { before: false, after: true }],
-    "arrow-spacing": ["error", { before: true, after: true }],
-    "keyword-spacing": ["error", { before: true, after: true }],
-    indent: [
-      "error",
-      2,
-      {
-        SwitchCase: 1,
-      },
-    ],
-    semi: ["error", "always"],
-    "prefer-const": [
-      "error",
-      {
-        destructuring: "all",
-      },
-    ],
-    "max-lines": [
-      "error",
-      {
-        max: 600,
-        skipBlankLines: true,
-        skipComments: true,
-      },
-    ],
-    "max-len": [
-      "error",
-      {
-        code: 120,
-        ignoreComments: true,
-        ignoreTrailingComments: true,
-        ignoreUrls: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-        ignoreRegExpLiterals: true,
-      },
-    ],
-    "space-before-function-paren": [
-      "error",
-      {
-        anonymous: "never",
-        named: "never",
-        asyncArrow: "always",
-      },
-    ],
-    "comma-dangle": [
-      "error",
-      {
-        arrays: "always-multiline",
-        objects: "always-multiline",
-        imports: "always-multiline",
-        exports: "always-multiline",
-        functions: "never",
-      },
-    ],
-    "prefer-arrow/prefer-arrow-functions": [
-      "error",
-      {
-        disallowPrototype: true,
-        singleReturnOnly: false,
-        classPropertiesAllowed: false,
-      },
-    ],
-    "prefer-arrow-callback": [
-      "error",
-      {
-        allowNamedFunctions: true,
-      },
-    ],
-    "func-style": [
-      "error",
-      "expression",
-      {
-        allowArrowFunctions: true,
-      },
-    ],
-    "import/order": [
-      "error",
-      {
-        "newlines-between": "always",
-        groups: ["external", "builtin", "internal", "sibling", "parent", "index"],
+import eslint from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import _import from "eslint-plugin-import";
+import preferArrow from "eslint-plugin-prefer-arrow";
+import globals from "globals";
+
+export default [
+  eslint.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
       },
-    ],
-    "padded-blocks": ["error", "never"],
+    },
+    plugins: {
+      "prefer-arrow": preferArrow,
+      "import": _import,
+      "@stylistic": stylistic,
+    },
+    rules: {
+      "complexity": ["error", 10],
+      "eqeqeq": ["error", "smart"],
+      "quotes": ["error", "double", { allowTemplateLiterals: true }],
+      "curly": ["error", "all"],
+      "brace-style": ["error", "1tbs"],
+      "eol-last": ["error", "always"],
+      "space-in-parens": ["error", "never"],
+      "no-multi-spaces": ["error"],
+      "no-trailing-spaces": ["error"],
+      "object-curly-spacing": ["error", "always"],
+      "array-bracket-spacing": ["error", "never"],
+      "space-before-blocks": ["error"],
+      "import/no-default-export": "error",
+      "arrow-body-style": ["error", "as-needed"],
+      "no-return-await": ["error"],
+      "default-case-last": ["error"],
+      "no-console": "off",
+      "no-multiple-empty-lines": ["error", { max: 1, maxBOF: 0, maxEOF: 0 }],
+      "comma-spacing": ["error", { before: false, after: true }],
+      "generator-star-spacing": ["error", { before: false, after: true }],
+      "arrow-spacing": ["error", { before: true, after: true }],
+      "keyword-spacing": ["error", { before: true, after: true }],
+      "indent": [
+        "error",
+        2,
+        {
+          SwitchCase: 1,
+        },
+      ],
+      "@stylistic/semi": ["error", "always"],
+      "prefer-const": [
+        "error",
+        {
+          destructuring: "all",
+        },
+      ],
+      "max-lines": [
+        "error",
+        {
+          max: 600,
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+      "max-len": [
+        "error",
+        {
+          code: 120,
+          ignoreComments: true,
+          ignoreTrailingComments: true,
+          ignoreUrls: true,
+          ignoreStrings: true,
+          ignoreTemplateLiterals: true,
+          ignoreRegExpLiterals: true,
+        },
+      ],
+      "space-before-function-paren": [
+        "error",
+        {
+          anonymous: "never",
+          named: "never",
+          asyncArrow: "always",
+        },
+      ],
+      "comma-dangle": [
+        "error",
+        {
+          arrays: "always-multiline",
+          objects: "always-multiline",
+          imports: "always-multiline",
+          exports: "always-multiline",
+          functions: "never",
+        },
+      ],
+      "prefer-arrow/prefer-arrow-functions": [
+        "error",
+        {
+          disallowPrototype: true,
+          singleReturnOnly: false,
+          classPropertiesAllowed: false,
+        },
+      ],
+      "prefer-arrow-callback": [
+        "error",
+        {
+          allowNamedFunctions: true,
+        },
+      ],
+      "func-style": [
+        "error",
+        "expression",
+        {
+          allowArrowFunctions: true,
+        },
+      ],
+      "import/order": [
+        "error",
+        {
+          "newlines-between": "always",
+          groups: ["external", "builtin", "internal", "sibling", "parent", "index"],
+        },
+      ],
+      "padded-blocks": ["error", "never"],
+    },
   },
-};
+];

package/lib/react.js

@@ -0,0 +1,18 @@
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+
+export default [
+  {
+    plugins: {
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
+    },
+  },
+];

package/lib/typescript.js

@@ -1,99 +1,108 @@
-module.exports = {
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    project: "tsconfig.json",
-    sourceType: "module",
-  },
-  plugins: ["@typescript-eslint"],
-  rules: {
-    "@typescript-eslint/prefer-namespace-keyword": ["error"],
-    "@typescript-eslint/no-unused-vars": ["error"],
-    "@typescript-eslint/semi": ["error", "always"],
-    "@typescript-eslint/type-annotation-spacing": ["error"],
-    "@typescript-eslint/no-undef": "off",
-    "@typescript-eslint/indent": [
-      "error",
-      2,
-      {
-        SwitchCase: 1,
+import stylistic from "@stylistic/eslint-plugin";
+import typescript from "@typescript-eslint/eslint-plugin";
+import parser from "@typescript-eslint/parser";
+
+export default [
+  {
+    languageOptions: {
+      parser: parser,
+      parserOptions: {
+        projectService: true,
       },
-    ],
-    "@typescript-eslint/member-delimiter-style": [
-      "error",
-      {
-        multiline: {
-          delimiter: "semi",
-          requireLast: true,
+    },
+    plugins: {
+      "@stylistic": stylistic,
+      "@typescript-eslint": typescript,
+    },
+    rules: {
+      "@stylistic/type-annotation-spacing": ["error"],
+      "@stylistic/indent": [
+        "error",
+        2,
+        {
+          SwitchCase: 1,
         },
-        singleline: {
-          delimiter: "semi",
-          requireLast: false,
+      ],
+      "@stylistic/member-delimiter-style": [
+        "error",
+        {
+          multiline: {
+            delimiter: "semi",
+            requireLast: true,
+          },
+          singleline: {
+            delimiter: "semi",
+            requireLast: false,
+          },
         },
-      },
-    ],
-    "@typescript-eslint/naming-convention": [
-      "error",
-      {
-        selector: ["default"],
-        format: ["camelCase"],
-        leadingUnderscore: "allow",
-      },
-      {
-        selector: "import",
-        format: ["camelCase", "PascalCase"],
-      },
-      {
-        selector: ["typeLike", "enumMember"],
-        format: ["PascalCase"],
-      },
-      {
-        selector: ["parameter"],
-        modifiers: ["destructured"],
-        format: null,
-      },
-      {
-        selector: ["property", "objectLiteralProperty"],
-        format: null,
-      },
-      {
-        selector: [
-          "classProperty",
-          "objectLiteralProperty",
-          "typeProperty",
-          "classMethod",
-          "objectLiteralMethod",
-          "typeMethod",
-          "accessor",
-          "enumMember",
-        ],
-        modifiers: ["requiresQuotes"],
-        format: null,
-      },
-      {
-        selector: ["variable"],
-        modifiers: ["const"],
-        types: ["function"],
-        format: ["camelCase", "PascalCase"],
-        leadingUnderscore: "allow",
-      },
-      {
-        selector: ["variable"],
-        modifiers: ["destructured"],
-        format: null,
-      },
-      {
-        selector: ["variable"],
-        modifiers: ["const"],
-        types: ["boolean", "string", "number", "array"],
-        format: ["camelCase", "UPPER_CASE"],
-        leadingUnderscore: "allow",
-      },
-      {
-        selector: ["memberLike"],
-        modifiers: ["private"],
-        format: ["camelCase"],
-        leadingUnderscore: "require",
-      },
-    ],
+      ],
+      "@typescript-eslint/prefer-namespace-keyword": ["error"],
+      "@typescript-eslint/no-unused-vars": ["error"],
+      "@typescript-eslint/no-undef": "off",
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          selector: ["default"],
+          format: ["camelCase"],
+          leadingUnderscore: "allow",
+        },
+        {
+          selector: "import",
+          format: ["camelCase", "PascalCase"],
+        },
+        {
+          selector: ["typeLike", "enumMember"],
+          format: ["PascalCase"],
+        },
+        {
+          selector: ["parameter"],
+          modifiers: ["destructured"],
+          format: null,
+        },
+        {
+          selector: ["property", "objectLiteralProperty"],
+          format: null,
+        },
+        {
+          selector: [
+            "classProperty",
+            "objectLiteralProperty",
+            "typeProperty",
+            "classMethod",
+            "objectLiteralMethod",
+            "typeMethod",
+            "accessor",
+            "enumMember",
+          ],
+          modifiers: ["requiresQuotes"],
+          format: null,
+        },
+        {
+          selector: ["variable"],
+          modifiers: ["const"],
+          types: ["function"],
+          format: ["camelCase", "PascalCase"],
+          leadingUnderscore: "allow",
+        },
+        {
+          selector: ["variable"],
+          modifiers: ["destructured"],
+          format: null,
+        },
+        {
+          selector: ["variable"],
+          modifiers: ["const"],
+          types: ["boolean", "string", "number", "array"],
+          format: ["camelCase", "UPPER_CASE"],
+          leadingUnderscore: "allow",
+        },
+        {
+          selector: ["memberLike"],
+          modifiers: ["private"],
+          format: ["camelCase"],
+          leadingUnderscore: "require",
+        },
+      ],
+    },
   },
-};
+];

package/package.json

@@ -1,27 +1,35 @@
 {
   "name": "@elementx-ai/eslint-config",
-  "version": "7.2.2",
+  "version": "8.0.1",
   "description": "ElementX's ESLint Config",
   "license": "Unlicense",
   "repository": {
     "type": "git",
-    "url": "https://github.com/spark-64/eslint-config"
+    "url": "https://github.com/elementx-ai/eslint-config"
   },
   "bugs": {
-    "url": "https://github.com/spark-64/eslint-config/issues"
+    "url": "https://github.com/elementx-ai/eslint-config/issues"
   },
   "keywords": [
     "eslint",
-    "eslintconfig"
+    "eslintconfig",
+    "eslint-config"
   ],
   "main": "index.js",
+  "type": "module",
   "dependencies": {
+    "@stylistic/eslint-plugin": "^2.12.1",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prefer-arrow": "^1.2.3"
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.16"
   },
   "peerDependencies": {
-    "eslint": "^8.57.1",
-    "@typescript-eslint/eslint-plugin": "^8.19.0",
-    "@typescript-eslint/parser": "^8.19.0"
+    "eslint": "^9.17.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.17.0"
   }
 }

package/configs/node.js

@@ -1,5 +0,0 @@
-module.exports = {
-  extends: [
-    "../lib/common.js",
-  ],
-};

package/configs/typescript.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: [
-    "../lib/common.js",
-    "../lib/typescript",
-  ],
-};