typescript-eslint · abrahamguo · Apr 7, 2024 · Apr 7, 2024 · Apr 10, 2024 · May 28, 2024
diff --git a/.cspell.json b/.cspell.json
@@ -79,6 +79,7 @@
     "destructures",
     "discoverability",
     "dprint",
+    "dummypkg",
     "errored",
     "erroring",
     "ESLint",

diff --git a/.github/actions/breaking-pr-check/action.yml b/.github/actions/breaking-pr-check/action.yml
@@ -2,5 +2,8 @@ name: Validate Breaking Change PR
 description: Validate breaking change PR title and description
 
 runs:
-  using: node20
-  main: index.js
+  using: 'composite'
+  steps:
+    - shell: bash
+      run: yarn breaking-pr-check-action
+      working-directory: packages/repo-tools
diff --git a/.github/actions/wait-for-netlify/action.yml b/.github/actions/wait-for-netlify/action.yml
diff --git a/.github/actions/wait-for-netlify/index.js b/.github/actions/wait-for-netlify/index.js
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -27,6 +27,7 @@ export default tseslint.config(
   {
     // note - intentionally uses computed syntax to make it easy to sort the keys
     plugins: {
+      /* eslint-disable no-useless-computed-key */
       ['@typescript-eslint']: tseslint.plugin,
       ['@typescript-eslint/internal']: tseslintInternalPlugin,
       ['deprecation']: deprecationPlugin,
@@ -40,6 +41,7 @@ export default tseslint.config(
       ['react']: reactPlugin,
       ['simple-import-sort']: simpleImportSortPlugin,
       ['unicorn']: unicornPlugin,
+      /* eslint-enable no-useless-computed-key */
     },
   },
   {
@@ -53,6 +55,8 @@ export default tseslint.config(
       '**/__snapshots__/**',
       '**/.docusaurus/**',
       '**/build/**',
+      '.nx/cache',
+      '.yarn/*',
       // Files copied as part of the build
       'packages/types/src/generated/**/*.ts',
       // Playground types downloaded from the web

diff --git a/knip.ts b/knip.ts
@@ -1,4 +1,4 @@
-import type { KnipConfig } from 'knip';
+import type { KnipConfig } from 'knip' with { 'resolution-mode': 'import' };
 
 export default {
   rules: {
@@ -31,9 +31,10 @@ export default {
         // imported in eslint.config.js
         '@typescript-eslint/utils',
       ],
-      entry: ['tools/release/changelog-renderer.js'],
+      entry: ['packages/repo-tools/src/release/changelog-renderer.js'],
       ignoreBinaries: [
         // https://github.com/webpro/knip/issues/433
+        'breaking-pr-check-action',
         'stylelint',
       ],
     },
@@ -58,6 +59,7 @@ export default {
     'packages/parser': {
       ignore: ['tests/fixtures/**'],
     },
+    'packages/repo-tools/src/dummypkg': {},
     'packages/scope-manager': {
       ignore: ['tests/fixtures/**'],
     },
@@ -120,6 +122,5 @@ export default {
         'src/mock/util.js',
       ],
     },
-    'tools/dummypkg': {},
   },
 } satisfies KnipConfig;
diff --git a/nx.json b/nx.json
@@ -6,10 +6,10 @@
     "changelog": {
       "workspaceChangelog": {
         "createRelease": "github",
-        "renderer": "{workspaceRoot}/tools/release/changelog-renderer"
+        "renderer": "{workspaceRoot}/packages/repo-tools/src/release/changelog-renderer"
       },
       "projectChangelogs": {
-        "renderer": "{workspaceRoot}/tools/release/changelog-renderer"
+        "renderer": "{workspaceRoot}/packages/repo-tools/src/release/changelog-renderer"
       }
     },
     "version": {

diff --git a/package.json b/package.json
@@ -40,21 +40,19 @@
     "lint-markdown-fix": "yarn lint-markdown --fix",
     "lint-markdown": "markdownlint \"**/*.md\" --config=.markdownlint.json --ignore-path=.markdownlintignore",
     "lint-stylelint": "npx nx lint website stylelint",
-    "lint": "npx nx lint eslint-plugin --skip-nx-cache && npx nx run-many --target=lint --parallel --exclude eslint-plugin",
+    "lint": "npx nx lint eslint-plugin --skip-nx-cache && npx nx run-many --target=lint --parallel --exclude eslint-plugin && eslint . --ignore-pattern=packages --cache",
     "postinstall": "npx nx run repo-tools:postinstall-script",
     "pre-commit": "yarn lint-staged",
-    "release": "tsx tools/release/release.mts",
+    "release": "tsx packages/repo-tools/src/release/release.mts",
     "start": "npx nx run website:start",
     "test": "npx nx run-many --target=test --parallel --exclude integration-tests --exclude website --exclude website-eslint",
     "test-integration": "npx nx run integration-tests:test",
-    "typecheck": "npx nx run-many --target=typecheck --parallel"
+    "typecheck": "npx nx run-many --target=typecheck --parallel && tsc"
   },
   "engines": {
     "node": "^18.18.0 || >=20.0.0"
   },
   "devDependencies": {
-    "@actions/core": "^1.10.1",
-    "@actions/github": "^6.0.0",
     "@babel/code-frame": "^7.24.2",
     "@babel/core": "^7.24.4",
     "@babel/eslint-parser": "^7.24.1",
@@ -79,7 +77,6 @@
     "@types/node": "^20.12.5",
     "@types/semver": "^7.5.8",
     "@types/tmp": "^0.2.6",
-    "@types/yargs": "^17.0.32",
     "@typescript-eslint/eslint-plugin-internal": "workspace:^",
     "console-fail-test": "^0.2.3",
     "cross-fetch": "^4.0.0",
@@ -97,7 +94,6 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-unicorn": "^50.0.1",
-    "execa": "7.2.0",
     "glob": "^10.3.12",
     "globals": "^15.0.0",
     "husky": "^9.0.0",
@@ -108,25 +104,23 @@
     "make-dir": "^4.0.0",
     "markdownlint-cli": "^0.41.0",
     "ncp": "^2.0.0",
-    "netlify": "^13.1.14",
     "nx": "19.4.0",
     "prettier": "3.3.2",
     "pretty-format": "^29.7.0",
     "rimraf": "^5.0.5",
     "tmp": "^0.2.1",
     "tsx": "*",
     "typescript": ">=4.7.4 <5.6.0",
-    "typescript-eslint": "workspace:^",
-    "yargs": "17.7.2"
+    "typescript-eslint": "workspace:^"
   },
   "resolutions": {
     "@jest/create-cache-key-function": "^29",
     "@jest/reporters": "^29",
     "@jest/test-result": "^29",
     "@microsoft/api-extractor@^7.38.0": "patch:@microsoft/api-extractor@npm%3A7.38.0#./.yarn/patches/@microsoft-api-extractor-npm-7.38.0-955f1e0725.patch",
-    "@types/eslint-scope": "link:./tools/dummypkg",
-    "@types/eslint": "link:./tools/dummypkg",
-    "@types/estree": "link:./tools/dummypkg",
+    "@types/eslint-scope": "link:./packages/repo-tools/src/dummypkg",
+    "@types/eslint": "link:./packages/repo-tools/src/dummypkg",
+    "@types/estree": "link:./packages/repo-tools/src/dummypkg",
     "@types/node": "^20.0.0",
     "@types/react": "^18.2.14",
     "eslint": "8.57.0",

diff --git a/packages/repo-tools/package.json b/packages/repo-tools/package.json
@@ -5,6 +5,7 @@
   "//": "NOTE: intentionally no build step in this package",
   "scripts": {
     "apply-canary-version": "npx tsx ./src/apply-canary-version.mts",
+    "breaking-pr-check-action": "npx tsx ./src/breaking-pr-check-action.mts",
     "format": "npx prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "generate-configs": "npx tsx ./src/generate-configs.mts",
     "generate-contributors": "npx tsx ./src/generate-contributors.mts",
@@ -16,18 +17,23 @@
     "typecheck": "npx tsc --noEmit"
   },
   "devDependencies": {
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^6.0.0",
     "@jest/types": "29.6.3",
     "@nx/devkit": "*",
+    "@types/yargs": "^17.0.32",
     "@typescript-eslint/eslint-plugin": "7.16.1",
     "@typescript-eslint/scope-manager": "7.16.1",
     "@typescript-eslint/types": "7.16.1",
     "@typescript-eslint/typescript-estree": "7.16.1",
     "@typescript-eslint/utils": "7.16.1",
     "cross-fetch": "*",
     "execa": "*",
+    "nx": "19.4.0",
     "prettier": "^3.2.5",
     "rimraf": "*",
     "semver": "7.6.2",
-    "typescript": "*"
+    "typescript": "*",
+    "yargs": "^17.7.2"
   }
 }
diff --git a/.github/actions/breaking-pr-check/index.js → ...po-tools/src/breaking-pr-check-action.mts b/.github/actions/breaking-pr-check/index.js → ...po-tools/src/breaking-pr-check-action.mts
@@ -1,12 +1,13 @@
-const core = require('@actions/core');
-const github = require('@actions/github');
+import core from '@actions/core';
+import github from '@actions/github';
 
-function raiseError(message) {
+function raiseError(message: string): never {
   throw new Error(message);
 }
 
-async function getPullRequest() {
-  const client = github.getOctokit(process.env.GITHUB_TOKEN);
+async function getPullRequest(): Promise<typeof data> {
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const client = github.getOctokit(process.env.GITHUB_TOKEN!);
 
   const pr = github.context.payload.pull_request;
   if (!pr) {
@@ -15,8 +16,9 @@ async function getPullRequest() {
     );
   }
 
-  const owner = pr.base.user.login;
-  const repo = pr.base.repo.name;
+  const base = pr.base as { user: { login: string }; repo: { name: string } };
+  const owner = base.user.login;
+  const repo = base.repo.name;
 
   const { data } = await client.rest.pulls.get({
     owner,
@@ -27,21 +29,24 @@ async function getPullRequest() {
   return data;
 }
 
-function checkTitle(title) {
+function checkTitle(title: string): void {
   if (/^[a-z]+(\([a-z-]+\))?!: /.test(title)) {
     raiseError(
       `Do not use exclamation mark ('!') to indicate breaking change in the PR Title.`,
     );
   }
 }
 
-function checkDescription(body, labels) {
+function checkDescription(
+  body: string,
+  labels: (typeof pullRequest)['labels'],
+): void {
   if (!labels.some(label => label.name === 'breaking change')) {
     return;
   }
   const [firstLine, secondLine] = body.split(/\r?\n/);
 
-  if (!firstLine || !/^BREAKING CHANGE:/.test(firstLine)) {
+  if (!firstLine.startsWith('BREAKING CHANGE:')) {
     raiseError(
       `Breaking change PR body should start with "BREAKING CHANGE:". See https://typescript-eslint.io/maintenance/releases#2-merging-breaking-changes.`,
     );
@@ -53,14 +58,10 @@ function checkDescription(body, labels) {
   }
 }
 
-async function run() {
-  const pullRequest = await getPullRequest();
-  try {
-    checkTitle(pullRequest.title);
-    checkDescription(pullRequest.body, pullRequest.labels);
-  } catch (e) {
-    core.setFailed(e.message);
-  }
+const pullRequest = await getPullRequest();
+try {
+  checkTitle(pullRequest.title);
+  checkDescription(pullRequest.body ?? '', pullRequest.labels);
+} catch (e) {
+  core.setFailed((e as Error).message);
 }
-
-run();
diff --git a/tools/dummypkg/README.md → packages/repo-tools/src/dummypkg/README.md b/tools/dummypkg/README.md → packages/repo-tools/src/dummypkg/README.md
diff --git a/tools/dummypkg/index.d.ts → packages/repo-tools/src/dummypkg/index.d.ts b/tools/dummypkg/index.d.ts → packages/repo-tools/src/dummypkg/index.d.ts
diff --git a/tools/dummypkg/index.js → packages/repo-tools/src/dummypkg/index.js b/tools/dummypkg/index.js → packages/repo-tools/src/dummypkg/index.js
diff --git a/tools/dummypkg/package.json → ...ages/repo-tools/src/dummypkg/package.json b/tools/dummypkg/package.json → ...ages/repo-tools/src/dummypkg/package.json
diff --git a/tools/release/changelog-renderer.js → ...o-tools/src/release/changelog-renderer.js b/tools/release/changelog-renderer.js → ...o-tools/src/release/changelog-renderer.js