@kyh/eslint-config 0.1.9 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,67 @@
+# @kyh/eslint-config
+
+## 1.0.1
+
+### Patch Changes
+
+- update gitignore location
+
+## 1.0.0
+
+### Major Changes
+
+- update to eslint 9
+
+## 0.1.9
+
+### Patch Changes
+
+- update packages
+
+## 0.1.8
+
+### Patch Changes
+
+- update tsconfig
+
+## 0.1.7
+
+### Patch Changes
+
+- update packages, split up tsconfig
+
+## 0.1.6
+
+### Patch Changes
+
+- update packages, allow usage in non monorepos
+
+## 0.1.5
+
+### Patch Changes
+
+- update packages
+
+## 0.1.4
+
+### Patch Changes
+
+- update deps
+
+## 0.1.3
+
+### Patch Changes
+
+- remove hardcoded prettier import name
+
+## 0.1.2
+
+### Patch Changes
+
+- update prettier path
+
+## 0.1.1
+
+### Patch Changes
+
+- bump to latest

package/base.js

@@ -1,62 +1,87 @@
-/** @type {import("eslint").Linter.Config} */
-const config = {
-  extends: [
-    "turbo",
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended-type-checked",
-    "plugin:@typescript-eslint/stylistic-type-checked",
-  ],
-  env: {
-    es2022: true,
-    node: true,
-  },
-  parser: "@typescript-eslint/parser",
-  parserOptions: { project: true },
-  plugins: ["@typescript-eslint", "import", "prefer-arrow-functions"],
-  rules: {
-    "turbo/no-undeclared-env-vars": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "warn",
-      { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
-    ],
-    "@typescript-eslint/consistent-type-imports": [
-      "warn",
-      { prefer: "type-imports", fixStyle: "separate-type-imports" },
-    ],
-    "import/consistent-type-specifier-style": ["error", "prefer-top-level"],
-    "@typescript-eslint/consistent-type-definitions": ["warn", "type"],
-    "@typescript-eslint/no-misused-promises": [
-      "error",
-      {
-        checksVoidReturn: false,
-      },
-    ],
-    "@typescript-eslint/no-unnecessary-condition": [
-      "error",
-      {
-        allowConstantLoopConditions: true,
-      },
-    ],
-    "@typescript-eslint/no-non-null-assertion": "error",
-    "prefer-arrow-functions/prefer-arrow-functions": [
-      "warn",
-      {
-        classPropertiesAllowed: false,
-        disallowPrototype: false,
-        returnStyle: "unchanged",
-        singleReturnOnly: false,
-      },
-    ],
-  },
-  ignorePatterns: [
-    "**/*.config.js",
-    "**/*.config.cjs",
-    "**/.eslintrc.cjs",
-    ".next",
-    "dist",
-    "pnpm-lock.yaml",
-  ],
-  reportUnusedDisableDirectives: true,
+/// <reference types="./types.d.ts" />
+
+import * as fs from "node:fs";
+import * as path from "node:path";
+import * as url from "node:url";
+import { includeIgnoreFile } from "@eslint/compat";
+import eslint from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
+import turboPlugin from "eslint-plugin-turbo";
+import tseslint from "typescript-eslint";
+
+const __filename = url.fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const fileExists = async (filePath) => {
+  try {
+    await fs.promises.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
 };
 
-module.exports = config;
+const gitignorePath = path.join(__dirname, "../../.gitignore");
+const gitignorePath2 = path.join(__dirname, "../../../.gitignore");
+
+export default tseslint.config(
+  // Ignore files not tracked by VCS and any config files
+  includeIgnoreFile(
+    (await fileExists(gitignorePath))
+      ? gitignorePath
+      : (await fileExists(gitignorePath2))
+        ? gitignorePath2
+        : "",
+  ),
+  { ignores: ["**/*.config.*"] },
+  {
+    files: ["**/*.js", "**/*.ts", "**/*.tsx"],
+    plugins: {
+      import: importPlugin,
+      turbo: turboPlugin,
+    },
+    extends: [
+      eslint.configs.recommended,
+      ...tseslint.configs.recommended,
+      ...tseslint.configs.recommendedTypeChecked,
+      ...tseslint.configs.stylisticTypeChecked,
+    ],
+    rules: {
+      ...turboPlugin.configs.recommended.rules,
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+      ],
+      "@typescript-eslint/consistent-type-imports": [
+        "warn",
+        { prefer: "type-imports", fixStyle: "separate-type-imports" },
+      ],
+      "@typescript-eslint/no-misused-promises": [
+        2,
+        { checksVoidReturn: { attributes: false } },
+      ],
+      "@typescript-eslint/no-unnecessary-condition": [
+        "error",
+        {
+          allowConstantLoopConditions: true,
+        },
+      ],
+      "@typescript-eslint/no-non-null-assertion": "error",
+      "import/consistent-type-specifier-style": ["error", "prefer-top-level"],
+      // "prefer-arrow-functions/prefer-arrow-functions": [
+      //   "warn",
+      //   {
+      //     classPropertiesAllowed: false,
+      //     disallowPrototype: false,
+      //     returnStyle: "unchanged",
+      //     singleReturnOnly: false,
+      //   },
+      // ],
+      "@typescript-eslint/consistent-type-definitions": ["warn", "type"],
+    },
+  },
+  {
+    linterOptions: { reportUnusedDisableDirectives: true },
+    languageOptions: { parserOptions: { projectService: true } },
+  },
+);

package/nextjs.js

@@ -1,17 +1,24 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: ["plugin:@next/next/core-web-vitals"],
-  rules: {
-    "@next/next/no-html-link-for-pages": "off",
-    "@typescript-eslint/require-await": "off",
-    "react/function-component-definition": [
-      "warn",
-      {
-        namedComponents: "arrow-function",
-        unnamedComponents: "arrow-function",
-      },
-    ],
-  },
-};
+import nextPlugin from "@next/eslint-plugin-next";
 
