Skip to content

feat(eslint-plugin): auto-generate plugin types #7272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions packages/eslint-plugin/index.d.ts

This file was deleted.

15 changes: 10 additions & 5 deletions packages/eslint-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,24 @@
"files": [
"dist",
"docs",
"index.d.ts",
"rules.d.ts",
"package.json",
"README.md",
"LICENSE"
],
"type": "commonjs",
"exports": {
".": {
"types": "./index.d.ts",
"types": "./dist/_types/index.d.ts",
"default": "./dist/index.js"
},
"./package.json": "./package.json",
"./use-at-your-own-risk/rules": {
"types": "./rules.d.ts",
"types": "./dist/_types/rules.d.ts",
"default": "./dist/rules/index.js"
},
"./use-at-your-own-risk/configs": {
"types": "./dist/_types/configs.d.ts",
"default": "./dist/configs/index.js"
}
},
"engines": {
Expand All @@ -42,14 +44,15 @@
"typescript"
],
"scripts": {
"build": "tsc -b tsconfig.build.json",
"build": "tsc -b tsconfig.build.json && yarn generate:type-decls",
"check-docs": "jest tests/docs.test.ts --runTestsByPath --silent --runInBand",
"check-configs": "jest tests/configs.test.ts --runTestsByPath --silent --runInBand",
"clean": "tsc -b tsconfig.build.json --clean",
"postclean": "rimraf dist && rimraf coverage",
"format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
"generate:breaking-changes": "yarn tsx tools/generate-breaking-changes.mts",
"generate:configs": "yarn tsx tools/generate-configs.ts",
"generate:type-decls": "yarn tsx tools/generate-types.ts",
"lint": "nx lint",
"test": "jest --coverage --logHeapUsage",
"test-single": "jest --no-coverage",
Expand All @@ -70,6 +73,7 @@
"ts-api-utils": "^1.0.1"
},
"devDependencies": {
"@microsoft/api-extractor": "*",
"@types/debug": "*",
"@types/marked": "*",
"@types/natural-compare": "*",
Expand All @@ -81,6 +85,7 @@
"cross-fetch": "*",
"jest-specific-snapshot": "*",
"json-schema": "*",
"make-dir": "*",
"markdown-table": "^3.0.3",
"marked": "^5.1.1",
"prettier": "*",
Expand Down
44 changes: 0 additions & 44 deletions packages/eslint-plugin/rules.d.ts

This file was deleted.

5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/adjacent-overload-signatures': 'error',
Expand Down Expand Up @@ -183,3 +185,4 @@ export = {
'@typescript-eslint/unified-signatures': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
parser: '@typescript-eslint/parser',
parserOptions: { sourceType: 'module' },
plugins: ['@typescript-eslint'],
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/disable-type-checked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
parserOptions: { project: null, program: null },
rules: {
'@typescript-eslint/await-thenable': 'off',
Expand Down Expand Up @@ -55,3 +57,4 @@ export = {
'@typescript-eslint/unbound-method': 'off',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/eslint-recommended.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

/**
* This is a compatibility ruleset that:
* - disables rules from eslint:recommended which are already handled by TypeScript.
* - enables rules that make sense due to TS's typechecking / transpilation.
*/
export = {
const config: Linter.Config = {
overrides: [
{
files: ['*.ts', '*.tsx', '*.mts', '*.cts'],
Expand Down Expand Up @@ -32,3 +34,4 @@ export = {
},
],
};
export = config;
25 changes: 25 additions & 0 deletions packages/eslint-plugin/src/configs/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import all from './all';
import base from './base';
import disableTypeChecked from './disable-type-checked';
import eslintRecommended from './eslint-recommended';
import recommended from './recommended';
import recommendedTypeChecked from './recommended-type-checked';
import strict from './strict';
import strictTypeChecked from './strict-type-checked';
import stylistic from './stylistic';
import stylisticTypeChecked from './stylistic-type-checked';

export const configs = {
all,
base,
'disable-type-checked': disableTypeChecked,
'eslint-recommended': eslintRecommended,
recommended,
/** @deprecated - please use "recommended-type-checked" instead. */
'recommended-requiring-type-checking': recommendedTypeChecked,
'recommended-type-checked': recommendedTypeChecked,
strict,
'strict-type-checked': strictTypeChecked,
stylistic,
'stylistic-type-checked': stylisticTypeChecked,
};
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/await-thenable': 'error',
Expand Down Expand Up @@ -51,3 +53,4 @@ export = {
'@typescript-eslint/unbound-method': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/recommended.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/ban-ts-comment': 'error',
Expand All @@ -30,3 +32,4 @@ export = {
'@typescript-eslint/triple-slash-reference': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/strict-type-checked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/await-thenable': 'error',
Expand Down Expand Up @@ -72,3 +74,4 @@ export = {
'@typescript-eslint/unified-signatures': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/strict.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/ban-ts-comment': 'error',
Expand Down Expand Up @@ -40,3 +42,4 @@ export = {
'@typescript-eslint/unified-signatures': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/stylistic-type-checked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/adjacent-overload-signatures': 'error',
Expand All @@ -32,3 +34,4 @@ export = {
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
},
};
export = config;
5 changes: 4 additions & 1 deletion packages/eslint-plugin/src/configs/stylistic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
// For developers working in the typescript-eslint monorepo:
// You can regenerate it using `yarn generate:configs`

export = {
import type { Linter } from '@typescript-eslint/utils/ts-eslint';

const config: Linter.Config = {
extends: ['./configs/base', './configs/eslint-recommended'],
rules: {
'@typescript-eslint/adjacent-overload-signatures': 'error',
Expand All @@ -26,3 +28,4 @@ export = {
'@typescript-eslint/prefer-namespace-keyword': 'error',
},
};
export = config;
28 changes: 3 additions & 25 deletions packages/eslint-plugin/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,7 @@
import all from './configs/all';
import base from './configs/base';
import disableTypeChecked from './configs/disable-type-checked';
import eslintRecommended from './configs/eslint-recommended';
import recommended from './configs/recommended';
import recommendedTypeChecked from './configs/recommended-type-checked';
import strict from './configs/strict';
import strictTypeChecked from './configs/strict-type-checked';
import stylistic from './configs/stylistic';
import stylisticTypeChecked from './configs/stylistic-type-checked';
import rules from './rules';
import { configs } from './configs';
import { rules } from './rules';

export = {
configs: {
all,
base,
'disable-type-checked': disableTypeChecked,
'eslint-recommended': eslintRecommended,
recommended,
/** @deprecated - please use "recommended-type-checked" instead. */
'recommended-requiring-type-checking': recommendedTypeChecked,
'recommended-type-checked': recommendedTypeChecked,
strict,
'strict-type-checked': strictTypeChecked,
stylistic,
'stylistic-type-checked': stylisticTypeChecked,
},
configs,
rules,
};
2 changes: 1 addition & 1 deletion packages/eslint-plugin/src/rules/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ import typedef from './typedef';
import unboundMethod from './unbound-method';
import unifiedSignatures from './unified-signatures';

export default {
export const rules = {
'adjacent-overload-signatures': adjacentOverloadSignatures,
'array-type': arrayType,
'await-thenable': awaitThenable,
Expand Down
4 changes: 2 additions & 2 deletions packages/eslint-plugin/src/util/createRule.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ESLintUtils } from '@typescript-eslint/utils';
import { RuleCreator } from '@typescript-eslint/utils/eslint-utils';

export const createRule = ESLintUtils.RuleCreator(
export const createRule = RuleCreator(
name => `https://typescript-eslint.io/rules/${name}`,
);
Loading