Merge branch 'main' into copilot/fix-61714-2

Author: weswigham

.github/copilot-instructions.md

@@ -1,28 +1,27 @@
-# TypeScript Test Writing Guide for Copilot
+# Guide for Copilot
 
 This document provides a concise guide for writing TypeScript fourslash tests and compiler tests, along with build instructions.
 
 ## Build Instructions Summary
 
 ### Setup
 1. Install Node.js (current or LTS)
-2. Install hereby: `npm install -g hereby`
-3. Clone the repository: `git clone --depth=1 https://github.com/microsoft/TypeScript`
-4. Install dependencies: `npm ci`
+2. Clone the repository: `git clone --depth=1 https://github.com/microsoft/TypeScript`
+3. Install dependencies: `npm ci`
 
 ### Common Build Tasks
 ```bash
-hereby local             # Build the compiler into built/local
-hereby clean             # Delete the built compiler  
-hereby tests             # Build the test infrastructure
-hereby runtests          # Run all tests
-hereby runtests-parallel # Run tests in parallel (recommended)
-hereby runtests --runner=fourslash # Run only fourslash tests
-hereby runtests --runner=compiler # Run only compiler tests
-hereby runtests --tests=<testPath> # Run specific test
-hereby baseline-accept   # Accept new test baselines
-hereby lint              # Run eslint
-hereby format            # Run code formatting
+npx hereby local             # Build the compiler into built/local
+npx hereby clean             # Delete the built compiler  
+npx hereby tests             # Build the test infrastructure
+npx hereby runtests          # Run all tests
+npx hereby runtests-parallel # Run tests in parallel 🚨 MANDATORY BEFORE FINISHING!
+npx hereby runtests --runner=fourslash # Run only fourslash tests
+npx hereby runtests --runner=compiler # Run only compiler tests
+npx hereby runtests --tests=<testPath> # Run specific test
+npx hereby baseline-accept   # Accept new test baselines
+npx hereby lint              # Run eslint 🚨 MANDATORY BEFORE FINISHING!
+npx hereby format            # Run code formatting 🚨 MANDATORY BEFORE FINISHING!
 ```
 
 ## Fourslash Test Syntax Guide
@@ -248,30 +247,69 @@ const config3: Config = { optional: 42 }; // Should error - missing required
 
 ```bash
 # Run a specific fourslash test
-hereby runtests --tests=tests/cases/fourslash/completionForObjectProperty.ts
+npx hereby runtests --tests=tests/cases/fourslash/completionForObjectProperty.ts
 
 # Run a specific compiler test  
-hereby runtests --tests=tests/cases/compiler/abstractClassUnionInstantiation.ts
+npx hereby runtests --tests=tests/cases/compiler/abstractClassUnionInstantiation.ts
 
 # Run tests matching a pattern
-hereby runtests --tests=tests/cases/fourslash/completion*.ts
+npx hereby runtests --tests=tests/cases/fourslash/completion*.ts
 ```
 
 ## Important Guidelines
 
+### 🚨 CRITICAL: Before Finishing Your Work 🚨
+
+**THESE STEPS ARE MANDATORY BEFORE COMMITTING/PUSHING ANY CHANGES:**
+
+1. **MUST RUN:** `npx hereby runtests-parallel` (even though it takes 10-15 minutes)
+2. **MUST RUN:** `npx hereby lint` and fix ALL lint issues
+3. **MUST RUN:** `npx hereby format` as the final step
+
+**❌ PRs that fail these checks will be rejected without review.**
+
+### Keeping Things Tidy
+
+- You can assume lint, tests, and formatting are clean on a fresh clone
+- Only run these verification steps AFTER making changes to code
+- Run `npx hereby lint` and fix ALL issues after making changes
+- Run `npx hereby format` as your final step after making changes
+
 ### Test Locations
+
 - Only add testcases in `tests/cases/compiler` or `tests/cases/fourslash`
+- Filenames in `tests/cases/compiler` must always end with `.ts`, not `.d.ts`
 - Do not write direct unit tests as they are almost never the correct test format for our repo
 
 ### Performance Expectations
+
 - Running a set of tests may take up to 4 minutes
 - A full test run may take up to 15 minutes
-- Always run `hereby lint` and `hereby format` before you're done
 
 ### Working with Issues
+
 - Maintainer comments in the issue should generally take priority over OP's comments
 - Maintainers might give you hints on where to start. They are not always right, but a good place to start
 
