feat: re-introduce @tsslint/compat-eslint as a separate package (#80)

Author: johnsoncodehk

README.md

@@ -175,14 +175,38 @@ export default defineConfig({
 
 ### Ecosystem Integration
 
-TSSLint provides compatibility layers for existing linter ecosystems. The integration functions are available via `@tsslint/config`, and you only need to install the original linter package to use them.
+TSSLint provides compatibility layers for existing linter ecosystems (ESLint, TSLint, and TSL). These integrations are coordinated through `@tsslint/config`, which acts as a bridge to load rules from other linters.
 
-#### ESLint
+To use a compatibility layer, you must install the corresponding TSSLint compatibility package. If you wish to use the original linter's built-in rules, you must also install the original linter package itself.
+
+#### 1. ESLint
+
+**Installation:**
+
+First, install the TSSLint compatibility package for ESLint.
+
+```bash
+npm install @tsslint/compat-eslint --save-dev
+```
+
+If you want to use ESLint's built-in rules (e.g., `no-unused-vars`), you must also install `eslint` (optional):
 
 ```bash
-npm install eslint@9.27.0 @typescript-eslint/parser --save-dev
+npm install eslint --save-dev
 ```
 
+**Type Definition Update:**
+
+After installing the original linter package, run the following command to update JSDoc for built-in rules, enabling better IDE support:
+
+```bash
+npx tsslint-docgen
+```
+
+**Usage in `tsslint.config.ts`:**
+
+Use `importESLintRules` to load rules. This function automatically resolves and loads rules from ESLint plugins (e.g., `@typescript-eslint/eslint-plugin`) by searching your `node_modules`. Plugin rules are identified by their prefix (e.g., `@typescript-eslint/`).
+
 ```ts
 import { defineConfig, importESLintRules } from '@tsslint/config';
 
@@ -196,14 +220,28 @@ export default defineConfig({
 });
 ```
 
-`importESLintRules` will automatically resolve and load rules from ESLint plugins (e.g., `@typescript-eslint/eslint-plugin`) by searching your `node_modules`. Plugin rules are identified by their prefix (e.g., `@typescript-eslint/`).
+#### 2. TSLint
+
+**Installation:**
 
-#### TSLint
+If you want to use TSLint's built-in rules, you need to install `tslint` (optional):
 
 ```bash
 npm install tslint --save-dev
 ```
 
+**Type Definition Update:**
+
+After installing `tslint`, run the following command to update JSDoc for built-in rules:
+
+```bash
+npx tsslint-docgen
+```
+
+**Usage in `tsslint.config.ts`:**
+
+Use `importTSLintRules` to load rules. This function automatically reads `rulesDirectory` from your `tslint.json` to support third-party TSLint plugins.
+
 ```ts
 import { defineConfig, importTSLintRules } from '@tsslint/config';
 
@@ -217,14 +255,20 @@ export default defineConfig({
 });
 ```
 
-`importTSLintRules` will automatically read `rulesDirectory` from your `tslint.json` to support third-party TSLint plugins.
+#### 3. TSL
 
-#### TSL
+**Installation:**
+
+TSL rules are imported directly from the `tsl` package.
 
 ```bash
 npm install tsl --save-dev
 ```
 
+**Usage in `tsslint.config.ts`:**
+
+Use `fromTSLRules` to load TSL rules.
+
 ```ts
 import { defineConfig, fromTSLRules } from '@tsslint/config';
 import { core } from 'tsl';

fixtures/compat-eslint/package.json

@@ -4,8 +4,7 @@
 	"version": "3.0.0-alpha.0",
 	"devDependencies": {
 		"@tsslint/config": "3.0.0-alpha.0",
-		"@typescript-eslint/parser": "^8.16.0",
-		"eslint": "9.27.0",
+		"@tsslint/compat-eslint": "3.0.0-alpha.0",
 		"eslint-plugin-expect-type": "^0.4.0"
 	}
 }

packages/cli/package.json

@@ -2,6 +2,9 @@
 	"name": "@tsslint/cli",
 	"version": "3.0.0-alpha.0",
 	"license": "MIT",
+	"engines": {
+		"node": ">=22.6.0"
+	},
 	"bin": {
 		"tsslint": "./bin/tsslint.js"
 	},

packages/compat-eslint/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Johnson Chu
+
+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.