@blockquote/eslint-config 0.1.0

package/src/base.js

@@ -0,0 +1,23 @@
+import js from '@eslint/js';
+import globals from 'globals';
+
+export const fileTypes = '{js,ts,mjs}';
+//
+// ──────────────────────────────────────────────────────────────
+// Base config
+// ──────────────────────────────────────────────────────────────
+//
+export const baseConfig = [
+  js.configs.recommended,
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.es2023,
+        ...globals.mocha,
+      },
+    },
+  },
+];

package/src/config.d.ts

@@ -0,0 +1,6 @@
+export function createConfig({
+  tsconfigRootDir,
+}?: {
+  tsconfigRootDir?: string;
+}): import('eslint').Linter.Config[];
+export default createConfig;

package/src/config.js

@@ -0,0 +1,47 @@
+import { ignoresConfig } from './ignores.js';
+import { baseConfig } from './base.js';
+import {
+  createImportFilesConfig,
+  importFilesRules,
+  importSettingsConfig,
+} from './import-x.js';
+import { litA11yFilesConfig, litA11yFilesRules } from './lit-a11y.js';
+import { wcFilesConfig, wcFilesRules } from './wc.js';
+import { litFilesConfig, litFilesRules } from './lit.js';
+import { createTsFilesConfig, tsFilesRules } from './typescript.js';
+import {
+  htmlFilesConfig,
+  htmlFilesRules,
+  eslintPluginHtmlConfig,
+} from './html.js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import { globalRulesConfig } from './rules.js';
+import { testFilesRules } from './test.js';
+
+/**
+ * @param {{tsconfigRootDir?: string}} [options]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const createConfig = ({ tsconfigRootDir } = {}) => [
+  ignoresConfig,
+  ...baseConfig,
+  ...createImportFilesConfig(tsconfigRootDir),
+  importFilesRules,
+  importSettingsConfig,
+  litA11yFilesConfig,
+  litA11yFilesRules,
+  wcFilesConfig,
+  wcFilesRules,
+  litFilesConfig,
+  litFilesRules,
+  ...createTsFilesConfig(tsconfigRootDir),
+  tsFilesRules,
+  htmlFilesConfig,
+  htmlFilesRules,
+  eslintPluginHtmlConfig,
+  testFilesRules,
+  globalRulesConfig,
+  eslintConfigPrettier,
+];
+
+export default createConfig;

package/src/html.d.ts

@@ -0,0 +1,44 @@
+export const htmlFilesConfig: {
+  files: string[];
+  plugins: {
+    '@html-eslint': typeof htmlEslint;
+  };
+  languageOptions: {
+    parser: typeof htmlEslintParser;
+  };
+  rules: Record<
+    string,
+    | 'error'
+    | [
+        'error',
+        {
+          inline: string[];
+        },
+      ]
+  >;
+};
+export namespace htmlFilesRules {
+  let files: string[];
+  let rules: {
+    '@html-eslint/indent': string;
+    '@html-eslint/require-closing-tags': string;
+    '@html-eslint/no-extra-spacing-tags': string;
+    '@html-eslint/attrs-newline': string;
+    '@html-eslint/use-baseline': (
+      | string
+      | {
+          available: string;
+        }
+    )[];
+  };
+}
+export namespace eslintPluginHtmlConfig {
+  let files_1: string[];
+  export { files_1 as files };
+  export namespace plugins {
+    export { eslintPluginHtml };
+  }
+}
+import htmlEslint from '@html-eslint/eslint-plugin';
+import htmlEslintParser from '@html-eslint/parser';
+import eslintPluginHtml from 'eslint-plugin-html';

package/src/html.js

@@ -0,0 +1,39 @@
+import htmlEslint from '@html-eslint/eslint-plugin';
+import htmlEslintParser from '@html-eslint/parser';
+import eslintPluginHtml from 'eslint-plugin-html';
+//
+// ──────────────────────────────────────────────────────────────
+// HTML
+// ──────────────────────────────────────────────────────────────
+//
+export const htmlFilesConfig = {
+  ...htmlEslint.configs['flat/recommended'],
+  files: ['**/*.html'],
+
+  plugins: {
+    '@html-eslint': htmlEslint,
+  },
+
+  languageOptions: {
+    parser: htmlEslintParser,
+  },
+};
+
+export const htmlFilesRules = {
+  files: ['**/*.html'],
+
+  rules: {
+    '@html-eslint/indent': 'off',
+    '@html-eslint/require-closing-tags': 'off',
+    '@html-eslint/no-extra-spacing-tags': 'off',
+    '@html-eslint/attrs-newline': 'off',
+    '@html-eslint/use-baseline': ['error', { available: 'newly' }],
+  },
+};
+export const eslintPluginHtmlConfig = {
+  files: ['**/*.html'],
+
+  plugins: {
+    eslintPluginHtml,
+  },
+};

