@ethang/eslint-config 24.0.1 → 24.0.2

package/src/build/update-readme.ts

@@ -0,0 +1,259 @@
+import { MarkdownGenerator } from "@ethang/markdown-generator/markdown-generator.js";
+import filter from "lodash/filter.js";
+import flow from "lodash/flow.js";
+import isArray from "lodash/isArray.js";
+import map from "lodash/map.js";
+import values from "lodash/values.js";
+import { writeFileSync } from "node:fs";
+import path from "node:path";
+
+import type { genRules } from "../setup/gen-rules.ts";
+
+import { getList } from "./list-utilities.ts";
+
+const getRuleCount = (rules: ReturnType<typeof genRules>) => {
+  let count = 0;
+  for (const value of values(rules)) {
+    if ("error" === value || (isArray(value) && "error" === value[0])) {
+      count += 1;
+    }
+  }
+
+  return count;
+};
+
+const getImports = flow(
+  (rules: ReturnType<typeof getList>) => {
+    return filter(rules, (rule) => {
+      return 0 < getRuleCount(rule.list);
+    });
+  },
+  (filteredRules) => {
+    return map(filteredRules, (rule) => {
+      return `${getRuleCount(rule.list)} rules from [${rule.name}](${rule.url})`;
+    });
+  },
+);
+
+// eslint-disable-next-line sonar/max-lines-per-function
+export const updateReadme = () => {
+  const md = new MarkdownGenerator();
+  md.header(1, "Relentless. Unapologetic.", 2);
+  md.link("View Config", "https://eslint-config-ethang.pages.dev/rules", 2);
+  md.alert("CAUTION", "Prettier is already included for styling!", 2);
+
+  const coreRules = map(
+    [
+      ...getList("core"),
+      ...getList("json"),
+      ...getList("css"),
+      ...getList("markdown"),
+    ],
+    (rules) => {
+      return {
+        ...rules,
+        count: 0,
+      };
+    },
+  );
+
+  let total = 0;
+  for (const list of coreRules) {
+    const count = getRuleCount(list.list);
+    total += count;
+    list.count = count;
+  }
+  coreRules.sort((a, b) => {
+    return b.count - a.count;
+  });
+
+  const ruleDocumentation = [`${total} errored rules.`];
+  for (const list of coreRules) {
+    if (0 < list.count) {
+      ruleDocumentation.push(
+        `${list.count} ${
+          1 >= list.count ? "rule" : "rules"
+        } from [${list.name}](${list.url})`,
+      );
+    }
+  }
+
+  const htmlRules = getList("html");
+  const tailwindRules = getList("tailwind");
+  const astroRules = getList("astro");
+  const reactRules = getList("react");
+  const solidRules = getList("solid");
+  const angularRules = getList("angular");
+  const angularTemplateRules = getList("angular:template");
+  const storybookRules = getList("storybook");
+
+  let htmlCount = 0;
+  for (const htmlRule of htmlRules) {
+    htmlCount += getRuleCount(htmlRule.list);
+  }
+
+  let tailwindCount = 0;
+  for (const tailwindRule of tailwindRules) {
+    tailwindCount += getRuleCount(tailwindRule.list);
+  }
+
+  let astroCount = 0;
+  for (const astroRule of astroRules) {
+    astroCount += getRuleCount(astroRule.list);
+  }
+
+  let reactCount = 0;
+  for (const reactRule of reactRules) {
+    reactCount += getRuleCount(reactRule.list);
+  }
+
+  let solidCount = 0;
+  for (const solidRule of solidRules) {
+    solidCount += getRuleCount(solidRule.list);
+  }
+
+  let angularCount = 0;
+  for (const angularRule of [...angularRules, ...angularTemplateRules]) {
+    angularCount += getRuleCount(angularRule.list);
+  }
+
+  let storybookCount = 0;
+  for (const storybookRule of storybookRules) {
+    storybookCount += getRuleCount(storybookRule.list);
+  }
+
+  md.unorderedList(ruleDocumentation);
+  md.newLine();
+  md.header(1, "Add Even More!", 2);
+  md.unorderedList([
+    `${angularCount} rules for **Angular**`,
+    [
+      '`import angularConfig from "@ethang/eslint-config/config.angular.js";`',
+      getImports(angularRules),
+      getImports(angularTemplateRules),
+    ],
+    `${astroCount} rules for **Astro**`,
+    [
+      '`import astroConfig from "@ethang/eslint-config/config.astro.js";`',
+      getImports(astroRules),
+    ],
+    `${htmlCount} rules for **HTML**`,
+    [
+      `import html from "@ethang/eslint-config/config.html.js";`,
+      getImports(htmlRules),
+    ],
+    `${reactCount} rules for **React**`,
+    [
+      '`import reactConfig from "@ethang/eslint-config/config.react.js";`',
+      getImports(reactRules),
+    ],
+    `${solidCount} rules for **Solid**`,
+    [
+      '`import solidConfig from "@ethang/eslint-config/config.solid.js";`',
+      getImports(solidRules),
+    ],
+    `${storybookCount} rules for **Storybook**`,
+    [
+      '`import storybookConfig from "@ethang/eslint-config/config.storybook.js";`',
+      getImports(storybookRules),
+    ],
+    `${tailwindCount} rules for **Tailwind**`,
+    [
+      `import tailwindConfig from "@ethang/eslint-config/config.tailwind.js";`,
+      getImports(tailwindRules),
+    ],
+  ]);
+  md.newLine();
+  md.header(1, "Install", 2);
+  md.codeBlock("pnpm i -D eslint @ethang/eslint-config", "powershell", 2);
+  md.bold("Requires TypesScript and tsconfig.json at root directory.", 2);
+  md.header(1, "Config", 2);
+  md.text("In **eslint.config.ts**", 2);
+  md.codeBlock(
+    `import config from "@ethang/eslint-config/eslint.config.js";
+import { defineConfig } from "eslint/config";
+import path from "node:path";
+import reactConfig from "@ethang/eslint-config/config.react.js"; // OPTIONAL
+import tailwindConfig from "@ethang/eslint-config/config.tailwind.js"; // OPTIONAL
+import htmlConfig from "@ethang/eslint-config/config.html.js"; // OPTIONAL
+
+export default defineConfig(
+  {
+    ignores: [], // Ignored files apply to all following configs
+  },
+  ...config,
+  ...reactConfig,
+  ...htmlConfig,
+  ...tailwindConfig(path.join(import.meta.dirname, "src", "index.css")),
+  {
+    languageOptions: {
+      parserOptions: {
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      // Override rules from above configs
+    },
+  }
+);`,
+    "js",
+    2,
+  );
+  md.bold("Scripts", 2);
+  md.codeBlock(
+    `"scripts": {
+  "lint": "eslint . --fix --concurrency=auto"
+}`,
+    "json",
+    2,
+  );
+  md.bold("Browserslist", 2);
+  md.text(
+    "This config will also lint for browserslist features. [More info.](https://github.com/browserslist/browserslist)",
+    2,
+  );
+  md.text("It's recommended to use ");
+  md.link(
+    "browserslist-config-baseline",
+    "https://github.com/web-platform-dx/browserslist-config-baseline",
+    2,
+  );
+  md.codeBlock("pnpm i -D browserslist-config-baseline", "powershell", 2);
+
+  md.codeBlock(
+    `"browserslist": [
+  "extends browserslist-config-baseline",
+  "current node"
+],`,
+    "json",
+    2,
+  );
+
+  md.text("Or a simpler config without an additional dependency.", 2);
+
+  md.codeBlock(
+    `"browserslist": [
+  "defaults and fully supports es6-module",
+  "current node"
+],`,
+    "json",
+    2,
+  );
+
+  md.bold("Engines", 2);
+  md.codeBlock(
+    `"engines": {
+  "node": ">=24"
+},`,
+    "json",
+  );
+
+  writeFileSync(
+    path.join(import.meta.dirname, "../README.md"),
+    md.render(),
+    "utf8",
+  );
+};
+
+updateReadme();

