@ethang/eslint-config 24.0.1 → 24.0.2

package/src/eslint.html.js

@@ -0,0 +1,73 @@
+import html from "@html-eslint/eslint-plugin";
+// @ts-nocheck
+import { defineConfig } from "eslint/config";
+
+import { ignores, languageOptions } from "./constants.js";
+
+export default defineConfig({
+  files: ["**/*.html"],
+  ignores,
+  language: "html/html",
+  languageOptions,
+  plugins: {
+    html,
+  },
+  rules: {
+    "html/attrs-newline": "off",
+    "html/element-newline": "off",
+    "html/id-naming-convention": "error",
+    "html/indent": "off",
+    "html/lowercase": "error",
+    "html/max-element-depth": "error",
+    "html/no-abstract-roles": "error",
+    "html/no-accesskey-attrs": "error",
+    "html/no-aria-hidden-body": "error",
+    "html/no-aria-hidden-on-focusable": "error",
+    "html/no-duplicate-attrs": "error",
+    "html/no-duplicate-class": "error",
+    "html/no-duplicate-id": "error",
+    "html/no-duplicate-in-head": "error",
+    "html/no-empty-headings": "error",
+    "html/no-extra-spacing-attrs": "off",
+    "html/no-extra-spacing-text": "error",
+    "html/no-heading-inside-button": "error",
+    "html/no-ineffective-attrs": "error",
+    "html/no-inline-styles": "error",
+    "html/no-invalid-entity": "error",
+    "html/no-invalid-role": "error",
+    "html/no-multiple-empty-lines": "error",
+    "html/no-multiple-h1": "error",
+    "html/no-nested-interactive": "error",
+    "html/no-non-scalable-viewport": "error",
+    "html/no-obsolete-tags": "error",
+    "html/no-positive-tabindex": "error",
+    "html/no-restricted-attr-values": "error",
+    "html/no-restricted-attrs": "error",
+    "html/no-restricted-tags": "error",
+    "html/no-script-style-type": "error",
+    "html/no-skip-heading-levels": "error",
+    "html/no-target-blank": "error",
+    "html/no-trailing-spaces": "error",
+    "html/no-whitespace-only-children": "error",
+    "html/prefer-https": "error",
+    "html/quotes": "error",
+    "html/require-attrs": "error",
+    "html/require-button-type": "error",
+    "html/require-closing-tags": "off",
+    "html/require-doctype": "error",
+    "html/require-explicit-size": "error",
+    "html/require-form-method": "error",
+    "html/require-frame-title": "error",
+    "html/require-img-alt": "error",
+    "html/require-input-label": "error",
+    "html/require-lang": "error",
+    "html/require-li-container": "error",
+    "html/require-meta-charset": "error",
+    "html/require-meta-description": "error",
+    "html/require-meta-viewport": "error",
+    "html/require-open-graph-protocol": "error",
+    "html/require-title": "error",
+    "html/sort-attrs": "error",
+    "html/use-baseline": "error",
+  },
+});

package/src/setup/a11y.ts

@@ -0,0 +1,19 @@
+import a11y from "eslint-plugin-jsx-a11y";
+import keys from "lodash/keys.js";
+
+import { genRules, getNonDeprecatedRules } from "./gen-rules.ts";
+
+const ruleNames = keys(getNonDeprecatedRules(a11y.rules ?? {}));
+const customRules = [
+  {
+    // throws false positives
+    name: "control-has-associated-label",
+    rule: "off",
+  },
+  {
+    name: "media-has-caption",
+    rule: "off",
+  },
+];
+
+export const a11yRules = genRules(ruleNames, customRules, "a11y");

package/src/setup/angular.ts

@@ -0,0 +1,36 @@
+import angularTS from "@angular-eslint/eslint-plugin";
+import angularTemplate from "@angular-eslint/eslint-plugin-template";
+import keys from "lodash/keys.js";
+
+import { genRules, getNonDeprecatedRules } from "./gen-rules.js";
+
+const tsRuleNames = keys(getNonDeprecatedRules(angularTS.rules));
+const templateRuleNames = keys(getNonDeprecatedRules(angularTemplate.rules));
+
+const customTsRules = [
+  {
+    name: "directive-selector",
+    rule: ["error", { prefix: "app", style: "camelCase", type: "attribute" }],
+  },
+  {
+    name: "component-selector",
+    rule: ["error", { prefix: "app", style: "kebab-case", type: "element" }],
+  },
+];
+
+const customTemplateRules = [
+  { name: "i18n", rule: "off" },
+  { name: "no-call-expression", rule: "off" },
+  { name: "prefer-ngsrc", rule: "warn" },
+];
+
+export const angularTsRules = genRules(
+  tsRuleNames,
+  customTsRules,
+  "@angular-eslint",
+);
+export const angularTemplateRules = genRules(
+  templateRuleNames,
+  customTemplateRules,
+  "@angular-eslint/template",
+);

