Skip to content

Commit 5db0dd5

Browse files
refactor: rename @tsslint/eslint to @tsslint/compat-eslint and improve integration (#76)
1 parent e3fdf52 commit 5db0dd5

File tree

23 files changed

+111
-147
lines changed

23 files changed

+111
-147
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,16 +175,21 @@ export default defineConfig({
175175

176176
### Ecosystem Integration
177177

178+
TSSLint provides compatibility layers for existing linter ecosystems. These are available via `@tsslint/config` but require the corresponding compatibility package to be installed.
179+
178180
#### ESLint
179-
Convert ESLint rules via `@tsslint/eslint`.
181+
Convert ESLint rules via `@tsslint/compat-eslint`.
182+
183+
```bash
184+
npm install @tsslint/compat-eslint --save-dev
185+
```
180186

181187
```ts
182-
import { defineConfig } from '@tsslint/config';
183-
import { defineRules } from '@tsslint/eslint';
188+
import { defineConfig, importESLintRules } from '@tsslint/config';
184189

185190
export default defineConfig({
186191
rules: {
187-
...defineRules({
192+
...await importESLintRules({
188193
'no-unused-vars': 'error',
189194
'@typescript-eslint/no-explicit-any': 'warn',
190195
}),
@@ -193,7 +198,10 @@ export default defineConfig({
193198
```
194199

195200
#### TSLint
196-
Convert TSLint rules via `@tsslint/tslint`.
201+
Convert TSLint rules via `@tsslint/compat-tslint`.
202+
203+
#### TSL
204+
Convert TSL rules via `@tsslint/compat-tsl`.
197205

198206
## Technical Notes
199207

fixtures/define-eslint-rules/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"version": "3.0.0-alpha.0",
55
"devDependencies": {
66
"@tsslint/config": "3.0.0-alpha.0",
7-
"@tsslint/eslint": "3.0.0-alpha.0",
7+
"@tsslint/compat-eslint": "3.0.0-alpha.0",
88
"eslint-plugin-expect-type": "^0.4.0"
99
}
1010
}
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
import { defineConfig } from '@tsslint/config';
2-
import { defineRules } from '@tsslint/eslint';
1+
import { defineConfig, importESLintRules } from '@tsslint/config';
32

43
export default defineConfig({
5-
rules: await defineRules({
4+
rules: await importESLintRules({
65
'expect-type/expect': true,
76
}),
87
});

fixtures/define-tslint-rules/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"version": "3.0.0-alpha.0",
55
"devDependencies": {
66
"@tsslint/config": "3.0.0-alpha.0",
7-
"@tsslint/tslint": "3.0.0-alpha.0",
7+
"@tsslint/compat-tslint": "3.0.0-alpha.0",
88
"tslint": "^6.1.3"
99
}
1010
}

fixtures/define-tslint-rules/tsslint.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { defineConfig } from '@tsslint/config';
2-
import { convertRule } from '@tsslint/tslint';
2+
import { convertRule } from '@tsslint/compat-tslint';
33

44
export default defineConfig({
55
rules: {
Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
{
2-
"name": "@tsslint/eslint",
2+
"name": "@tsslint/compat-eslint",
33
"version": "3.0.0-alpha.0",
44
"license": "MIT",
55
"files": [
66
"**/*.js",
77
"**/*.d.ts",
88
"bin"
99
],
10-
"bin": {
11-
"tsslint-eslint-update": "bin/tsslint-eslint-update.js"
12-
},
1310
"repository": {
1411
"type": "git",
1512
"url": "https://github.com/johnsoncodehk/tsslint.git",
16-
"directory": "packages/eslint"
17-
},
18-
"scripts": {
19-
"postinstall": "node bin/tsslint-eslint-update.js"
13+
"directory": "packages/compat-eslint"
2014
},
2115
"devDependencies": {
2216
"@tsslint/types": "3.0.0-alpha.0",

0 commit comments

Comments
 (0)