package/src/build/update-rules.ts

@@ -0,0 +1,173 @@
+import type { ConfigOptions } from "./create-config.ts";
+
+import { createConfigFile } from "./create-config-file.ts";
+
+export type ConfigFile = {
+  importString?: string;
+  label?: string;
+  name: string;
+  options?: ConfigOptions;
+};
+
+const defineConfig = 'import { defineConfig } from "eslint/config";';
+
+export const coreFile = [
+  {
+    importString: 'import config from "@ethang/eslint-config/eslint.config.js',
+    label: "Core",
+    name: "core",
+    options: {
+      extraImports: [
+        defineConfig,
+        'import eslintConfigPrettier from "eslint-config-prettier";',
+        'import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";',
+      ],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+      includeReactVersion: true,
+    },
+  },
+  {
+    name: "markdown",
+  },
+  {
+    name: "css",
+  },
+  {
+    name: "json",
+  },
+  {
+    name: "jsonc",
+  },
+  {
+    name: "json5",
+  },
+];
+
+export const htmlFile = [
+  {
+    importString: "@html-eslint/eslint-plugin",
+    label: "HTML",
+    name: "html",
+    options: {
+      extraImports: [defineConfig],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+    },
+  },
+];
+
+const astroFile = [
+  {
+    importString:
+      'import astroConfig from "@ethang/eslint-config/config.astro.ts',
+    label: "Astro",
+    name: "astro",
+    options: {
+      extraImports: [defineConfig],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+    },
+  },
+];
+
+const reactFile = [
+  {
+    importString:
+      'import reactConfig from "@ethang/eslint-config/config.react.ts',
+    label: "React",
+    name: "react",
+    options: {
+      extraImports: [defineConfig],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+      includeReactVersion: true,
+    },
+  },
+];
+
+const solidFile = [
+  {
+    importString:
+      'import solidConfig from "@ethang/eslint-config/config.solid.ts',
+    label: "Solid",
+    name: "solid",
+    options: {
+      extraImports: [defineConfig],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+    },
+  },
+];
+
+const angularFile = [
+  {
+    importString:
+      'import angularConfig from "@ethang/eslint-config/config.angular.ts',
+    label: "Angular",
+    name: "angular",
+    options: {
+      extraImports: [defineConfig, 'import angular from "angular-eslint";'],
+      globalIgnores: ["**/*.spec.ts", "src/main.server.ts"],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+      processor: "angular.processInlineTemplates",
+    },
+  },
+  {
+    name: "angular:template",
+    options: {
+      extraImports: ['import { angularLanguageOptions } from "./constants.js"'],
+      includeAngularLanguageOptions: true,
+      includeLanguageOptions: false,
+    },
+  },
+];
+
+const storybookFile = [
+  {
+    importString:
+      'import storybookConfig from "@ethang/eslint-config/config.storybook.ts',
+    label: "Storybook",
+    name: "storybook",
+    options: {
+      extraImports: [defineConfig],
+      includeIgnores: true,
+      includeLanguageOptions: true,
+    },
+  },
+];
+
+const tailwindFile = [
+  {
+    importString:
+      'import tailwindConfig from "@ethang/eslint-config/config.tailwind.ts',
+    label: "Tailwind",
+    name: "tailwind",
+    options: {
+      extraImports: [defineConfig],
+      extraOptions: "settings: { tailwindcss: { config: pathToConfig } },",
+      includeIgnores: true,
+      includeLanguageOptions: true,
+    },
+  },
+];
+
+export const updateRules = async () => {
+  await Promise.all([
+    createConfigFile(coreFile, "eslint.config.js"),
+    createConfigFile(htmlFile, "config.html.js"),
+    createConfigFile(astroFile, "config.astro.js"),
+    createConfigFile(reactFile, "config.react.js"),
+    createConfigFile(solidFile, "config.solid.js"),
+    createConfigFile(angularFile, "config.angular.js"),
+    createConfigFile(storybookFile, "config.storybook.js"),
+    createConfigFile(
+      tailwindFile,
+      "config.tailwind.js",
+      "/** @type {string} */ pathToConfig",
+    ),
+  ]);
+};
+
+await updateRules();