package/src/setup/astro.ts

@@ -0,0 +1,14 @@
+import astro from "eslint-plugin-astro";
+import keys from "lodash/keys.js";
+
+import { genRules, getNonDeprecatedRules } from "./gen-rules.ts";
+
+const ruleNames = keys(getNonDeprecatedRules(astro.rules));
+const customRules = [
+  {
+    name: "no-set-html-directive",
+    rule: "off",
+  },
+];
+
+export const astroRules = genRules(ruleNames, customRules, "astro");

package/src/setup/compat.ts

@@ -0,0 +1,13 @@
+import compat from "eslint-plugin-compat";
+import keys from "lodash/keys.js";
+
+import {
+  type CustomRules,
+  genRules,
+  getNonDeprecatedRules,
+} from "./gen-rules.ts";
+
+const ruleNames = keys(getNonDeprecatedRules(compat.rules));
+const changedRules: CustomRules = [];
+
+export const compatRules = genRules(ruleNames, changedRules, "compat");

package/src/setup/cspell.ts

@@ -0,0 +1,100 @@
+import cspell from "@cspell/eslint-plugin";
+import keys from "lodash/keys.js";
+
+import {
+  type CustomRules,
+  genRules,
+  getNonDeprecatedRules,
+} from "./gen-rules.js";
+
+const ruleNames = keys(getNonDeprecatedRules(cspell.rules));
+
+const customRules: CustomRules = [
+  {
+    name: "spellchecker",
+    rule: [
+      "error",
+      {
+        cspell: {
+          words: [
+            "tauri",
+            "Applynetic",
+            "julianday",
+            "typicode",
+            "toolbelt",
+            "taze",
+            "ethang",
+            "TSESTree",
+            "Boop",
+            "cldr",
+            "astro",
+            "laravel",
+            "qwik",
+            "sitecore",
+            "uswds",
+            "mediat",
+            "Packt",
+            "Academind",
+            "Udemy",
+            "Colte",
+            "Bootcamp",
+            "HTMX",
+            "MERN",
+            "Nuxt",
+            "Credly",
+            "Sterett",
+            "Beyonder",
+            "hotspot",
+            "lqip",
+            "Hawn",
+            "nextui",
+            "speculationrules",
+            "zustand",
+            "vinxi",
+            "datasource",
+            "turso",
+            "supabase",
+            "solidjs",
+            "labelledby",
+            "svix",
+            "blockqoute",
+            "cortexjs",
+            "mathrm",
+            "nums",
+            "lifecycles",
+            "krausest",
+            "Signalis",
+            "Plass",
+            "Iteree",
+            "Sonner",
+            "cmdk",
+            "ngsw",
+            "dexie",
+            "leetcode",
+            "ngsrc",
+            "sindresorhus",
+            "rogan",
+            "heroui",
+            "millis",
+            "duckdb",
+            "pthread",
+            "remeda",
+            "radash",
+            "noto",
+            "nosniff",
+            "SAMEORIGIN",
+            "starcoder",
+            "logprobs",
+            "sealioning",
+            "swebok",
+            "pluralsight",
+            "skillset",
+            "junie",
+          ],
+        },
+      },
+    ],
+  },
+];
+
+export const cspellRules = genRules(ruleNames, customRules, "cspell");

package/src/setup/css.ts

@@ -0,0 +1,15 @@
+import css from "@eslint/css";
+import keys from "lodash/keys.js";
+
+import { genRules, getNonDeprecatedRules } from "./gen-rules.js";
+
+const ruleNames = keys(getNonDeprecatedRules(css.rules));
+
+export const cssRules = genRules(
+  ruleNames,
+  [
+    { name: "no-invalid-at-rules", rule: "off" },
+    { name: "use-baseline", rule: ["error", { available: "newly" }] },
+  ],
+  "css",
+);

package/src/setup/eslint.ts

