@enke.dev/lint 0.6.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 David Enke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# @enke/lint
+
+## Install packages
+
+Make sure to install the necessary peer dependencies `eslint`, `prettier` and `typescript`.
+
+```bash
+npm i -D @enke/lint eslint prettier typescript
+```
+
+## Prepare config
+
+Create a `eslint.config.js` file in the root of your project and add the following content:
+
+```js
+import config from '@enke/lint';
+
+export default config;
+```
+
+## Using Typescript
+
+If you intend to use Typescript for your config file, you just have to install `typescript`.
+
+Your config file can then renamed to `eslint.config.ts` and look like this at minimum:
+
+```ts
+import config from '@enke/lint';
+export default config;
+```
+
+But you may want to modify the config to your needs:
+
+```ts
+import config from '@enke/lint';
+import type { Linter } from 'eslint';
+
+export default [
+  ...config,
+  // ignore generated stuff
+  { ignores: ['src/generated'] },
+  // override rules for test files with mocha / chai
+  {
+    files: ['**/*.spec.ts'],
+    rules: {
+      '@typescript-eslint/no-unused-expressions': ['off'],
+    },
+  },
+] satisfies Linter.Config[];
+```
+
+> Until eslint 9.18.0 some hacks have been necessary to make this work.
+> If your stuck to an older version, you can use a [release prior 0.3.0](https://www.npmjs.com/package/@enke/lint/v/0.2.2).
+
+## Using monorepos
+
+Like the experimental typescript config flag above, the VSCode Eslint plugin can be configured to pick up the packages correctly by setting:
+
+```json
+{
+  "eslint.workingDirectories": ["./packages/foo", "./packages/bar"]
+}
+```

package/eslint-plugins.d.ts

@@ -0,0 +1,19 @@
+declare module 'eslint-plugin-import-extensions' {
+  import type { ESLint } from 'eslint';
+
+  const plugin: ESLint.Plugin;
+
+  export default plugin;
+}
+
+declare module 'eslint-plugin-import' {
+  import type { Linter } from 'eslint';
+
+  export const js: {
+    readonly flatConfigs: {
+      readonly recommended: { readonly rules: Readonly<Linter.RulesRecord> };
+    };
+  };
+
+  export default js;
+}

package/eslint.config.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;

package/eslint.config.js

@@ -0,0 +1,101 @@
+/// <reference types="./eslint-plugins.d.ts" />
+import { fixupPluginRules } from '@eslint/compat';
+import eslintJs from '@eslint/js';
+import eslintJson from '@eslint/json';
+import eslintPluginImport from 'eslint-plugin-import';
+import eslintPluginImportExtension from 'eslint-plugin-import-extensions';
+import { configs as eslintPluginLitConfigs } from 'eslint-plugin-lit';
+import eslintPluginPackageJson 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';
+export default eslintTs.config(eslintJs.configs.recommended, ...eslintTs.configs.strict, ...eslintTs.configs.stylistic, eslintPluginPrettierRecommended, eslintPluginImport.flatConfigs.recommended, eslintPluginPackageJson.configs.recommended, eslintPluginLitConfigs['flat/recommended'], eslintPluginWebComponentsConfigs['flat/recommended'], {
+    ignores: ['node_modules/', 'dist/', 'lib/'],
+}, {
+    languageOptions: {
+        parserOptions: {
+            ecmaVersion: 'latest',
+            project: true,
+            sourceType: 'module',
+            tsconfigRootDir: './',
+        },
+    },
+}, {
+    plugins: {
+        'simple-import-sort': eslintPluginSimpleImportSort,
+        'unused-imports': eslintPluginUnusedImports,
+        'import-extensions': fixupPluginRules(eslintPluginImportExtension),
+    },
+}, {
+    settings: {
+        'import/resolver': {
+            typescript: true,
+            node: true,
+        },
+    },
+}, {
+    rules: {
+        // formatting
+        'linebreak-style': ['error', 'unix'],
+        quotes: ['error', 'single', { avoidEscape: true }],
+        semi: ['error', 'always'],
+        // import sorting
+        'simple-import-sort/imports': [
+            'error',
+            {
+                groups: [
+                    // Side effect imports.
+                    ['^\\u0000'],
+                    // Node.js builtins prefixed with `node:`.
+                    ['^node:'],
+                    // Packages.
+                    // Things that start with a letter (or digit or underscore), or `@` followed by a letter.
+                    ['^@?\\w'],
+                    // Absolute imports and other imports such as Vue-style `@/foo`.
+                    // Anything not matched in another group.
+                    ['^'],
+                    // Relative imports.
+                    // Anything that starts with a dot.
+                    ['^\\.'],
+                    // Assetic imports, most likely inline loaded style files for lit components
+                    // or raw loaded files like images, meta data or fonts.
+                    ['\\?(inline|raw)$'],
+                ],
+            },
+        ],
+        'simple-import-sort/exports': 'error',
+        // import extensions
+        'import-extensions/require-extensions': ['error', { expectedExtensions: ['js'] }],
+        'import-extensions/require-index': ['error', { expectedExtensions: ['js'] }],
+        // import rules
+        'import/enforce-node-protocol-usage': ['error', 'always'], // enforce node: import prefix
+        'import/consistent-type-specifier-style': ['error', 'prefer-top-level'], // type imports
+        'import/first': 'error',
+        'import/newline-after-import': 'error',
+        'import/no-duplicates': 'error',
+        'import/no-unresolved': 'error',
+        'import/extensions': ['error', 'ignorePackages', { ts: 'never', js: 'always' }],
+        'prettier/prettier': ['error', {}, { usePrettierrc: true }],
+        // unused imports
+        '@typescript-eslint/no-unused-vars': 'off',
+        'unused-imports/no-unused-vars': [
+            'error',
+            { argsIgnorePattern: '^_', varsIgnorePattern: '^_', caughtErrors: 'none' },
+        ],
+        'unused-imports/no-unused-imports': 'error',
+    },
+}, 
+// json files
+{
+    ...eslintJson.configs.recommended,
+    files: ['**/*.json'],
+    ignores: ['package-lock.json'],
+    language: 'json/json',
+    rules: {
+        'no-irregular-whitespace': 'off',
+        'import-extensions/require-extensions': 'off',
+        'import-extensions/require-index': 'off',
+    },
+});

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@enke.dev/lint",
+  "version": "0.6.4",
+  "description": "Meta package to provide linting for web projects",
+  "homepage": "https://github.com/enke-dev/lint",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/enke-dev/lint.git"
+  },
+  "files": [
+    "eslint.config.js",
+    "eslint.config.d.ts",
+    "eslint-plugins.d.ts",
+    "README.md"
+  ],
+  "type": "module",
+  "main": "eslint.config.js",
+  "types": "eslint.config.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "author": {
+    "name": "David Enke",
+    "email": "david@enke.dev"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "eslint": "^9.30.0",
+    "prettier": "^3.6.2"
+  },
+  "dependencies": {
+    "@eslint/compat": "^1.3.1",
+    "@eslint/js": "^9.30.0",
+    "@eslint/json": "^0.12.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-import-extensions": "^0.1.5",
+    "eslint-plugin-lit": "^2.1.1",
+    "eslint-plugin-package-json": "^0.42.0",
+    "eslint-plugin-prettier": "^5.5.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "eslint-plugin-wc": "^3.0.1",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.35.0"
+  },
+  "devDependencies": {
+    "@types/node": "22.15.33",
+    "typescript": "5.8.3"
+  }
+}