package/src/config.angular.js

@@ -0,0 +1,122 @@
+// @ts-nocheck
+import { angularLanguageOptions } from "./constants.js";
+import { defineConfig } from "eslint/config";
+import { ignores, languageOptions } from "./constants.js";
+import angular from "angular-eslint";
+import angularTemplate from "@angular-eslint/eslint-plugin-template";
+import angularTS from "@angular-eslint/eslint-plugin";
+
+export default defineConfig(
+  {
+    ignores: ["**/*.spec.ts", "src/main.server.ts"],
+  },
+  {
+    files: ["**/*.ts"],
+    ignores,
+    languageOptions,
+    processor: angular.processInlineTemplates,
+    plugins: {
+      "@angular-eslint": angularTS,
+    },
+    rules: {
+      "@angular-eslint/component-class-suffix": "error",
+      "@angular-eslint/component-max-inline-declarations": "error",
+      "@angular-eslint/component-selector": [
+        "error",
+        { prefix: "app", style: "kebab-case", type: "element" },
+      ],
+      "@angular-eslint/consistent-component-styles": "error",
+      "@angular-eslint/contextual-decorator": "error",
+      "@angular-eslint/contextual-lifecycle": "error",
+      "@angular-eslint/directive-class-suffix": "error",
+      "@angular-eslint/directive-selector": [
+        "error",
+        { prefix: "app", style: "camelCase", type: "attribute" },
+      ],
+      "@angular-eslint/no-async-lifecycle-method": "error",
+      "@angular-eslint/no-attribute-decorator": "error",
+      "@angular-eslint/no-developer-preview": "error",
+      "@angular-eslint/no-duplicates-in-metadata-arrays": "error",
+      "@angular-eslint/no-empty-lifecycle-method": "error",
+      "@angular-eslint/no-experimental": "error",
+      "@angular-eslint/no-forward-ref": "error",
+      "@angular-eslint/no-input-prefix": "error",
+      "@angular-eslint/no-input-rename": "error",
+      "@angular-eslint/no-inputs-metadata-property": "error",
+      "@angular-eslint/no-lifecycle-call": "error",
+      "@angular-eslint/no-output-native": "error",
+      "@angular-eslint/no-output-on-prefix": "error",
+      "@angular-eslint/no-output-rename": "error",
+      "@angular-eslint/no-outputs-metadata-property": "error",
+      "@angular-eslint/no-pipe-impure": "error",
+      "@angular-eslint/no-queries-metadata-property": "error",
+      "@angular-eslint/no-uncalled-signals": "error",
+      "@angular-eslint/pipe-prefix": "error",
+      "@angular-eslint/prefer-host-metadata-property": "error",
+      "@angular-eslint/prefer-inject": "error",
+      "@angular-eslint/prefer-on-push-component-change-detection": "error",
+      "@angular-eslint/prefer-output-emitter-ref": "error",
+      "@angular-eslint/prefer-output-readonly": "error",
+      "@angular-eslint/prefer-signal-model": "error",
+      "@angular-eslint/prefer-signals": "error",
+      "@angular-eslint/prefer-standalone": "error",
+      "@angular-eslint/relative-url-prefix": "error",
+      "@angular-eslint/require-lifecycle-on-prototype": "error",
+      "@angular-eslint/require-localize-metadata": "error",
+      "@angular-eslint/runtime-localize": "error",
+      "@angular-eslint/sort-keys-in-type-decorator": "error",
+      "@angular-eslint/sort-lifecycle-methods": "error",
+      "@angular-eslint/use-component-selector": "error",
+      "@angular-eslint/use-component-view-encapsulation": "error",
+      "@angular-eslint/use-injectable-provided-in": "error",
+      "@angular-eslint/use-lifecycle-interface": "error",
+      "@angular-eslint/use-pipe-transform-interface": "error",
+    },
+  },
+  {
+    files: ["**/*.html"],
+    languageOptions: angularLanguageOptions,
+    plugins: {
+      "@angular-eslint/template": angularTemplate,
+    },
+    rules: {
+      "@angular-eslint/template/alt-text": "error",
+      "@angular-eslint/template/attributes-order": "error",
+      "@angular-eslint/template/banana-in-box": "error",
+      "@angular-eslint/template/button-has-type": "error",
+      "@angular-eslint/template/click-events-have-key-events": "error",
+      "@angular-eslint/template/conditional-complexity": "error",
+      "@angular-eslint/template/cyclomatic-complexity": "error",
+      "@angular-eslint/template/elements-content": "error",
+      "@angular-eslint/template/eqeqeq": "error",
+      "@angular-eslint/template/i18n": "off",
+      "@angular-eslint/template/interactive-supports-focus": "error",
+      "@angular-eslint/template/label-has-associated-control": "error",
+      "@angular-eslint/template/mouse-events-have-key-events": "error",
+      "@angular-eslint/template/no-any": "error",
+      "@angular-eslint/template/no-autofocus": "error",
+      "@angular-eslint/template/no-call-expression": "off",
+      "@angular-eslint/template/no-distracting-elements": "error",
+      "@angular-eslint/template/no-duplicate-attributes": "error",
+      "@angular-eslint/template/no-empty-control-flow": "error",
+      "@angular-eslint/template/no-inline-styles": "error",
+      "@angular-eslint/template/no-interpolation-in-attributes": "error",
+      "@angular-eslint/template/no-negated-async": "error",
+      "@angular-eslint/template/no-nested-tags": "error",
+      "@angular-eslint/template/no-positive-tabindex": "error",
+      "@angular-eslint/template/prefer-at-else": "error",
+      "@angular-eslint/template/prefer-at-empty": "error",
+      "@angular-eslint/template/prefer-built-in-pipes": "error",
+      "@angular-eslint/template/prefer-contextual-for-variables": "error",
+      "@angular-eslint/template/prefer-control-flow": "error",
+      "@angular-eslint/template/prefer-ngsrc": "warn",
+      "@angular-eslint/template/prefer-self-closing-tags": "error",
+      "@angular-eslint/template/prefer-static-string-properties": "error",
+      "@angular-eslint/template/prefer-template-literal": "error",
+      "@angular-eslint/template/role-has-required-aria": "error",
+      "@angular-eslint/template/table-scope": "error",
+      "@angular-eslint/template/use-track-by-function": "error",
+      "@angular-eslint/template/valid-aria": "error",
+    },
+  },
+);