package/src/ignores.d.ts

@@ -0,0 +1,3 @@
+export namespace ignoresConfig {
+  let ignores: string[];
+}

package/src/ignores.js

@@ -0,0 +1,26 @@
+//
+// ──────────────────────────────────────────────────────────────
+// ignores
+// ──────────────────────────────────────────────────────────────
+//
+export const ignoresConfig = {
+  ignores: [
+    '**/.idea',
+    '**/.tmp',
+    '**/.vscode',
+    '**/.wireit',
+    '**/_site',
+    '**/build',
+    '**/coverage',
+    '**/dev',
+    '**/dist',
+    '**/reports',
+    '**/storybook-static',
+    '**/*screenshots*',
+    '**/*snapshots*',
+    '**/*.config.*',
+    '**/*.d.ts',
+    '**/*.min.js',
+    '**/*.workspace.*',
+  ],
+};

package/src/import-x.d.ts

@@ -0,0 +1,27 @@
+export function createImportFilesConfig(
+  tsconfigRootDir?: string,
+): import('eslint').Linter.Config[];
+export namespace importFilesRules {
+  let files: string[];
+  let rules: {
+    'import-x/extensions': (
+      | string
+      | {
+          ignorePackages: boolean;
+        }
+    )[];
+    'import-x/no-extraneous-dependencies': (
+      | string
+      | {
+          devDependencies: string[];
+        }
+    )[];
+    'import-x/no-unresolved': string;
+    'import-x/prefer-default-export': string;
+  };
+}
+export namespace importSettingsConfig {
+  let settings: {
+    'import-x/resolver-next': import('eslint-plugin-import-x/node-resolver').NodeResolver[];
+  };
+}

package/src/import-x.js

