@mtth/eslint-plugin 0.1.14 → 0.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021, Matthieu Monsch.
+Copyright (c) 2025, Matthieu Monsch.
 
 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

package/README.md

@@ -10,50 +10,15 @@ First, install ESLint and this plugin:
 $ npm i -D eslint @mtth/eslint-plugin
 ```
 
-Then reference this plugin in `.eslintrc.js`:
-
-```js
-module.exports = {
-  plugins: ['@mtth'],
-  extends: ['plugin:@mtth/typescript'], // One of the configurations below.
-  // Project-specific configuration...
-};
+Then reference this plugin in `.eslint.config.mjs`:
+
+```javascript
+import configs from '@mtth/eslint-plugin';
+
+export default config;
 ```
 
 ## Configurations
 
 + `typescript`, defaults for a TypeScript project. The corresponding parser is
   included in the plugin.
-
-## Next steps
-
-This plugin is best used in combination with [this prettier
-configuration](https://github.com/mtth/prettier-typescript) and the following
-convenience scripts:
-
-```json
-{
-  "fix": "npm run pretty && npm run lint -- --fix",
-  "lint": "eslint '{src,test}/**/*.{ts,tsx}'",
-  "pretty": "prettier --write '{src,test}/**/*.{ts,tsx}'"
-}
-```
-
-We also recommend enabling pre-commit hooks with `husky` and `lint-staged`. For
-example, within your `package.json`:
-
-```json
-{
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.ts": [
-      "prettier --write",
-      "eslint --fix"
-    ]
-  }
-}
-```

package/index.js

@@ -1,124 +1,153 @@
-module.exports = {
-  configs: {
-    typescript: {
-      parser: '@typescript-eslint/parser',
-      plugins: [
-        '@typescript-eslint',
-        'simple-import-sort',
-      ],
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended',
+import eslint from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import unusedImports from 'eslint-plugin-unused-imports';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['**/*.gen.*'],
+  },
+  eslint.configs.recommended,
+  tseslint.configs.strict,
+  tseslint.configs.stylistic,
+  {
+    plugins: {'@stylistic': stylistic},
+    rules: {
+      '@stylistic/member-delimiter-style': 'error',
+      '@stylistic/quotes': ['error', 'single'],
+      '@stylistic/semi': 'error',
+      '@stylistic/type-annotation-spacing': 'error',
+    },
+  },
+  {
+    plugins: {'simple-import-sort': simpleImportSort},
+    rules: {
+      'simple-import-sort/exports': 'error',
+      'simple-import-sort/imports': 'error',
+      'sort-imports': 'off',
+    },
+  },
+  {
+    plugins: {'unused-imports': unusedImports},
+    rules: {
+      '@typescript-eslint/no-unused-vars': 'off',
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      }],
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/array-type': ['error', {
+        default: 'array',
+        readonly: 'generic',
+      }],
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+      '@typescript-eslint/consistent-type-assertions': ['error', {
+        assertionStyle: 'as',
+        objectLiteralTypeAssertions: 'never',
+      }],
+      '@typescript-eslint/consistent-type-definitions': ['error',
+        'interface',
       ],
-      rules: {
-        '@typescript-eslint/array-type': ['error', {
-          default: 'array',
-          readonly: 'generic',
-        }],
-        '@typescript-eslint/consistent-type-assertions': ['error', {
-          assertionStyle: 'as',
-          objectLiteralTypeAssertions: 'never',
-        }],
-        '@typescript-eslint/consistent-type-definitions': ['error',
-          'interface',
-        ],
-        '@typescript-eslint/explicit-function-return-type': 'error',
-        '@typescript-eslint/member-delimiter-style': 'error',
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/no-misused-new': 'error',
-        '@typescript-eslint/no-this-alias': 'error',
-        '@typescript-eslint/no-unused-vars': ['error', {
-          argsIgnorePattern: '^_',
-          caughtErrors: 'all',
-          caughtErrorsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-        }],
-        '@typescript-eslint/no-use-before-define': 'off',
-        '@typescript-eslint/no-useless-constructor': 'error',
-        '@typescript-eslint/prefer-function-type': 'error',
-        '@typescript-eslint/prefer-optional-chain': 'error',
-        '@typescript-eslint/quotes': ['error', 'single'],
-        '@typescript-eslint/semi': 'error',
-        '@typescript-eslint/type-annotation-spacing': 'error',
-        '@typescript-eslint/unified-signatures': 'error',
-        'arrow-parens': 'error',
-        'consistent-return': 'error',
-        'comma-dangle': ['error', {
-          'arrays': 'always-multiline',
-          'objects': 'always-multiline',
-          'imports': 'always-multiline',
-          'exports': 'always-multiline',
-          'functions': 'never',
-        }],
-        'curly': 'error',
-        'default-case-last': 'error',
-        'default-param-last': 'error',
-        'dot-location': ['error', 'property'],
-        'dot-notation': 'off', // https://234.fyi/1PcbRPGcR
-        'eqeqeq': ['error', 'smart'],
-        'max-len': ['error', {
-          ignorePattern: 'eslint-disable',
-          ignoreTrailingComments: true,
-          ignoreUrls: true,
-        }],
-        'no-alert': 'error',
-        'no-caller': 'error',
-        'no-constructor-return': 'error',
-        'no-duplicate-imports': 'error',
-        'no-else-return': 'error',
-        'no-eq-null': 'error',
-        'no-eval': 'error',
-        'no-extra-bind': 'error',
-        'no-extra-label': 'error',
-        'no-implicit-globals': 'error',
-        'no-implied-eval': 'error',
-        'no-label-var': 'error',
-        'no-loss-of-precision': 'error',
-        'no-multi-spaces': 'error',
-        'no-new-wrappers': 'error',
-        'no-promise-executor-return': 'error',
-        'no-restricted-globals': [
-          // https://github.com/microsoft/TypeScript/issues/18433
-          'error',
-          'closed',
-          'event',
-          'fdescribe',
-          'length',
-          'location',
-          'name',
-          'parent',
-          'top',
-        ],
-        'no-self-compare': 'error',
-        'no-sequences': 'error',
-        'no-tabs': 'error',
-        'no-throw-literal': 'error',
-        'no-trailing-spaces': 'error',
-        'no-undef-init': 'error',
-        'no-unneeded-ternary': ['error', {defaultAssignment: false}],
-        'no-unused-expressions': 'error',
-        'no-useless-call': 'error',
-        'no-useless-computed-key': 'error',
-        'no-useless-rename': 'error',
-        'no-var': 'error',
-        'no-whitespace-before-property': 'error',
-        'object-shorthand': ['error', 'always', {avoidQuotes: true}],
-        'prefer-const': 'error',
-        'radix': 'error',
-        'require-await': 'off',
-        'simple-import-sort/exports': 'error',
-        'simple-import-sort/imports': 'error',
-        'sort-imports': 'off',
-      },
-      overrides: [
-        {
-          files: ['**/test/**/*.ts'],
-          rules: {
-            '@typescript-eslint/explicit-function-return-type': 'off',
-            '@typescript-eslint/no-non-null-assertion': 'off',
-          }
-        },
+      '@typescript-eslint/no-dynamic-delete': 'off',
+      '@typescript-eslint/explicit-function-return-type': ['error', {
+        allowConciseArrowFunctionExpressionsStartingWithVoid: true,
+        allowExpressions: true,
+      }],
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-empty-object-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-invalid-void-type': 'off', // Prevents void operator
+      '@typescript-eslint/no-misused-new': 'error',
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-this-alias': 'off',
+      '@typescript-eslint/no-unsafe-function-type': 'off',
+      '@typescript-eslint/no-use-before-define': 'off',
+      '@typescript-eslint/no-useless-constructor': 'error',
+      '@typescript-eslint/prefer-function-type': 'error',
+      '@typescript-eslint/prefer-optional-chain': 'off', // Requires typing
+      '@typescript-eslint/unified-signatures': 'error',
+      'arrow-parens': 'error',
+      'consistent-return': 'error',
+      'comma-dangle': ['error', {
+        'arrays': 'always-multiline',
+        'objects': 'always-multiline',
+        'imports': 'always-multiline',
+        'exports': 'always-multiline',
+        'functions': 'never',
+      }],
+      'curly': 'error',
+      'default-case-last': 'error',
+      'default-param-last': 'error',
+      'dot-location': ['error', 'property'],
+      'dot-notation': 'off', // https://234.fyi/1PcbRPGcR
+      'eqeqeq': ['error', 'smart'],
+      'max-len': ['error', {
+        code: 100, // Add padding due to prettier sometimes going over
+        comments: 80,
+        ignorePattern: 'eslint-disable',
+        ignoreTrailingComments: true,
+        ignoreUrls: true,
+      }],
+      'no-alert': 'error',
+      'no-caller': 'error',
+      'no-constructor-return': 'error',
+      'no-duplicate-imports': 'error',
+      'no-else-return': 'error',
+      'no-eq-null': 'off', // Handled by eqeqeq.
+      'no-eval': 'error',
+      'no-extra-bind': 'error',
+      'no-extra-label': 'error',
+      'no-implicit-globals': 'error',
+      'no-implied-eval': 'error',
+      'no-label-var': 'error',
+      'no-loss-of-precision': 'error',
+      'no-multi-spaces': 'error',
+      'no-new-wrappers': 'error',
+      'no-promise-executor-return': 'error',
+      'no-restricted-globals': [
+        // https://github.com/microsoft/TypeScript/issues/18433
+        'error',
+        'closed',
+        'event',
+        'fdescribe',
+        'length',
+        'location',
+        'name',
+        'parent',
+        'top',
       ],
+      'no-self-compare': 'error',
+      'no-sequences': 'error',
+      'no-tabs': 'error',
+      'no-throw-literal': 'error',
+      'no-trailing-spaces': 'error',
+      'no-undef-init': 'error',
+      'no-unneeded-ternary': ['error', {defaultAssignment: false}],
+      'no-unused-expressions': 'off',
+      'no-useless-call': 'error',
+      'no-useless-computed-key': 'error',
+      'no-useless-rename': 'error',
+      'no-var': 'error',
+      'no-whitespace-before-property': 'error',
+      'object-shorthand': ['error', 'always', {avoidQuotes: true}],
+      'prefer-const': 'error',
+      'radix': 'error',
+      'require-await': 'off',
     },
   },