-module.exports = config;
+/** @type {Awaited<import('typescript-eslint').Config>} */
+export default [
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: {
+      "@next/next": nextPlugin,
+    },
+    rules: {
+      ...nextPlugin.configs.recommended.rules,
+      ...nextPlugin.configs["core-web-vitals"].rules,
+      // TypeError: context.getAncestors is not a function
+      "@next/next/no-duplicate-head": "off",
+      "react/function-component-definition": [
+        "warn",
+        {
+          namedComponents: "arrow-function",
+          unnamedComponents: "arrow-function",
+        },
+      ],
+    },
+  },
+];

package/package.json

@@ -1,44 +1,37 @@
 {
   "name": "@kyh/eslint-config",
-  "version": "0.1.9",
+  "version": "1.0.1",
   "publishConfig": {
     "access": "public"
   },
-  "files": [
-    "./base.js",
-    "./nextjs.js",
-    "./react.js"
-  ],
+  "type": "module",
+  "exports": {
+    "./base": "./base.js",
+    "./nextjs": "./nextjs.js",
+    "./react": "./react.js"
+  },
   "dependencies": {
-    "@next/eslint-plugin-next": "^14.2.4",
-    "@typescript-eslint/eslint-plugin": "^7.14.1",
-    "@typescript-eslint/parser": "^7.14.1",
-    "eslint-config-turbo": "^2.0.5",
+    "@eslint/compat": "^1.1.1",
+    "@next/eslint-plugin-next": "^14.2.5",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsx-a11y": "^6.9.0",
     "eslint-plugin-prefer-arrow-functions": "^3.3.2",
-    "eslint-plugin-react": "^7.34.3",
-    "eslint-plugin-react-hooks": "^4.6.2"
+    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-react-hooks": "rc",
+    "eslint-plugin-turbo": "^2.0.12",
+    "typescript-eslint": "^8.0.1"
   },
   "devDependencies": {
-    "@types/eslint": "^8.56.10",
-    "eslint": "^8.57.0",
-    "prettier": "^3.3.2",
-    "typescript": "^5.5.2",
-    "@kyh/prettier-config": "^0.1.9",
-    "@kyh/tsconfig": "^0.1.9"
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "./base.js"
-    ]
+    "eslint": "^9.9.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4",
+    "@kyh/prettier-config": "1.0.1",
+    "@kyh/tsconfig": "1.0.1"
   },
   "prettier": "@kyh/prettier-config",
   "scripts": {
-    "clean": "rm -rf .turbo node_modules",
+    "clean": "git clean -xdf .cache .nitro .output .turbo .vercel node_modules",
     "format": "prettier --check . --ignore-path ../../.gitignore",
-    "lint": "eslint .",
     "typecheck": "tsc --noEmit"
   }
 }

