eslint-config-opencover 3.0.5

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 OpenCover
+
+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,80 @@
+# eslint-config-opencover
+
+ESLint flat config for OpenCover's TypeScript coding style.
+
+## Installation
+
+```bash
+pnpm add -D eslint-config-opencover eslint typescript
+```
+
+## Usage
+
+### TypeScript project
+
+```javascript
+// eslint.config.mjs
+import opencover from 'eslint-config-opencover';
+
+export default [...opencover];
+```
+
+### React project
+
+```javascript
+// eslint.config.mjs
+import opencover from 'eslint-config-opencover';
+import react from 'eslint-config-opencover/react';
+
+export default [...opencover, ...react];
+```
+
+### Next.js project
+
+Install Next.js ESLint config alongside this package:
+
+```bash
+pnpm add -D eslint-config-next
+```
+
+```javascript
+// eslint.config.mjs
+import opencover from 'eslint-config-opencover';
+import nextVitals from 'eslint-config-next/core-web-vitals';
+import nextTs from 'eslint-config-next/typescript';
+
+export default [...nextVitals, ...nextTs, ...opencover];
+```
+
+OpenCover's config should come **last** so its rules take precedence.
+
+## Overriding rules
+
+Each config object in the exported array has a `name` property for debugging (for example in ESLint's config inspector), but flat config overrides are matched by `files`/`ignores`, not by `name`. To override TypeScript-specific rules, add a later config object that matches the same files:
+
+```javascript
+// eslint.config.mjs
+import opencover from 'eslint-config-opencover';
+
+export default [
+  ...opencover,
+  {
+    files: ['**/*.{ts,tsx,mts,cts}'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+    },
+  },
+];
+```
+
+Later matching config objects override earlier ones for those files.
+
+Available config names:
+
+| Name                   | Description                          |
+| ---------------------- | ------------------------------------ |
+| `opencover`            | Base rules (stylistic, imports, etc) |
+| `opencover/gitignore`  | Ignores files from `.gitignore`      |
+| `opencover/typescript` | TypeScript-specific rules            |
+| `opencover/test`       | Test file rules (vitest)             |
+| `opencover/react`      | React-specific TSX rules             |

package/dist/globs.d.ts

@@ -0,0 +1,6 @@
+export declare const GLOB_TS: string[];
+export declare const GLOB_JSX: string[];
+export declare const GLOB_TSX: string[];
+export declare const GLOB_TEST: string[];
+export declare const GLOB_EXCLUDE: string[];
+//# sourceMappingURL=globs.d.ts.map

package/dist/globs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globs.d.ts","sourceRoot":"","sources":["../src/globs.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAiC,CAAC;AAEtD,eAAO,MAAM,QAAQ,UAAe,CAAC;AAErC,eAAO,MAAM,QAAQ,UAAe,CAAC;AAErC,eAAO,MAAM,SAAS,UAA+F,CAAC;AAEtH,eAAO,MAAM,YAAY,UAkBxB,CAAC"}

package/dist/globs.js

@@ -0,0 +1,23 @@
+export const GLOB_TS = ['**/*.?([cm])ts', '**/*.tsx'];
+export const GLOB_JSX = ['**/*.jsx'];
+export const GLOB_TSX = ['**/*.tsx'];
+export const GLOB_TEST = ['**/*.spec.?([cm])[jt]s', '**/*.spec.[jt]sx', '**/*.test.?([cm])[jt]s', '**/*.test.[jt]sx'];
+export const GLOB_EXCLUDE = [
+    '**/dist',
+    '**/.dist',
+    '**/coverage',
+    '**/build',
+    '**/.cache',
+    '**/.nuxt',
+    '**/.next',
+    '**/.vercel',
+    '**/.changeset',
+    '**/.idea',
+    '**/.output',
+    '**/.vitepress/cache',
+    '**/.vscode',
+    '**/__snapshots__',
+    '**/*.min.*',
+    '**/__fixtures__',
+    '**/fixtures/**',
+];

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIrC,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EA0J1B,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,164 @@
+import eslint from '@eslint/js';
+import stylisticPlugin from '@stylistic/eslint-plugin';
+import vitest from '@vitest/eslint-plugin';
+import gitignore from 'eslint-config-flat-gitignore';
+import { globalIgnores } from 'eslint/config';
+import { flatConfigs as importPlugin } from 'eslint-plugin-import-x';
+import unicornPlugin from 'eslint-plugin-unicorn';
+import { configs as tseslint } from 'typescript-eslint';
+import prettier from 'eslint-config-prettier/flat';
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript';
+import { GLOB_EXCLUDE, GLOB_TEST, GLOB_TS } from './globs.js';
+const config = [
+    eslint.configs.recommended,
+    stylisticPlugin.configs.recommended,
+    importPlugin.recommended,
+    unicornPlugin.configs.recommended,
+    {
+        files: GLOB_TEST,
+        ...vitest.configs.recommended,
+    },
+    ...tseslint.strictTypeChecked.map((config) => ({
+        files: GLOB_TS,
+        ...config,
+    })),
+    {
+        files: GLOB_TS,
+        ...importPlugin.typescript,
+    },
+    {
+        files: GLOB_TS,
+        settings: {
+            'import-x/resolver-next': [createTypeScriptImportResolver()],
+        },
+    },
+    {
+        name: 'opencover',
+        rules: {
+            'capitalized-comments': [
+                'warn',
+                'always',
+                {
+                    ignoreConsecutiveComments: true,
+                },
+            ],
+            'no-console': ['error', { allow: ['warn', 'error'] }],
+            'no-restricted-syntax': [
+                'error',
+                {
+                    selector: 'TSEnumDeclaration',
+                    message: 'Enums are not allowed.',
+                },
+            ],
+            'no-unneeded-ternary': 'error',
+            'no-use-before-define': 'error',
+            '@stylistic/padding-line-between-statements': [
+                'error',
+                { blankLine: 'always', prev: '*', next: ['function', 'class', 'export'] },
+                { blankLine: 'always', prev: ['function', 'class', 'export'], next: '*' },
+                { blankLine: 'always', prev: '*', next: 'if' },
+                { blankLine: 'always', prev: 'block-like', next: 'if' },
+                { blankLine: 'always', prev: 'if', next: '*' },
+            ],
+            'import-x/order': [
+                'warn',
+                {
+                    pathGroups: [
+                        {
+                            pattern: '@/**',
+                            group: 'parent',
+                            position: 'before',
+                        },
+                        {
+                            pattern: '@tests/**',
+                            group: 'parent',
+                            position: 'before',
+                        },
+                        {
+                            pattern: '@data/**',
+                            group: 'parent',
+                            position: 'before',
+                        },
+                    ],
+                },
+            ],
+            'import-x/no-unresolved': 'off',
+            'unicorn/prevent-abbreviations': 'off',
+            'unicorn/no-array-for-each': 'off',
+            'unicorn/no-array-reduce': 'off',
+            'unicorn/no-null': 'off',
+        },
+    },
+    {
+        name: 'opencover/typescript',
+        files: GLOB_TS,
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+            },
+        },
+        rules: {
+            '@typescript-eslint/consistent-type-imports': [
+                'error',
+                { prefer: 'type-imports', disallowTypeAnnotations: false },
+            ],
+            '@typescript-eslint/explicit-function-return-type': 'error',
+            '@typescript-eslint/explicit-member-accessibility': [
+                'error',
+                {
+                    accessibility: 'explicit',
+                    overrides: {
+                        constructors: 'off',
+                    },
+                },
+            ],
+            '@typescript-eslint/explicit-module-boundary-types': 'error',
+            '@typescript-eslint/member-ordering': 'error',
+            '@typescript-eslint/no-unused-vars': [
+                'error',
+                {
+                    argsIgnorePattern: '^_',
+                    varsIgnorePattern: '^_',
+                    destructuredArrayIgnorePattern: '^_',
+                    caughtErrorsIgnorePattern: '^_',
+                },
+            ],
+            'no-use-before-define': 'off',
+            '@typescript-eslint/no-use-before-define': 'error',
+            '@typescript-eslint/no-restricted-types': [
+                'error',
+                {
+                    types: {
+                        Map: { message: 'Map is not allowed. Use Object instead.' },
+                    },
+                },
+            ],
+            '@typescript-eslint/prefer-nullish-coalescing': [
+                'error',
+                {
+                    ignoreConditionalTests: true,
+                    ignoreIfStatements: true,
+                    ignorePrimitives: {
+                        boolean: true,
+                    },
+                },
+            ],
+        },
+    },
+    {
+        name: 'opencover/test',
+        files: GLOB_TEST,
+        rules: {
+            'vitest/padding-around-before-all-blocks': 'error',
+            'vitest/padding-around-describe-blocks': 'error',
+            'vitest/padding-around-before-each-blocks': 'error',
+            'vitest/padding-around-after-all-blocks': 'error',
+            'vitest/padding-around-after-each-blocks': 'error',
+            'vitest/padding-around-test-blocks': 'error',
+        },
+    },
+    prettier,
+    globalIgnores(GLOB_EXCLUDE),
+    gitignore({ name: 'opencover/gitignore', strict: false }),
+];
+export default config;