package/src/config.astro.js

@@ -0,0 +1,69 @@
+// @ts-nocheck
+import { defineConfig } from "eslint/config";
+import { ignores, languageOptions } from "./constants.js";
+import astro from "eslint-plugin-astro";
+
+export default defineConfig({
+  files: ["**/*.{astro}"],
+  ignores,
+  languageOptions,
+  plugins: {
+    astro: astro,
+  },
+  rules: {
+    "astro/jsx-a11y/alt-text": "error",
+    "astro/jsx-a11y/anchor-ambiguous-text": "error",
+    "astro/jsx-a11y/anchor-has-content": "error",
+    "astro/jsx-a11y/anchor-is-valid": "error",
+    "astro/jsx-a11y/aria-activedescendant-has-tabindex": "error",
+    "astro/jsx-a11y/aria-props": "error",
+    "astro/jsx-a11y/aria-proptypes": "error",
+    "astro/jsx-a11y/aria-role": "error",
+    "astro/jsx-a11y/aria-unsupported-elements": "error",
+    "astro/jsx-a11y/autocomplete-valid": "error",
+    "astro/jsx-a11y/click-events-have-key-events": "error",
+    "astro/jsx-a11y/control-has-associated-label": "error",
+    "astro/jsx-a11y/heading-has-content": "error",
+    "astro/jsx-a11y/html-has-lang": "error",
+    "astro/jsx-a11y/iframe-has-title": "error",
+    "astro/jsx-a11y/img-redundant-alt": "error",
+    "astro/jsx-a11y/interactive-supports-focus": "error",
+    "astro/jsx-a11y/label-has-associated-control": "error",
+    "astro/jsx-a11y/lang": "error",
+    "astro/jsx-a11y/media-has-caption": "error",
+    "astro/jsx-a11y/mouse-events-have-key-events": "error",
+    "astro/jsx-a11y/no-access-key": "error",
+    "astro/jsx-a11y/no-aria-hidden-on-focusable": "error",
+    "astro/jsx-a11y/no-autofocus": "error",
+    "astro/jsx-a11y/no-distracting-elements": "error",
+    "astro/jsx-a11y/no-interactive-element-to-noninteractive-role": "error",
+    "astro/jsx-a11y/no-noninteractive-element-interactions": "error",
+    "astro/jsx-a11y/no-noninteractive-element-to-interactive-role": "error",
+    "astro/jsx-a11y/no-noninteractive-tabindex": "error",
+    "astro/jsx-a11y/no-redundant-roles": "error",
+    "astro/jsx-a11y/no-static-element-interactions": "error",
+    "astro/jsx-a11y/prefer-tag-over-role": "error",
+    "astro/jsx-a11y/role-has-required-aria-props": "error",
+    "astro/jsx-a11y/role-supports-aria-props": "error",
+    "astro/jsx-a11y/scope": "error",
+    "astro/jsx-a11y/tabindex-no-positive": "error",
+    "astro/missing-client-only-directive-value": "error",
+    "astro/no-conflict-set-directives": "error",
+    "astro/no-deprecated-astro-canonicalurl": "error",
+    "astro/no-deprecated-astro-fetchcontent": "error",
+    "astro/no-deprecated-astro-resolve": "error",
+    "astro/no-deprecated-getentrybyslug": "error",
+    "astro/no-exports-from-components": "error",
+    "astro/no-set-html-directive": "off",
+    "astro/no-set-text-directive": "error",
+    "astro/no-unsafe-inline-scripts": "error",
+    "astro/no-unused-css-selector": "error",
+    "astro/no-unused-define-vars-in-style": "error",
+    "astro/prefer-class-list-directive": "error",
+    "astro/prefer-object-class-list": "error",
+    "astro/prefer-split-class-list": "error",
+    "astro/semi": "error",
+    "astro/sort-attributes": "error",
+    "astro/valid-compile": "error",
+  },
+});