-};
+  {
+    files: ['**/test/**/*.ts'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+    }
+  },
+);

package/package.json

@@ -1,26 +1,28 @@
 {
   "name": "@mtth/eslint-plugin",
-  "version": "0.1.14",
-  "description": "Common linting configuration",
-  "homepage": "https://github.com/mtth/eslint-plugin",
+  "version": "0.2.0",
+  "repository": "github:mtth/sdk.ts",
+  "description": "Shared linting config",
   "keywords": [
     "eslint"
   ],
-  "author": {
-    "name": "Matthieu Monsch",
-    "email": "mtth@apache.org"
-  },
+  "author": "Matthieu Monsch <mtth@apache.org>",
+  "license": "MIT",
+  "type": "module",
+  "exports": "./index.js",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
-    "@typescript-eslint/parser": "^5.13.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0"
+    "@eslint/js": "^9.20.0",
+    "@stylistic/eslint-plugin": "^3.1.0",
+    "@typescript-eslint/parser": "^8.24.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "typescript-eslint": "^8.24.0"
   },
   "peerDependencies": {
-    "eslint": "^8.10.0"
+    "eslint": "^9.15.0"
   },
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/mtth/eslint-plugin.git"
+  "devDependencies": {
+    "eslint": "^9.20.1",
+    "typescript": "^5.7.3"
   }
