chore: simplify apis (#59)

Author: MengLinMaker

.changeset/config.json

@@ -9,7 +9,7 @@
   "commit": false,
   "fixed": [],
   "linked": [],
-  "access": "public",
+  "access": "restricted",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
   "ignore": []

.changeset/light-onions-sip.md

@@ -0,0 +1,5 @@
+---
+"@menglinmaker/eslint-plugin-runtime-compat": minor
+---
+
+Simplified apis and added comprehensive test suite

.github/workflows/CD.yml .github/workflows/changesets.yml.github/workflows/CD.yml renamed to .github/workflows/changesets.yml

@@ -1,11 +1,8 @@
-name: CD
+name: Changesets
 on:
-  workflow_run:
-    workflows: [CI]
-    branches: [main]
-    types: [completed]
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
+  push:
+    branches:
+      - main
 
 permissions:
   contents: write
@@ -14,7 +11,6 @@ permissions:
 
 jobs:
   release:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,15 +24,16 @@ jobs:
 
       - run: pnpm install
       - run: pnpm build
+      - run: pnpm lint
+      - run: pnpm test
 
-      - name: Create Release Pull Request or Publish to npm
-        id: changesets
+      - name: Update and publish versions
         uses: changesets/action@v1
         with:
-          publish: pnpm release
           version: pnpm run version
           commit: "chore: new release"
           title: "chore: new release candidate"
+          publish: pnpm release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -32,15 +32,16 @@ npm install @menglinmaker/eslint-plugin-runtime-compat
 ```
 
 2. Add `eslint.config.mjs` to root. This detects incompatible APIs for all runtimes in the dataset.
-```Bash
-import runtimeCompat from "@menglinmaker/eslint-plugin-runtime-compat";
+```JavaScript
+import runtimeCompat from '@menglinmaker/eslint-plugin-runtime-compat'
+import tseslint from 'typescript-eslint'
 
-export default [runtimeCompat.configs.strict];
+export default [...tseslint.configs.recommended, ...runtimeCompat.configs.strict]
 ```
 
 Alternatively, you can load a custom config:
-```Bash
-export default [runtimeCompat.configs.custom(['node', 'bun', 'deno'])];
+```JavaScript
+runtimeCompat.configs.custom(['node', 'bun', 'deno'])
 ```
 
 ## Limitations:

e2e/import-package-compat/eslint.config.js

@@ -1,17 +1,4 @@
 import runtimeCompat from '@menglinmaker/eslint-plugin-runtime-compat'
 import tseslint from 'typescript-eslint'
 
-export default [
-  ...tseslint.configs.recommended,
-  runtimeCompat.configs.recommended,
-  {
-    languageOptions: {
-      parserOptions: {
-        projectService: {
-          allowDefaultProject: ['*.js'],
-        },
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-  },
-]
+export default [...tseslint.configs.recommended, ...runtimeCompat.configs.strict]

e2e/import-package-compat/package.json

@@ -1,4 +1,5 @@
 {
+  "name": "@eslint-plugin-runtime-compat/import-package-compat",
   "private": true,
   "type": "module",
   "scripts": {

e2e/internal-package-compat/eslint.config.js

@@ -1,17 +1,4 @@
 import runtimeCompat from '@menglinmaker/eslint-plugin-runtime-compat'
 import tseslint from 'typescript-eslint'
 
-export default [
-  ...tseslint.configs.recommended,
-  runtimeCompat.configs.recommended,
-  {
-    languageOptions: {
-      parserOptions: {
-        projectService: {
-          allowDefaultProject: ['*.js'],
-        },
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-  },
-]
+export default [...tseslint.configs.recommended, ...runtimeCompat.configs.strict]

e2e/internal-package-compat/package.json

@@ -1,4 +1,6 @@
 {
+  "name": "@eslint-plugin-runtime-compat/internal-package-compat",
+
   "private": true,
   "type": "module",
   "scripts": {

package.json

@@ -9,6 +9,7 @@
     "build": "turbo build",
     "clean": "rimraf packages/**/dist & rimraf .turbo packages/**/.turbo & rimraf node_modules packages/**/node_modules",
     "knip": "knip",
+    "changeset": "changeset",
     "version": "changeset version",
     "release": "changeset publish"
   },

packages/plugin/src/index.ts

@@ -9,25 +9,33 @@ import { runtimeCompatRule } from './rules'
  * @param ruleConfig - List of runtimes to check.
  * @returns Generated flat-config for ESLint.
  */
-const runtimeCompatPlugin = (filterRuntimes: RuntimeName[]) => ({
-  plugins: {
-    'runtime-compat': {
-      meta: {
-        name: pkg.name,
-        version: pkg.version,
-      },
-      rules: {
-        'runtime-compat': runtimeCompatRule(filterRuntimes),
+const runtimeCompatPlugin = (filterRuntimes: RuntimeName[]) => [
+  {
+    plugins: {
+      'runtime-compat': {
+        meta: {
+          name: pkg.name,
+          version: pkg.version,
+        },
+        rules: {
+          'runtime-compat': runtimeCompatRule(filterRuntimes),
+        },
       },
     },
+    rules: {
+      'runtime-compat/runtime-compat': 'error',
+    },
   },
-  rules: {
-    'runtime-compat/runtime-compat': 'error',
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
   },
-})
+]
 
 export const configs = {
-  recommended: runtimeCompatPlugin(supportedRuntimes),
   strict: runtimeCompatPlugin(supportedRuntimes),
   custom: runtimeCompatPlugin,
 }