@enke.dev/lint 0.9.1 → 0.10.0

package/README.md

@@ -33,25 +33,16 @@ Your config file can then be renamed to `eslint.config.ts` and look like this at
 ```ts
 import config from '@enke.dev/lint';
 
-export default config;
-```
-
-You may want to modify the config to your needs, e.g. like this:
-
-```ts
-import config from '@enke.dev/lint';
-import { defineConfig } from 'eslint/config';
-
 export default defineConfig([
   // extend the base config
   ...config,
-  // ignore generated stuff
-  { ignores: ['src/generated'] },
-  // override rules for test files with mocha / chai
+  // configure typescript parser to your needs
   {
-    files: ['**/*.spec.ts'],
-    rules: {
-      '@typescript-eslint/no-unused-expressions': ['off'],
+    languageOptions: {
+      parserOptions: {
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
     },
   },
 ]);
@@ -89,3 +80,11 @@ export default defineConfig({ cssCustomPropertyPrefix: 'your-prefix' });
 ```
 
 For now, [no TypeScript support](https://github.com/stylelint/stylelint/issues/4940) is possible.
+
+## Development
+
+This repo self-tests the configuration by linting itself: `npm run lint`.\
+Therefore, a `text.config.ts` is used.
+
+And additionally, a naive test is in place to check that the linter actually finds issues: `npm run test`.\
+It uses the native Node test runner against some obviously faulty code in the `test` directory.

package/eslint.config.d.ts

@@ -1,2 +1,3 @@
-declare const _default: import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config<Linter.RulesRecord>[];
 export default _default;

package/eslint.config.js

@@ -1,48 +1,55 @@
 /// <reference types="./eslint-plugins.d.ts" />
+import { readFile } from 'node:fs/promises';
 import { fixupPluginRules } from '@eslint/compat';
-import eslintJs from '@eslint/js';
-import eslintJson from '@eslint/json';
-import { defineConfig } from 'eslint/config';
-import eslintPluginHtml from 'eslint-plugin-html';
+import eslintPluginJs from '@eslint/js';
+import eslintPluginJson from '@eslint/json';
+import eslintPluginHtml from '@html-eslint/eslint-plugin';
+import eslintParserHtml from '@html-eslint/parser';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import eslintPluginHtmlScripts from 'eslint-plugin-html';
 import eslintPluginImport from 'eslint-plugin-import';
 import eslintPluginImportExtension from 'eslint-plugin-import-extensions';
 import { configs as eslintPluginLitConfigs } from 'eslint-plugin-lit';
 import { configs as eslintPluginLitA11yConfigs } from 'eslint-plugin-lit-a11y';
-import { configs as eslintPluginPackageJsonConfigs } from 'eslint-plugin-package-json';
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
 import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort';
 import eslintPluginUnusedImports from 'eslint-plugin-unused-imports';
 import { configs as eslintPluginWebComponentsConfigs } from 'eslint-plugin-wc';
 import eslintTs from 'typescript-eslint';
+// collect gitignore excludes
+const gitIgnores = await readFile(new URL('./.gitignore', import.meta.url), 'utf-8');
+const gitIgnoreLines = gitIgnores
+    .split('\n')
+    .map(line => line.trim().replace(/^\//, ''))
+    .filter(line => line && !line.startsWith('#'));
+// shared parser options
+const parserOptions = {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+};
 export default defineConfig([
-    eslintJs.configs.recommended,
-    ...eslintTs.configs.strict,
-    ...eslintTs.configs.stylistic,
+    globalIgnores([...gitIgnoreLines, 'dist/']),
     eslintPluginPrettierRecommended,
-    eslintPluginImport.flatConfigs.recommended,
-    {
-        ignores: ['node_modules/', 'dist/'],
-    },
     // Javascript and Typescript files
     {
-        files: ['**/*.{js,ts}'],
-        ...eslintPluginWebComponentsConfigs['flat/recommended'],
-        ...eslintPluginLitConfigs['flat/recommended'],
-        ...eslintPluginLitA11yConfigs.recommended,
+        files: ['**/*.js', '**/*.ts'],
+        extends: [
+            eslintPluginJs.configs.recommended,
+            ...eslintTs.configs.strict,
+            ...eslintTs.configs.stylistic,
+            eslintPluginWebComponentsConfigs['flat/recommended'],
+            eslintPluginLitConfigs['flat/recommended'],
+            eslintPluginLitA11yConfigs.recommended,
+            eslintPluginImport.flatConfigs.recommended,
+        ],
         plugins: {
             'simple-import-sort': eslintPluginSimpleImportSort,
             'unused-imports': eslintPluginUnusedImports,
             'import-extensions': fixupPluginRules(eslintPluginImportExtension),
+            html: eslintPluginHtml,
+            htmlScripts: eslintPluginHtmlScripts,
         },
-        languageOptions: {
-            parserOptions: {
-                ecmaVersion: 'latest',
-                project: true,
-                requireConfigFile: false,
-                sourceType: 'module',
-                tsconfigRootDir: import.meta.dirname,
-            },
-        },
+        languageOptions: { parserOptions },
         settings: {
             'import/resolver': {
                 typescript: true,
@@ -60,6 +67,16 @@ export default defineConfig([
             'linebreak-style': ['error', 'unix'],
             quotes: ['error', 'single', { avoidEscape: true }],
             semi: ['error', 'always'],
+            'no-console': 'error',
+            // inline html
+            'html/require-img-alt': 'error',
+            'html/no-multiple-h1': 'error',
+            'html/no-extra-spacing-attrs': 'error',
+            'html/no-duplicate-id': 'error',
+            'html/require-li-container': 'error',
+            'html/no-obsolete-tags': 'error',
+            'html/require-closing-tags': 'error',
+            'html/no-duplicate-attrs': 'error',
             // import sorting
             'simple-import-sort/imports': [
                 'error',
@@ -111,21 +128,49 @@ export default defineConfig([
     // HTML files
     {
         files: ['**/*.html'],
-        plugins: { html: eslintPluginHtml },
+        plugins: {
+            html: eslintPluginHtml,
+            htmlScripts: eslintPluginHtmlScripts,
+        },
+        extends: [eslintPluginHtml.configs['flat/recommended']],
+        language: 'html/html',
+        languageOptions: {
+            parser: eslintParserHtml,
+            parserOptions,
+        },
+        settings: {
+            'html/indent': '+2',
+            'html/lowercase': 'error',
+            'html/no-accesskey-attrs': 'error',
+            'html/no-aria-hidden-body': 'error',
+            'html/no-aria-hidden-on-focusable': 'error',
+            'html/no-duplicate-class': 'error',
+            'html/no-duplicate-in-head': 'error',
+            'html/no-empty-headings': 'error',
+            'html/no-invalid-entities': 'error',
+            'html/no-heading-inside-button': 'error',
+            'html/no-invalid-entity': 'error',
+            'html/no-invalid-role': 'error',
+            'html/no-nested-interactive': 'error',
+            'html/no-multiple-empty-lines': 'error',
+            'html/no-target-blank': 'error',
+            'html/no-trailing-spaces': 'error',
+            'html/report-bad-indent': 'error',
+            'html/require-input-label': 'error',
+        },
+        rules: {
+            'html/indent': ['error', 2],
+        },
     },
     // JSON files
     {
-        ...eslintPluginPackageJsonConfigs.recommended,
-        ...eslintJson.configs.recommended,
-        ignores: ['package-lock.json'],
+        files: ['**/*.json'],
         language: 'json/json',
+        ignores: ['package-lock.json'],
+        plugins: { json: eslintPluginJson },
+        extends: [eslintPluginJson.configs.recommended],
         rules: {
-            'no-irregular-whitespace': 'off',
-            'import-extensions/require-extensions': 'off',
-            'import-extensions/require-index': 'off',
-        },
-        settings: {
-            'html/html-extensions': ['.html'],
+            'json/top-level-interop': 'error',
         },
     },
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enke.dev/lint",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Meta package to provide linting for web projects",
   "homepage": "https://github.com/enke-dev/lint",
   "repository": {
@@ -19,10 +19,11 @@
   "main": "eslint.config.js",
   "types": "eslint.config.d.ts",
   "scripts": {
-    "lint": "eslint -c eslint.config.ts ./*.config.ts",
+    "lint": "eslint -c test.config.ts .",
+    "test": "node --experimental-strip-types --test test.run.ts",
     "inspect": "./node_modules/.bin/eslint-config-inspector --config eslint.config.ts",
-    "dev": "tsc --watch",
-    "build": "tsc"
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "build": "tsc -p tsconfig.build.json"
   },
   "author": {
     "name": "David Enke",
@@ -64,6 +65,8 @@
   },
   "devDependencies": {
     "@eslint/config-inspector": "1.2.0",
+    "@html-eslint/eslint-plugin": "0.46.2",
+    "@html-eslint/parser": "0.46.2",
     "@types/node": "24.3.1",
     "eslint": "9.35.0",
     "jiti": "2.5.1",