@@ -0,0 +1,68 @@
+import {
+  flatConfigs as importPlugin,
+  createNodeResolver,
+} from 'eslint-plugin-import-x';
+import { parser as tsParser } from 'typescript-eslint';
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// eslint-plugin-import-x
+// ──────────────────────────────────────────────────────────────
+//
+/**
+ * @param {string} [tsconfigRootDir]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const createImportFilesConfig = (tsconfigRootDir) =>
+  [importPlugin.recommended, importPlugin.typescript].map((conf) => ({
+    ...conf,
+    files: [`**/*.${fileTypes}`],
+    languageOptions: {
+      ...conf.languageOptions,
+      parser: tsParser,
+      ...(tsconfigRootDir && {
+        parserOptions: { tsconfigRootDir },
+      }),
+    },
+    settings: {
+      ...conf.settings,
+      'import-x/parsers': {},
+      'import-x/extensions': [
+        '.js',
+        '.mjs',
+        '.cjs',
+        '.ts',
+        '.tsx',
+        '.cts',
+        '.mts',
+      ],
+    },
+  }));
+
+export const importFilesRules = {
+  files: [`**/*.${fileTypes}`],
+  rules: {
+    'import-x/extensions': ['error', 'always', { ignorePackages: true }],
+    'import-x/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: [
+          `**/demo/**/*.${fileTypes}`,
+          `**/test/**/*.${fileTypes}`,
+          `**/*.config.${fileTypes}`,
+          `**/*.conf.${fileTypes}`,
+        ],
+      },
+    ],
+    'import-x/no-unresolved': 'off',
+    'import-x/prefer-default-export': 'off',
+  },
+};
+
+export const importSettingsConfig = {
+  settings: {
+    'import-x/resolver-next': [
+      createNodeResolver({ extensions: ['.js', '.ts'] }),
+    ],
+  },
+};

package/src/index.d.ts

@@ -0,0 +1,19 @@
+export { ignoresConfig } from './ignores.js';
+export { baseConfig } from './base.js';
+export { testFilesRules } from './test.js';
+export { globalRulesConfig } from './rules.js';
+export { default as createConfig, default } from './config.js';
+export {
+  createImportFilesConfig,
+  importFilesRules,
+  importSettingsConfig,
+} from './import-x.js';
+export { litA11yFilesConfig, litA11yFilesRules } from './lit-a11y.js';
+export { wcFilesConfig, wcFilesRules } from './wc.js';
+export { litFilesConfig, litFilesRules } from './lit.js';
+export { createTsFilesConfig, tsFilesRules } from './typescript.js';
+export {
+  htmlFilesConfig,
+  htmlFilesRules,
+  eslintPluginHtmlConfig,
+} from './html.js';

package/src/index.js

@@ -0,0 +1,21 @@
+export { default as createConfig } from './config.js';
+export { default } from './config.js';
+
+export { ignoresConfig } from './ignores.js';
+export { baseConfig } from './base.js';
+export {
+  createImportFilesConfig,
+  importFilesRules,
+  importSettingsConfig,
+} from './import-x.js';
+export { litA11yFilesConfig, litA11yFilesRules } from './lit-a11y.js';
+export { wcFilesConfig, wcFilesRules } from './wc.js';
+export { litFilesConfig, litFilesRules } from './lit.js';
+export { createTsFilesConfig, tsFilesRules } from './typescript.js';
+export {
+  htmlFilesConfig,
+  htmlFilesRules,
+  eslintPluginHtmlConfig,
+} from './html.js';
+export { testFilesRules } from './test.js';
+export { globalRulesConfig } from './rules.js';

package/src/lit-a11y.d.ts

@@ -0,0 +1,9 @@
+export const litA11yFilesConfig: any;
+export namespace litA11yFilesRules {
+  let files: string[];
+  let rules: {
+    'lit-a11y/no-autofocus': string;
+    'lit-a11y/anchor-is-valid': string;
+    'lit-a11y/click-events-have-key-events': string;
+  };
+}

package/src/lit-a11y.js

@@ -0,0 +1,21 @@
+import { default as litA11y } from 'eslint-plugin-lit-a11y';
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// eslint-plugin-lit-a11y
+// ──────────────────────────────────────────────────────────────
+//
+export const litA11yFilesConfig = {
+  // @ts-ignore
+  ...litA11y.configs.recommended,
+  files: [`**/*.${fileTypes}`],
+};
+
+export const litA11yFilesRules = {
+  files: [`**/*.${fileTypes}`],
+  rules: {
+    'lit-a11y/no-autofocus': 'off',
+    'lit-a11y/anchor-is-valid': 'off',
+    'lit-a11y/click-events-have-key-events': 'off',
+  },
+};

package/src/lit.d.ts

@@ -0,0 +1,12 @@
+/** @type {import('eslint').Linter.Config} */
+export const litFilesConfig: import('eslint').Linter.Config;
+export namespace litFilesRules {
+  let files: string[];
+  let rules: {
+    'lit/lifecycle-super': string;
+    'lit/no-native-attributes': string;
+    'lit/no-useless-template-literals': string;
+    'lit/binding-positions': string;
+    'lit/no-invalid-html': string;
+  };
+}

package/src/lit.js

@@ -0,0 +1,23 @@
+import { configs as lit } from 'eslint-plugin-lit';
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// eslint-plugin-lit
+// ──────────────────────────────────────────────────────────────
+//
+/** @type {import('eslint').Linter.Config} */
+export const litFilesConfig = {
+  ...lit['flat/recommended'],
+  files: [`**/*.${fileTypes}`],
+};
+
+export const litFilesRules = {
+  files: [`**/*.${fileTypes}`],
+  rules: {
+    'lit/lifecycle-super': 'error',
+    'lit/no-native-attributes': 'off',
+    'lit/no-useless-template-literals': 'off',
+    'lit/binding-positions': 'off',
+    'lit/no-invalid-html': 'off',
+  },
+};

package/src/rules.d.ts

@@ -0,0 +1,12 @@
+export namespace globalRulesConfig {
+  let rules: {
+    'no-unused-expressions': (
+      | string
+      | {
+          allowShortCircuit: boolean;
+          allowTernary: boolean;
+        }
+    )[];
+    'no-empty-function': string;
+  };
+}

package/src/rules.js

@@ -0,0 +1,14 @@
+//
+// ──────────────────────────────────────────────────────────────
+// Global Rules
+// ──────────────────────────────────────────────────────────────
+//
+export const globalRulesConfig = {
+  rules: {
+    'no-unused-expressions': [
+      'error',
+      { allowShortCircuit: true, allowTernary: true },
+    ],
+    'no-empty-function': 'error',
+  },
+};

package/src/test.d.ts

@@ -0,0 +1,7 @@
+export namespace testFilesRules {
+  let files: string[];
+  let rules: {
+    '@typescript-eslint/no-explicit-any': string;
+    'no-unused-expressions': string;
+  };
+}

package/src/test.js

@@ -0,0 +1,14 @@
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// Test Files
+// ──────────────────────────────────────────────────────────────
+//
+export const testFilesRules = {
+  files: [`**/test/**/*.${fileTypes}`],
+
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    'no-unused-expressions': 'off',
+  },
+};

package/src/typescript.d.ts

@@ -0,0 +1,16 @@
+export function createTsFilesConfig(
+  tsconfigRootDir?: string,
+): import('eslint').Linter.Config[];
+export namespace tsFilesRules {
+  let files: string[];
+  let rules: {
+    '@typescript-eslint/no-floating-promises': string;
+    '@typescript-eslint/ban-types': string;
+    '@typescript-eslint/explicit-function-return-type': string;
+    '@typescript-eslint/explicit-module-boundary-types': string;
+    '@typescript-eslint/no-empty-function': string;
+    '@typescript-eslint/no-non-null-assertion': string;
+    '@typescript-eslint/class-literal-property-style': string;
+    '@typescript-eslint/no-unused-expressions': string;
+  };
+}

package/src/typescript.js

@@ -0,0 +1,52 @@
+import { configs as tseslint } from 'typescript-eslint';
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// typescript-eslint
+// ──────────────────────────────────────────────────────────────
+//
+/**
+ * @param {string} [tsconfigRootDir]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const createTsFilesConfig = (tsconfigRootDir) =>
+  [...tseslint.strict, ...tseslint.stylistic].map((conf) => ({
+    ...conf,
+    files: ['**/*.ts'],
+
+    // @ts-ignore
+    ...(conf.languageOptions && {
+      languageOptions: {
+        // @ts-ignore
+        ...conf.languageOptions,
+
+        parserOptions: {
+          // @ts-ignore
+          ...conf.languageOptions.parserOptions,
+
+          projectService: {
+            allowDefaultProject: [
+              `*.config.${fileTypes}`,
+              `*.conf.${fileTypes}`,
+            ],
+          },
+
+          ...(tsconfigRootDir && { tsconfigRootDir }),
+        },
+      },
+    }),
+  }));
+
+export const tsFilesRules = {
+  files: ['**/*.ts'],
+  rules: {
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/class-literal-property-style': 'off',
+    '@typescript-eslint/no-unused-expressions': 'off',
+  },
+};

package/src/wc.d.ts

@@ -0,0 +1,8 @@
+/** @type {import('eslint').Linter.Config} */
+export const wcFilesConfig: import('eslint').Linter.Config;
+export namespace wcFilesRules {
+  let files: string[];
+  let rules: {
+    'wc/no-constructor-attributes': string;
+  };
+}

package/src/wc.js

@@ -0,0 +1,19 @@
+import { configs as wc } from 'eslint-plugin-wc';
+import { fileTypes } from './base.js';
+//
+// ──────────────────────────────────────────────────────────────
+// eslint-plugin-wc
+// ──────────────────────────────────────────────────────────────
+//
+/** @type {import('eslint').Linter.Config} */
+export const wcFilesConfig = {
+  ...wc['flat/recommended'],
+  files: [`**/*.${fileTypes}`],
+};
+
+export const wcFilesRules = {
+  files: [`**/*.${fileTypes}`],
+  rules: {
+    'wc/no-constructor-attributes': 'warn',
+  },
+};