@@ -0,0 +1,250 @@
+import eslint from "@eslint/js";
+import keys from "lodash/keys.js";
+
+import { type CustomRules, genRules } from "./gen-rules.ts";
+
+const ruleNames = keys(eslint.configs.all.rules);
+const customRules = [
+  {
+    name: "arrow-body-style",
+    rule: ["error", "always"],
+  },
+  {
+    name: "camelcase",
+    rule: "off",
+  },
+  {
+    name: "capitalized-comments",
+    rule: "off",
+  },
+  {
+    name: "class-methods-use-this",
+    rule: "off",
+  },
+  {
+    name: "complexity",
+    rule: "off",
+  },
+  {
+    name: "consistent-return",
+    rule: "off",
+  },
+  {
+    name: "consistent-this",
+    rule: "off",
+  },
+  {
+    name: "curly",
+    rule: "off",
+  },
+  {
+    name: "default-case",
+    rule: "off",
+  },
+  {
+    name: "default-case-last",
+    rule: "off",
+  },
+  {
+    name: "default-param-last",
+    rule: "off",
+  },
+  {
+    name: "dot-notation",
+    rule: "off",
+  },
+  {
+    name: "func-names",
+    rule: "off",
+  },
+  {
+    name: "func-style",
+    rule: ["error", "declaration", { allowArrowFunctions: true }],
+  },
+  {
+    name: "id-denylist",
+    rule: "off",
+  },
+  {
+    name: "id-length",
+    rule: "off",
+  },
+  {
+    name: "id-match",
+    rule: "off",
+  },
+  {
+    name: "init-declarations",
+    rule: "off",
+  },
+  {
+    name: "max-lines",
+    rule: "off",
+  },
+  {
+    name: "max-lines-per-function",
+    rule: "off",
+  },
+  {
+    name: "max-params",
+    rule: "off",
+  },
+  {
+    name: "max-statements",
+    rule: "off",
+  },
+  {
+    name: "new-cap",
+    rule: "off",
+  },
+  {
+    name: "no-array-constructor",
+    rule: "off",
+  },
+  {
+    name: "no-dupe-class-members",
+    rule: "off",
+  },
+  {
+    name: "no-empty-function",
+    rule: "off",
+  },
+  {
+    name: "no-implicit-globals",
+    rule: "off",
+  },
+  {
+    name: "no-implied-eval",
+    rule: "off",
+  },
+  {
+    name: "no-inline-comments",
+    rule: "off",
+  },
+  {
+    name: "no-magic-numbers",
+    rule: "off",
+  },
+  {
+    name: "no-redeclare",
+    rule: "off",
+  },
+  {
+    name: "no-restricted-exports",
+    rule: "off",
+  },
+  {
+    name: "no-restricted-globals",
+    rule: "off",
+  },
+  {
+    name: "no-restricted-imports",
+    rule: "off",
+  },
+  {
+    name: "no-restricted-properties",
+    rule: "off",
+  },
+  {
+    name: "no-restricted-syntax",
+    rule: "off",
+  },
+  {
+    name: "no-shadow",
+    rule: "off",
+  },
+  {
+    name: "no-template-curly-in-string",
+    rule: "off",
+  },
+  {
+    name: "no-ternary",
+    rule: "off",
+  },
+  {
+    name: "no-throw-literal",
+    rule: "off",
+  },
+  {
+    name: "no-undef",
+    rule: "off",
+  },
+  {
+    name: "no-undefined",
+    rule: "off",
+  },
+  {
+    name: "no-underscore-dangle",
+    rule: "off",
+  },
+  {
+    name: "no-unexpected-multiline",
+    rule: "off",
+  },
+  {
+    name: "no-unsafe-optional-chaining",
+    rule: ["error", { disallowArithmeticOperators: true }],
+  },
+  {
+    name: "no-unused-expressions",
+    rule: "off",
+  },
+  {
+    name: "no-unused-vars",
+    rule: "off",
+  },
+  {
+    name: "no-use-before-define",
+    rule: "off",
+  },
+  {
+    name: "no-useless-assignment",
+    rule: "off",
+  },
+  {
+    name: "no-useless-constructor",
+    rule: "off",
+  },
+  {
+    name: "no-warning-comments",
+    rule: "off",
+  },
+  {
+    name: "one-var",
+    rule: "off",
+  },
+  {
+    name: "prefer-arrow-callback",
+    rule: "off",
+  },
+  {
+    name: "prefer-destructuring",
+    rule: "off",
+  },
+  {
+    name: "prefer-promise-reject-errors",
+    rule: "off",
+  },
+  {
+    name: "require-await",
+    rule: "off",
+  },
+  {
+    name: "sort-imports",
+    rule: "off",
+  },
+  {
+    name: "sort-keys",
+    rule: "off",
+  },
+  {
+    name: "yoda",
+    rule: ["error", "always"],
+  },
+];
+
+export const eslintRules = genRules(
+  ruleNames,
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  customRules as unknown as CustomRules,
+);

package/src/setup/gen-rules.ts

