chore: Release Notes, handle tables (#8320)

Author: Jason3S

.github/workflows/release-drafter.yml

@@ -17,7 +17,7 @@ env:
   # The branch to create the PR from
   NEW_BRANCH: 'release-draft'
   # Node.js version to use in the workflow
-  NODE_VERSION: '22.x'
+  NODE_VERSION: 'lts/*'
 
 jobs:
   update_release_draft:
@@ -56,7 +56,8 @@ jobs:
             ${{ toJSON(steps.release-drafter.outputs) }}
 
   create-pr:
-    if: "${{ !startsWith(github.event.head_commit.message, 'chore: Prepare Release') }}"
+    if: >-
+      ${{ !startsWith(github.event.head_commit.message, 'chore: Prepare Release') }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -80,8 +81,8 @@ jobs:
           'GITHUB_RELEASE_VERSION': ${{ needs.update_release_draft.outputs.resolved_version }}
 
         run: |
-          node ./scripts/gen-release.mjs -s packages/*/CHANGELOG.md
-          node ./scripts/gen-release.mjs CHANGELOG.md packages/cspell/CHANGELOG.md
+          node ./scripts/gen-release.mts -s packages/*/CHANGELOG.md
+          node ./scripts/gen-release.mts CHANGELOG.md packages/cspell/CHANGELOG.md
 
       - name: PR Body
         id: body
@@ -126,7 +127,8 @@ jobs:
   #           ```
 
   create-release:
-    if: "${{ startsWith(github.event.head_commit.message, 'chore: Prepare Release') && contains(github.event.head_commit.message, '(auto-deploy)') }}"
+    if: >-
+      ${{ startsWith(github.event.head_commit.message, 'chore: Prepare Release') && contains(github.event.head_commit.message, '(auto-deploy)') }}
     permissions:
       contents: write
       id-token: write

package.json

@@ -59,7 +59,7 @@
     "test-integrations": "cd ./integration-tests && pnpm run integration-tests",
     "test-schema": "node ./test-packages/cspell-types/validate-schema/validate-schema.mjs",
     "test:deno": "deno run -A ./bin.mjs lint rfc packages/cspell/src",
-    "update-changelog": "node ./scripts/gen-release.mjs CHANGELOG.md packages/cspell/CHANGELOG.md",
+    "update-changelog": "node ./scripts/gen-release.mts CHANGELOG.md packages/cspell/CHANGELOG.md",
     "update-packages": "pnpm run update-packages-src && pnpm run update-packages-docs && pnpm update-package-json",
     "update-packages-docs": "cd website && pnpm run update-packages",
     "update-packages-src": "pnpm -r up",

scripts/gen-release.mjs scripts/gen-release.mtsscripts/gen-release.mjs renamed to scripts/gen-release.mts

@@ -1,31 +1,29 @@
 #!/usr/bin/env node
 
-// @ts-check
-
 import fs from 'node:fs/promises';
 import { pathToFileURL } from 'node:url';
 import { parseArgs } from 'node:util';
 
-import { checkWeAreInGitRepo, processChangeLog } from './lib/changelog.mjs';
+import { checkWeAreInGitRepo, processChangeLog } from './lib/changelog.mts';
 
-/**
- * @typedef {{ tag: string; body: string; name: string; version: string; debug?: boolean }} ReleaseData
- */
+interface ReleaseData {
+    tag: string;
+    body: string;
+    name: string;
+    version: string;
+    debug?: boolean;
+}
 
 const optionsToEnv = {
     tag: 'GITHUB_RELEASE_TAG',
     body: 'GITHUB_RELEASE_BODY',
     name: 'GITHUB_RELEASE_NAME',
     version: 'GITHUB_RELEASE_VERSION',
-};
+} as const satisfies ReleaseData;
 
 class AppError extends Error {
-    /**
-     *
-     * @param {string} message
-     * @param {string | undefined} [code]
-     */
-    constructor(message, code) {
+    code?: string;
+    constructor(message: string, code?: string) {
         super(message);
         this.name = 'AppError';
         this.code = code;
@@ -34,14 +32,9 @@ class AppError extends Error {
 
 // cspell:ignore mdast
 
-/**
- *
- * @param {Partial<ReleaseData>} releaseData
- * @returns {asserts releaseData is ReleaseData}
- */
-function checkArgs(releaseData) {
+function checkArgs(releaseData: Partial<ReleaseData>): asserts releaseData is ReleaseData {
     let ok = true;
-    for (const [key, envVar] of Object.entries(optionsToEnv)) {
+    for (const [key, envVar] of Object.entries(optionsToEnv) as [keyof ReleaseData, string][]) {
         if (!releaseData[key]) {
             console.error(`Error: Option --${key} Environment variable ${envVar} is not set.`);
             ok = false;
@@ -52,11 +45,7 @@ function checkArgs(releaseData) {
     }
 }
 
-/**
- * @param {ReleaseData} releaseData
- * @return {Promise<void>}
- */
-async function updateVersionFile(releaseData) {
+async function updateVersionFile(releaseData: ReleaseData): Promise<void> {
     const { tag, name, version } = releaseData;
     await fs.writeFile('.release.json', JSON.stringify({ name, version, tag }, undefined, 4) + '\n', 'utf8');
 }

scripts/jsconfig.json

@@ -3,7 +3,7 @@
         "module": "NodeNext",
         "moduleResolution": "NodeNext",
         "target": "ESNext",
-        "allowImportingTsExtensions": false,
+        "allowImportingTsExtensions": true,
         "strictNullChecks": true,
         "strictFunctionTypes": true
     },