@xsynaptic/eslint-config 0.0.1

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "xsynaptic"
+  ]
+}

package/eslint.config.ts

@@ -0,0 +1,3 @@
+import { getConfig } from "./src/get-config";
+
+export default getConfig();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@xsynaptic/eslint-config",
+  "version": "0.0.1",
+  "description": "A common ESLint config for some personal projects",
+  "type": "module",
+  "license": "MIT",
+  "main": "./src/get-config.ts",
+  "scripts": {
+    "lint": "eslint",
+    "check-types": "tsc --noEmit --extendedDiagnostics"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "@types/eslint__js": "^8.42.3",
+    "eslint": "^9.19.0",
+    "eslint-plugin-astro": "^1.3.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "globals": "^15.14.0",
+    "jiti": "^2.4.2",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.21.0"
+  },
+  "packageManager": "pnpm@9.15.0+sha512.76e2379760a4328ec4415815bcd6628dee727af3779aaa4c914e3944156c4299921a89f976381ee107d41f12cfa4b66681ca9c718f0668fa0831ed4c6d8ba56c"
+}

package/readme.md

@@ -0,0 +1,3 @@
+# ESLint Config
+
+This is a shared ESLint config for use with several TypeScript projects, most of them related to Astro. It is not intended for public consumption.

package/src/get-config.ts

@@ -0,0 +1,137 @@
+import eslint from "@eslint/js";
+import astroPlugin from "eslint-plugin-astro";
+import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
+import unicornPlugin from "eslint-plugin-unicorn";
+import globals from "globals";
+import tseslint, { ConfigArray } from "typescript-eslint";
+
+export function getConfig(
+  customConfig?: ConfigArray,
+  options?: {
+    customGlobals?: Record<string, "readonly" | "writeable">;
+    withAstro?: boolean;
+  }
+) {
+  const customGlobals = options?.customGlobals ?? {};
+  const withAstro = options?.withAstro ?? false;
+
+  const baseConfig = [
+    eslint.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    ...tseslint.configs.stylisticTypeChecked,
+    {
+      languageOptions: {
+        parser: tseslint.parser,
+        parserOptions: {
+          // projectService: true, // Astro ecosystem tools can't use this yet; 2024Q4
+          project: ["./tsconfig.json"],
+        },
+        globals: {
+          ...globals.builtin,
+          ...globals.nodeBuiltin,
+          ...customGlobals,
+        },
+      },
+      plugins: {
+        "@typescript-eslint": tseslint.plugin,
+      },
+      rules: {
+        "@typescript-eslint/array-type": ["warn", { default: "generic" }],
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          {
+            argsIgnorePattern: "^_",
+            destructuredArrayIgnorePattern: "^_",
+            varsIgnorePattern: "^_",
+            caughtErrorsIgnorePattern: "^_",
+            ignoreRestSiblings: true,
+          },
+        ],
+        "@typescript-eslint/no-non-null-assertion": "off",
+      },
+    },
+
+    /**
+     * Simple import sort
+     */
+    {
+      plugins: {
+        "simple-import-sort": simpleImportSortPlugin,
+      },
+      rules: {
+        "simple-import-sort/imports": [
+          "warn",
+          {
+            groups: [
+              [String.raw`^@?\w`], // External packages
+              [String.raw`^.*\u0000$`], // Type imports
+              ["^(@/)(/.*|$)"], // Internal imports prefixed with `@/`
+              [String.raw`^\u0000`], // Side effect imports
+              [String.raw`^\.\.(?!/?$)`, String.raw`^\.\./?$`], // Parent imports; put `..` last
+              [
+                String.raw`^\./(?=.*/)(?!/?$)`,
+                String.raw`^\.(?!/?$)`,
+                String.raw`^\./?$`,
+              ], // Other relative imports; put same folder imports and `.` last
+              [String.raw`^.+\.s?css$`], // Style imports
+            ],
+          },
+        ],
+        "simple-import-sort/exports": "warn",
+      },
+    },
+
+    /**
+     * Unicorn
+     */
+    unicornPlugin.configs["flat/recommended"],
+    {
+      rules: {
+        "unicorn/filename-case": "warn",
+        "unicorn/no-array-callback-reference": "off", // I prefer this pattern for filtering/sorting content
+        "unicorn/prevent-abbreviations": "off", // I *like* abbreviations!
+      },
+    },
+  ] satisfies ConfigArray;
+
+  /**
+   * Astro support; with some help from...
+   * @reference - https://github.com/Princesseuh/erika.florist/blob/main/eslint.config.js
+   */
+  const astroConfig = [
+    ...astroPlugin.configs.recommended,
+    ...astroPlugin.configs["jsx-a11y-strict"],
+
+    // Remove some safety rules around `any` for various reasons
+    // Astro.props isn't typed correctly in some contexts, so a bunch of things ends up being `any`
+    {
+      files: ["**/*.astro"],
+      rules: {
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+      },
+    },
+
+    // Disable typed rules for scripts inside Astro files
+    // https://github.com/ota-meshi/eslint-plugin-astro/issues/240
+    {
+      files: ["**/*.astro/*.ts"],
+      languageOptions: {
+        parserOptions: {
+          // eslint-disable-next-line unicorn/no-null
+          project: null,
+        },
+      },
+      ...tseslint.configs.disableTypeChecked,
+    },
+  ] satisfies ConfigArray;
+
+  return tseslint.config([
+    ...baseConfig,
+    ...(withAstro ? astroConfig : []),
+    ...(customConfig ?? []),
+  ]);
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "baseUrl": ".",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "**/*.ts"
+  ]
+}