+### Debugging Tips
+
+printf debugging is going to be very useful as you are figuring things out.
+To do this, use `console.log`, but you'll need to `ts-ignore` it.
+Write something like this:
+```ts,diff
+function checkSomething(n: Node) {
+    doSomething(n);
++   // @ts-ignore DEBUG CODE ONLY, REMOVE ME WHEN DONE
++   console.log(`Got node with pos = ${n.pos}`);
+    doSomethingElse(n);
+}
+```
+We have a lot of enums so you might want to print back their symbolic name, to do this, index back into the name of the enum
+```ts
+   // @ts-ignore DEBUG CODE ONLY, REMOVE ME WHEN DONE
+   console.log(`Got node with kind = ${SyntaxKind[n.kind]}`);
+```
+
 ## Recommended Workflow
 
 When fixing bugs or implementing features, follow this workflow:
@@ -287,6 +325,18 @@ When fixing bugs or implementing features, follow this workflow:
    - Ensure the baselines change in a way that demonstrates that the bug is fixed
    - Put this baseline diff in its own commit
 
-4. **Run all other tests to ensure you didn't break anything**
-   - Some collateral baseline changes are normal
+4. **Add more testing**
+   - Once you've got the basics figured out, enhance your test to cover edge cases and other variations
+   - Run the test again and commit the baseline diff along with the test edit
+
+5. **🚨 MANDATORY: Run all other tests to ensure you didn't break anything**
+   - **REQUIRED:** Run `npx hereby runtests-parallel` and wait for it to finish (10-15 minutes is normal!)
+   - **THIS STEP CANNOT BE SKIPPED** - patience is essential!
+   - Some collateral baseline changes are normal, but review for correctness
    - Put these diffs in another commit
+
+6. **🚨 MANDATORY: Lint and format your changes**
+   - **REQUIRED:** Run `npx hereby lint` and fix ALL issues
+   - **REQUIRED:** Run `npx hereby format` before you're done
+   - **YOU CANNOT FINISH WITHOUT THESE STEPS**
+   - Double-check your line endings. Source files in this repo typically use CRLF line endings. Fix all line endings to be consistent before you wrap up

.github/workflows/accept-baselines-fix-lints.yaml

@@ -1,4 +1,4 @@
-name: Accept Baselines and Fix Lints
+name: Accept Baselines, Fix Lints, and Format
 
 on:
   workflow_dispatch: {}
@@ -32,8 +32,9 @@ jobs:
           git rm -r --quiet tests/baselines/reference
           npx hereby runtests-parallel --ci --fix || true
           npx hereby baseline-accept
+          npx hereby format
           git add ./src
           git add ./tests/baselines/reference
           git diff --cached
-          git commit -m "Update Baselines and/or Applied Lint Fixes"
+          git commit -m "Update Baselines, Applied Lint Fixes, and/or Formatted"
           git push

.github/workflows/ci.yml

@@ -9,6 +9,10 @@ on:
     branches:
       - main
       - release-*
+  merge_group:
+    branches:
+      - main
+      # - release-*
 
 permissions:
   contents: read
@@ -24,43 +28,107 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
-        node-version:
-          - '22'
-          - '20'
-          - '18'
-          - '16'
-          - '14'
-        bundle:
-          - 'true'
-        include:
-          - node-version: 'lts/*'
+        config:
+          # Main builds
+          - os: ubuntu-latest
+            node-version: '24'
+            bundle: true
+
+          # Other builds (skipped in merge queues)
+          - os: windows-latest
+            node-version: '24'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          - os: macos-latest
+            node-version: '24'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          - os: ubuntu-latest
+            node-version: '22'
+            bundle: true
+          - os: windows-latest
+            node-version: '22'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          # Skip macOS for this version; resources are limited.
+          # - os: macos-latest
+          #   node-version: '22'
+          #   bundle: true
+          #   skip: ${{ github.event_name == 'merge_group' }}
+          - os: ubuntu-latest
+            node-version: '20'
+            bundle: true
+          - os: windows-latest
+            node-version: '20'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          # Skip macOS for this version; resources are limited.
+          # - os: macos-latest
+          #   node-version: '20'
+          #   bundle: true
+          #   skip: ${{ github.event_name == 'merge_group' }}
+          - os: ubuntu-latest
+            node-version: '18'
+            bundle: true
+          - os: windows-latest
+            node-version: '18'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          # Skip macOS for this version; resources are limited.
+          # - os: macos-latest
+          #   node-version: '18'
+          #   bundle: true
+          #   skip: ${{ github.event_name == 'merge_group' }}
+          - os: ubuntu-latest
+            node-version: '16'
+            bundle: true
+          - os: windows-latest
+            node-version: '16'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          - os: macos-latest
+            node-version: '16'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          - os: ubuntu-latest
+            node-version: '14'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          - os: windows-latest
+            node-version: '14'
+            bundle: true
+            skip: ${{ github.event_name == 'merge_group' }}
+          # No Node 14 on ARM macOS
+          # - os: macos-latest
+          #   node-version: '14'
+          #   bundle: true
+          #   skip: ${{ github.event_name == 'merge_group' }}
+
+          - os: ubuntu-latest
+            node-version: 'lts/*'
             bundle: false