-}
+}

package/.github/workflows/ci.yml

@@ -1,77 +0,0 @@
-name: CI
-on:
-  push:
-    branches:
-      - main
-jobs:
-  tag:
-    name: Tag commit
-    runs-on: ubuntu-latest
-    timeout-minutes: 1
-    outputs:
-      tagged: ${{ format(steps.check-tag.outputs.exists == 'false') }}
-    steps:
-      - name: Check out
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Setup Node
-        uses: actions/setup-node@v2
-      - name: Extract version
-        run: |
-          PACKAGE_VERSION="$(node -p 'require("./package.json").version')"
-          echo "PACKAGE_VERSION=$PACKAGE_VERSION" >> $GITHUB_ENV
-      - name: Check tag exists
-        uses: mukunku/tag-exists-action@v1.0.0
-        id: check-tag
-        with:
-          tag: v${{ env.PACKAGE_VERSION }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Create tag
-        if: steps.check-tag.outputs.exists == 'false'
-        uses: pkgdeps/git-tag-action@v2
-        with:
-          git_commit_sha: ${{ github.sha }}
-          git_tag_prefix: v
-          github_repo: ${{ github.repository }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          version: ${{ env.PACKAGE_VERSION }}
-  publish-gh:
-    name: Publish package to GitHub
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    needs: tag
-    if: needs.tag.outputs.tagged == 'true'
-    steps:
-      - name: Check out
-        uses: actions/checkout@v2
-      - name: Setup Node
-        uses: actions/setup-node@v2
-        with:
-          registry-url: https://npm.pkg.github.com
-      - name: Install
-        run: npm i
-      - name: Publish to GitHub
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  publish-npm:
-    name: Publish package to NPM
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    needs: tag
-    if: needs.tag.outputs.tagged == 'true'
-    steps:
-      - name: Check out
-        uses: actions/checkout@v2
-      - name: Setup Node
-        uses: actions/setup-node@v2
-        with:
-          registry-url: https://registry.npmjs.org
-      - name: Install
-        run: npm i
-      - name: Publish to NPM
-        run: npm publish --access=public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}