package/react.js

@@ -1,31 +1,29 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: [
-    "plugin:react/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:jsx-a11y/recommended",
-  ],
-  rules: {
-    "react/prop-types": "off",
-    "react/function-component-definition": [
-      "warn",
-      {
-        namedComponents: "arrow-function",
-        unnamedComponents: "arrow-function",
+import reactPlugin from "eslint-plugin-react";
+import hooksPlugin from "eslint-plugin-react-hooks";
+
+/** @type {Awaited<import('typescript-eslint').Config>} */
+export default [
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: {
+      react: reactPlugin,
+      "react-hooks": hooksPlugin,
+    },
+    rules: {
+      ...reactPlugin.configs["jsx-runtime"].rules,
+      ...hooksPlugin.configs.recommended.rules,
+      "react/function-component-definition": [
+        "warn",
+        {
+          namedComponents: "arrow-function",
+          unnamedComponents: "arrow-function",
+        },
+      ],
+    },
+    languageOptions: {
+      globals: {
+        React: "writable",
       },
-    ],
-  },
-  globals: {
-    React: "writable",
-  },
-  settings: {
-    react: {
-      version: "detect",
     },
   },
-  env: {
-    browser: true,
-  },
-};
-
-module.exports = config;
+];

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@kyh/tsconfig/base.json",
+  "include": ["."],
+  "exclude": ["node_modules"]
+}

package/types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Since the ecosystem hasn't fully migrated to ESLint's new FlatConfig system yet,
+ * we "need" to type some of the plugins manually :(
+ */
+
+declare module "@eslint/js" {
+  // Why the hell doesn't eslint themselves export their types?
+  import type { Linter } from "eslint";
+
+  export const configs: {
+    readonly recommended: { readonly rules: Readonly<Linter.RulesRecord> };
+    readonly all: { readonly rules: Readonly<Linter.RulesRecord> };
+  };
+}
+
+declare module "eslint-plugin-import" {
+  import type { Linter, Rule } from "eslint";
+
+  export const configs: {
+    recommended: { rules: Linter.RulesRecord };
+  };
+  export const rules: Record<string, Rule.RuleModule>;
+}
+
+declare module "eslint-plugin-react" {
+  import type { Linter, Rule } from "eslint";
+
+  export const configs: {
+    recommended: { rules: Linter.RulesRecord };
+    all: { rules: Linter.RulesRecord };
+    "jsx-runtime": { rules: Linter.RulesRecord };
+  };
+  export const rules: Record<string, Rule.RuleModule>;
+}
+
+declare module "eslint-plugin-react-hooks" {
+  import type { Linter, Rule } from "eslint";
+
+  export const configs: {
+    recommended: {
+      rules: {
+        "rules-of-hooks": Linter.RuleEntry;
+        "exhaustive-deps": Linter.RuleEntry;
+      };
+    };
+  };
+  export const rules: Record<string, Rule.RuleModule>;
+}
+
+declare module "@next/eslint-plugin-next" {
+  import type { Linter, Rule } from "eslint";
+
+  export const configs: {
+    recommended: { rules: Linter.RulesRecord };
+    "core-web-vitals": { rules: Linter.RulesRecord };
+  };
+  export const rules: Record<string, Rule.RuleModule>;
+}
+
+declare module "eslint-plugin-turbo" {
+  import type { Linter, Rule } from "eslint";
+
+  export const configs: {
+    recommended: { rules: Linter.RulesRecord };
+  };
+  export const rules: Record<string, Rule.RuleModule>;
+}