-            os: ubuntu-latest
+            skip: ${{ github.event_name == 'merge_group' }}
+
         exclude:
-          # No Node 14 on ARM macOS
-          - node-version: '14'
-            os: macos-latest
+          - config:
+              skip: true
 
-    runs-on: ${{ matrix.os }}
-    name: Test Node ${{ matrix.node-version }} on ${{ matrix.os }}${{ (!matrix.bundle && ' with --no-bundle') || '' }}
+    runs-on: ${{ matrix.config.os }}
+    name: Test Node ${{ matrix.config.node-version }} on ${{ matrix.config.os }}${{ (!matrix.config.bundle && ' with --no-bundle') || '' }}
 
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Use node version ${{ matrix.node-version }}
+      - name: Use node version ${{ matrix.config.node-version }}
         uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ matrix.config.node-version }}
           check-latest: true
       - run: npm ci
 
       - name: Tests
         id: test
         # run tests, but lint separately
-        run: npm run test -- --no-lint --bundle=${{ matrix.bundle }}
+        run: npm run test -- --no-lint --bundle=${{ matrix.config.bundle }}
 
       - name: Print baseline diff on failure
         if: ${{ failure() && steps.test.conclusion == 'failure' }}
@@ -70,6 +138,8 @@ jobs:
           git diff --staged --exit-code
 
   coverage:
+    if: ${{ github.event_name != 'merge_group' }}
+
     runs-on:
       - 'self-hosted'
       - '1ES.Pool=TypeScript-1ES-GitHub-Large'
@@ -95,7 +165,7 @@ jobs:
           name: coverage
           path: coverage
 
-      - uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5.4.2
+      - uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
         with:
           use_oidc: ${{ !(github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork) }}
           disable_search: true
@@ -294,6 +364,8 @@ jobs:
         run: npx hereby build-src --built
 
   baselines:
+    if: ${{ github.event_name != 'merge_group' }}
+
     runs-on: ubuntu-latest
 
     steps:
@@ -338,3 +410,27 @@ jobs:
         with:
           name: fix_baselines.patch
           path: fix_baselines.patch
+
+  required:
+    runs-on: ubuntu-latest
+    if: ${{ always() }}
+    needs:
+      - test
+      - coverage
+      - lint
+      - knip
+      - format
+      - browser-integration
+      - typecheck
+      - smoke
+      - package-size
+      - misc
+      - self-check
+      - baselines
+
+    steps:
+      - name: Check required jobs
+        env:
+          NEEDS: ${{ toJson(needs) }}
+        run: |
+          ! echo $NEEDS | jq -e 'to_entries[] | { job: .key, result: .value.result } | select((.result == "success" or .result == "skipped") | not)'

.github/workflows/codeql.yml

@@ -46,7 +46,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/init@39edc492dbe16b1465b0cafca41432d857bdb31a # v3.29.1
         with:
           config-file: ./.github/codeql/codeql-configuration.yml
         # Override language selection by uncommenting this and choosing your languages
@@ -56,7 +56,7 @@ jobs:
       # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below).
       - name: Autobuild
-        uses: github/codeql-action/autobuild@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/autobuild@39edc492dbe16b1465b0cafca41432d857bdb31a # v3.29.1
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -70,4 +70,4 @@ jobs:
       #     make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/analyze@39edc492dbe16b1465b0cafca41432d857bdb31a # v3.29.1

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,22 @@
+name: 'Copilot Setup Steps'
+on: workflow_dispatch
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+      - run: npm ci
+      # pull dprint caches before network access is blocked
+      - run: npx hereby check-format || true