package/dist/react.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const reactConfig: Linter.Config[];
+export default reactConfig;
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGrC,QAAA,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EA+B/B,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/react.js

@@ -0,0 +1,36 @@
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import { GLOB_JSX, GLOB_TSX } from './globs.js';
+const reactConfig = [
+    {
+        files: [GLOB_JSX, GLOB_TSX],
+        settings: {
+            react: {
+                version: 'detect',
+            },
+        },
+    },
+    react.configs.flat.recommended,
+    react.configs.flat['jsx-runtime'],
+    reactHooks.configs.flat.recommended,
+    {
+        name: 'opencover/react',
+        files: GLOB_TSX,
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+            },
+        },
+        rules: {
+            '@typescript-eslint/no-misused-promises': [
+                'error',
+                {
+                    checksVoidReturn: {
+                        attributes: false,
+                    },
+                },
+            ],
+        },
+    },
+];
+export default reactConfig;

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "eslint-config-opencover",
+  "version": "3.0.5",
+  "type": "module",
+  "description": "OpenCover specific linting rules for ESLint",
+  "author": {
+    "name": "OpenCover",
+    "email": "team@opencover.com",
+    "url": "https://opencover.com"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "opencover"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenCoverDeFi/eslint-config-opencover.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "default": "./dist/react.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "format": "eslint --fix . && prettier --write .",
+    "lint": "eslint --max-warnings=0 . && prettier --check .",
+    "typecheck": "tsc --noEmit",
+    "changeset": "changeset",
+    "changeset:version": "changeset version",
+    "changeset:release": "pnpm build && npm publish --verbose --access public",
+    "prepare": "husky",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@vitest/eslint-plugin": "^1.6.9",
+    "eslint-config-flat-gitignore": "^2.2.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-unicorn": "^63.0.0",
+    "typescript-eslint": "^8.56.1"
+  },
+  "peerDependencies": {
+    "eslint": "^10.0.0",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.30.0",
+    "@types/node": "^22.19.15",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^10.0.2",
+    "husky": "^9.1.7",
+    "jiti": "^2.6.1",
+    "knip": "^5.85.0",
+    "lint-staged": "^16.3.2",
+    "prettier": "^3.8.1",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=22",
+    "pnpm": ">=10.28.2"
+  },
+  "lint-staged": {
+    "**/*.{ts,tsx,js,jsx,mjs}": [
+      "eslint --cache --max-warnings=0 --fix",
+      "prettier --cache --write"
+    ],
+    "*.{json,yml,yaml,md}": "prettier --cache --write",
+    ".prettierrc": "prettier --cache --write"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "packageManager": "pnpm@10.30.3"
+}