Skip to content

chore: extract eslint-plugin-tslint to new repository #8366

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 21, 2024
Merged

chore: extract eslint-plugin-tslint to new repository #8366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d32403
chore: extract eslint-plugin-tslint to new repository
JoshuaKGoldberg Feb 4, 2024
5cb3b83
Remove integration test too
JoshuaKGoldberg Feb 4, 2024
bbad3d3
Merge branch 'main'
JoshuaKGoldberg Feb 21, 2024
7efc142
Re-ran yarn
JoshuaKGoldberg Feb 21, 2024
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
454 changes: 454 additions & 0 deletions .eslintrc.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/06-bug-report-other.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ body:
description: Select the package against which you want to report the bug.
options:
- ast-spec
- eslint-plugin-tslint
- parser
- rule-tester
- scope-manager
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/07-enhancement-other.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ body:
description: Select the package against which you want to report the bug.
options:
- ast-spec
- eslint-plugin-tslint
- parser
- scope-manager
- type-utils
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ jobs:
'ast-spec',
'eslint-plugin',
'eslint-plugin-internal',
'eslint-plugin-tslint',
'parser',
'repo-tools',
'rule-schema-to-typescript-types',
Expand Down Expand Up @@ -226,12 +225,7 @@ jobs:
strategy:
matrix:
package:
[
'eslint-plugin',
'eslint-plugin-internal',
'eslint-plugin-tslint',
'typescript-estree',
]
['eslint-plugin', 'eslint-plugin-internal', 'typescript-estree']
env:
COLLECT_COVERAGE: false
steps:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/semantic-pr-titles.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ jobs:
ast-spec
eslint-plugin
eslint-plugin-internal
eslint-plugin-tslint
parser
rule-tester
scope-manager
Expand Down
67 changes: 0 additions & 67 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,39 +71,6 @@
"${workspaceFolder}/packages/scope-manager/dist/index.js",
"${workspaceFolder}/packages/scope-manager/dist/index.js",
],
},{
"type": "node",
"request": "launch",
"name": "Jest Test Current eslint-plugin-tslint Rule",
"cwd": "${workspaceFolder}/packages/eslint-plugin-tslint/",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"args": [
"--runInBand",
"--no-cache",
"--no-coverage",
"${fileBasenameNoExtension}"
],
"sourceMaps": true,
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen",
"skipFiles": [
"${workspaceFolder}/packages/utils/src/index.ts",
"${workspaceFolder}/packages/utils/dist/index.js",
"${workspaceFolder}/packages/utils/src/ts-estree.ts",
"${workspaceFolder}/packages/utils/dist/ts-estree.js",
"${workspaceFolder}/packages/type-utils/src/index.ts",
"${workspaceFolder}/packages/type-utils/dist/index.js",
"${workspaceFolder}/packages/parser/src/index.ts",
"${workspaceFolder}/packages/parser/dist/index.js",
"${workspaceFolder}/packages/typescript-estree/src/index.ts",
"${workspaceFolder}/packages/typescript-estree/dist/index.js",
"${workspaceFolder}/packages/types/src/index.ts",
"${workspaceFolder}/packages/types/dist/index.js",
"${workspaceFolder}/packages/visitor-keys/src/index.ts",
"${workspaceFolder}/packages/visitor-keys/dist/index.js",
"${workspaceFolder}/packages/scope-manager/dist/index.js",
"${workspaceFolder}/packages/scope-manager/dist/index.js",
],
},
{
"type": "node",
Expand Down Expand Up @@ -141,40 +108,6 @@
"${workspaceFolder}/packages/scope-manager/dist/index.js",
],
},
{
"type": "node",
"request": "launch",
"name": "Jest Test Current eslint-plugin-tslint Rule",
"cwd": "${workspaceFolder}/packages/eslint-plugin-tslint/",
"program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
"args": [
"--runInBand",
"--no-cache",
"--no-coverage",
"${fileBasenameNoExtension}"
],
"sourceMaps": true,
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen",
"skipFiles": [
"${workspaceFolder}/packages/utils/src/index.ts",
"${workspaceFolder}/packages/utils/dist/index.js",
"${workspaceFolder}/packages/utils/src/ts-estree.ts",
"${workspaceFolder}/packages/utils/dist/ts-estree.js",
"${workspaceFolder}/packages/type-utils/src/index.ts",
"${workspaceFolder}/packages/type-utils/dist/index.js",
"${workspaceFolder}/packages/parser/src/index.ts",
"${workspaceFolder}/packages/parser/dist/index.js",
"${workspaceFolder}/packages/typescript-estree/src/index.ts",
"${workspaceFolder}/packages/typescript-estree/dist/index.js",
"${workspaceFolder}/packages/types/src/index.ts",
"${workspaceFolder}/packages/types/dist/index.js",
"${workspaceFolder}/packages/visitor-keys/src/index.ts",
"${workspaceFolder}/packages/visitor-keys/dist/index.js",
"${workspaceFolder}/packages/scope-manager/dist/index.js",
"${workspaceFolder}/packages/scope-manager/dist/index.js",
],
},
{
"type": "node",
"request": "launch",
Expand Down
39 changes: 2 additions & 37 deletions docs/packages/ESLint_Plugin_TSLint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,5 @@ Per [What About TSLint?](../troubleshooting/TSLint.mdx), we highly recommend mig
See [Getting Started](../getting-started/Quickstart.mdx) for documentation on how to lint your TypeScript code with ESLint.
:::

## Installation

```sh
yarn add -D @typescript-eslint/eslint-plugin-tslint
```

## Usage

Configure in your ESLint config file:

```js
{
"plugins": [
"@typescript-eslint/tslint"
],
"parserOptions": {
"project": "tsconfig.json",
},
"rules": {
"@typescript-eslint/tslint/config": ["warn", {
"lintFile": "", // path to tslint.json of your project
"rules": {
// tslint rules (will be used if `lintFile` is not specified)
},
"rulesDirectory": [
// array of paths to directories with rules, e.g. 'node_modules/tslint/lib/rules' (will be used if `lintFile` is not specified)
]
}],
}
}
```

**Note:** The ability to automatically fix problems with `--fix` is unavailable for TSLint rules loaded with this plugin.

## Rules

This plugin contains only a single rule: `@typescript-eslint/tslint/config`.
Documentation for this package has moved to [github.com/typescript-eslint/eslint-plugin-tslint](https://github.com/typescript-eslint/eslint-plugin-tslint).
This page will eventually be removed.
2 changes: 1 addition & 1 deletion docs/users/Versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A change to the AST **_shall not_** be considered breaking if it:
- Refines a type to be more specific (i.e. `string` to `'literal' | 'union'`).
- Removes a type from a union that was erroneously added and did not match the runtime AST.

### `eslint-plugin` and `eslint-plugin-tslint`
### `eslint-plugin`

A change to the plugins **_shall_** be considered breaking if it will require the user to change their config. More specifically:

Expand Down
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@
"rimraf": "^5.0.1",
"tmp": "^0.2.1",
"ts-node": "10.7.0",
"tslint": "^6.1.3",
"tsx": "^4.6.2",
"typescript": ">=4.7.4 <5.4.0",
"typescript-eslint": "workspace:^",
Expand Down
Loading