@@ -0,0 +1,85 @@
+import type { Linter, Rule } from "eslint";
+
+import get from "lodash/get.js";
+import includes from "lodash/includes.js";
+import isNil from "lodash/isNil.js";
+
+export type EsLintRules = Record<string, Rule.RuleModule>;
+
+export const getNonDeprecatedRules = (rules: unknown) => {
+  const filtered: EsLintRules = {};
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  for (const [key, value] of Object.entries(rules as EsLintRules)) {
+    const deprecated = get(value, ["meta", "deprecated"]);
+
+    if (false === deprecated || isNil(deprecated)) {
+      filtered[key] = value;
+    }
+  }
+
+  return filtered;
+};
+
+export type CustomRules = {
+  name: string;
+  rule: CustomRule;
+}[];
+
+type CustomRule = (Record<string, unknown> | string)[] | string;
+
+const getRuleStrings = (
+  ruleNames: string[],
+  defaultOverride: string,
+  prefix?: string,
+) => {
+  const rules: Record<string, unknown> = {};
+
+  for (const rule of ruleNames) {
+    if (prefix === undefined) {
+      rules[rule] = isNil(defaultOverride) ? "error" : defaultOverride;
+    } else {
+      rules[`${prefix}/${rule}`] = isNil(defaultOverride)
+        ? "error"
+        : defaultOverride;
+    }
+  }
+
+  return rules;
+};
+
+export const genRules = (
+  ruleNames: string[],
+  customRules?: CustomRules,
+  prefix?: string,
+  defaultOverride = "error",
+) => {
+  const rules = getRuleStrings(ruleNames, defaultOverride, prefix);
+
+  if (!isNil(customRules)) {
+    for (const rule of customRules) {
+      if (includes(ruleNames, rule.name)) {
+        // eslint-disable-next-line sonar/nested-control-flow
+        if (prefix === undefined) {
+          rules[rule.name] = rule.rule;
+        } else {
+          rules[`${prefix}/${rule.name}`] = rule.rule;
+        }
+      } else {
+        globalThis.console.error(
+          `${rule.name} in ${prefix ?? "(unknown prefix)"} does not exist.`,
+        );
+        throw new Error(
+          `${rule.name} in ${prefix ?? "(unknown prefix)"} does not exist.`,
+        );
+      }
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  return Object.fromEntries(
+    Object.entries(rules).toSorted(([a], [b]) => {
+      return a.localeCompare(b);
+    }),
+  ) as Linter.RulesRecord;
+};

package/src/setup/html.ts

@@ -0,0 +1,17 @@
+import html from "@html-eslint/eslint-plugin";
+import get from "lodash/get.js";
+import keys from "lodash/keys.js";
+
+import { genRules } from "./gen-rules.ts";
+
+const ruleNames = keys(get(html, ["rules"], []));
+
+const customRules = [
+  { name: "indent", rule: "off" },
+  { name: "no-extra-spacing-attrs", rule: "off" },
+  { name: "attrs-newline", rule: "off" },
+  { name: "require-closing-tags", rule: "off" },
+  { name: "element-newline", rule: "off" },
+];
+
+export const htmlRules = genRules(ruleNames, customRules, "html");

package/src/setup/json.ts

@@ -0,0 +1,17 @@
+import json from "@eslint/json";
+import keys from "lodash/keys.js";
+
+import {
+  type CustomRules,
+  type EsLintRules,
+  genRules,
+  getNonDeprecatedRules,
+} from "./gen-rules.ts";
+
+const ruleNames = keys(
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+  getNonDeprecatedRules(json.rules as unknown as EsLintRules),
+);
+const customRules: CustomRules = [];
+
+export const jsonRules = genRules(ruleNames, customRules, "json");

package/src/setup/lodash.ts

@@ -0,0 +1,59 @@
+// @ts-expect-error no types
+import lodash from "eslint-plugin-lodash";
+import keys from "lodash/keys.js";
+
+import {
+  type EsLintRules,
+  genRules,
+  getNonDeprecatedRules,
+} from "./gen-rules.ts";
+
+const ruleNames = keys(
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion,@typescript-eslint/no-unsafe-member-access
+  getNonDeprecatedRules(lodash.rules as unknown as EsLintRules),
+);
+const customRules = [
+  {
+    name: "chain-style",
+    rule: [2, "as-needed"],
+  },
+  {
+    name: "consistent-compose",
+    rule: [2, "flow"],
+  },
+  {
+    name: "identity-shorthand",
+    rule: [2, "always"],
+  },
+  {
+    name: "import-scope",
+    rule: [2, "method"],
+  },
+  {
+    name: "matches-prop-shorthand",
+    rule: [2, "always"],
+  },
+  {
+    name: "matches-shorthand",
+    rule: [2, "always", 3],
+  },
+  {
+    name: "path-style",
+    rule: [2, "array"],
+  },
+  {
+    name: "prefer-includes",
+    rule: [2, { includeNative: true }],
+  },
+  {
+    name: "prefer-some",
+    rule: [2, { includeNative: true }],
+  },
+  {
+    name: "prop-shorthand",
+    rule: [2, "always"],
+  },
+];
+
+// @ts-expect-error loose types
+export const lodashRules = genRules(ruleNames, customRules, "lodash");