Merge pull request #1 from swiftlang/main

update

Author: fpseverino

.gitattributes

@@ -0,0 +1 @@
+CHANGELOG.md -text merge=union

…EQUEST_TEMPLATE/pull_request_template.md .github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE/pull_request_template.md renamed to .github/PULL_REQUEST_TEMPLATE.md .github/PULL_REQUEST_TEMPLATE/pull_request_template.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -5,4 +5,12 @@ contributing guidelines for any contributions -->
 it on the forums or on Slack. This ensures that you don't waste any time working on contributions that
 won't get accepted! -->
 
-<!-- Describe your changes clearly and use examples if possible. Please link to any GitHub issue if applicable -->
+## Description
+Describe your changes clearly and use examples if possible
+
+Issue: Please provide reference link to the Github issue
+
+## Tasks
+- [ ] Required tests have been written
+- [ ] Documentation has been updated
+- [ ] Added an entry to CHANGELOG.md if applicable

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## {{releaseVersion}} - {{releaseDate}}
 
+### Fixed
+
+- Cleanup Swift diagnostics when the source file is moved or deleted ([#1653](https://github.com/swiftlang/vscode-swift/pull/1653))
+- Make sure newline starts with /// when splitting doc comment ([#1651](https://github.com/swiftlang/vscode-swift/pull/1651))
+- Capture diagnostics with `Swift: Capture Diagnostic Bundle` to a .zip file ([#1656](https://github.com/swiftlang/vscode-swift/pull/1656))
+- Prevent continuous "package resolve" cycles ([#1654](https://github.com/swiftlang/vscode-swift/pull/1654))
+- Fix error when running `Reset Package Dependencies` command from the Project view ([#1661](https://github.com/swiftlang/vscode-swift/pull/1661))
+- Mark tests as skipped when a compilation error preempts a test run ([#1659](https://github.com/swiftlang/vscode-swift/pull/1659))
+
+## 2.6.0 - 2025-06-26
+
 ### Added
 
 - Support for [multi-root .code-workspace](https://code.visualstudio.com/docs/editing/workspaces/multi-root-workspaces) workspaces ([#1566](https://github.com/swiftlang/vscode-swift/pull/1566))

package.json

@@ -2,7 +2,7 @@
   "name": "swift-vscode",
   "displayName": "Swift",
   "description": "Swift Language Support for Visual Studio Code.",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "publisher": "swiftlang",
   "icon": "icon.png",
   "repository": {
@@ -1712,6 +1712,7 @@
     "contributors": "./scripts/generate_contributors_list.sh"
   },
   "devDependencies": {
+    "@types/archiver": "^6.0.3",
     "@types/chai": "^4.3.19",
     "@types/chai-as-promised": "^7.1.8",
     "@types/chai-subset": "^1.3.6",
@@ -1764,6 +1765,7 @@
   },
   "dependencies": {
     "@vscode/codicons": "^0.0.36",
+    "archiver": "^7.0.1",
     "fast-glob": "^3.3.3",
     "lcov-parse": "^1.0.0",
     "plist": "^3.1.0",

scripts/package.ts

@@ -26,6 +26,12 @@ main(async () => {
     const rootDirectory = getRootDirectory();
     const version = await getExtensionVersion();
     const versionString = `${version.major}.${version.minor}.${version.patch}`;
+
+    if (process.platform === "win32") {
+        console.log("Packaging the extension is not supported on Windows.");
+        return process.exit(0);
+    }
+
     // Update version in CHANGELOG
     await updateChangelog(versionString);
     // Use VSCE to package the extension

scripts/test_windows.ps1

@@ -16,10 +16,20 @@ function Update-SwiftBuildAndPackageArguments {
     param (
         [string]$jsonFilePath = "./assets/test/.vscode/settings.json",
         [string]$codeWorkspaceFilePath = "./assets/test.code-workspace",
-        [string]$windowsSdkVersion = "10.0.22000.0",
-        [string]$vcToolsVersion = "14.44.35207"
+        [string]$windowsSdkVersion = "10.0.22000.0"
     )
 
+    $vcToolsPath = "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC"
+    $vcToolsVersions = Get-ChildItem -Directory -Path $vcToolsPath | ForEach-Object { $_.Name }
+
+    if ($vcToolsVersions.Count -eq 0) {
+        Write-Host "No versions found in $vcToolsPath"
+        exit 1
+    }
+
+    $vcToolsVersion = $vcToolsVersions | Sort-Object -Descending | Select-Object -First 1
+    Write-Host "Highest Visual C++ Tools version: $vcToolsVersion"
+
     $windowsSdkRoot = "C:\Program Files (x86)\Windows Kits\10\"
 
     try {
@@ -39,7 +49,6 @@ function Update-SwiftBuildAndPackageArguments {
     if ($jsonContent.PSObject.Properties['swift.buildArguments']) {
         $jsonContent.PSObject.Properties.Remove('swift.buildArguments')
     }
-    
 
     $jsonContent | Add-Member -MemberType NoteProperty -Name "swift.buildArguments" -Value @(
         "-Xbuild-tools-swiftc", "-windows-sdk-root", "-Xbuild-tools-swiftc", $windowsSdkRoot,
@@ -63,7 +72,6 @@ function Update-SwiftBuildAndPackageArguments {
         "-Xswiftc", "-visualc-tools-version", "-Xswiftc", $vcToolsVersion
     )
 
-
     $codeWorkspaceContent.PSObject.Properties.Remove('settings')
     $codeWorkspaceContent | Add-Member -MemberType NoteProperty -Name "settings" -Value $jsonContent
 
@@ -88,6 +96,12 @@ if ($LASTEXITCODE -ne 0) {
 Write-Host "Swift version:"
 Write-Host "$swiftVersionOutput"
 
+Write-Host "Installed MSVC Versions:"
+dir "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC"
+
+Write-Host "Installed Windows SDK Versions:"
+dir "C:\Program Files (x86)\Windows Kits\10\Include\"
+
 $versionLine = $swiftVersionOutput[0]
 if ($versionLine -match "Swift version (\d+)\.(\d+)") {
     Write-Host "Matched Swift version: $($matches[0]), $($matches[1]), $($matches[2])"

src/BackgroundCompilation.ts

@@ -19,11 +19,11 @@ import { FolderContext } from "./FolderContext";
 import { TaskOperation } from "./tasks/TaskQueue";
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 import debounce = require("lodash.debounce");
+import { validFileTypes } from "./utilities/filesystem";
 
 export class BackgroundCompilation implements vscode.Disposable {
     private workspaceFileWatcher?: vscode.FileSystemWatcher;
     private configurationEventDisposable?: vscode.Disposable;
-    private validFileTypes = ["swift", "c", "cpp", "h", "hpp", "m", "mm"];
     private disposables: vscode.Disposable[] = [];
 
     constructor(private folderContext: FolderContext) {
@@ -44,7 +44,7 @@ export class BackgroundCompilation implements vscode.Disposable {
     }
 
     private setupFileWatching() {
-        const fileTypes = this.validFileTypes.join(",");
+        const fileTypes = validFileTypes.join(",");
         const rootFolders = ["Sources", "Tests", "Snippets", "Plugins"].join(",");
         this.disposables.push(
             (this.workspaceFileWatcher = vscode.workspace.createFileSystemWatcher(

src/DiagnosticsManager.ts

@@ -21,6 +21,7 @@ import configuration from "./configuration";
 import { SwiftExecution } from "./tasks/SwiftExecution";
 import { WorkspaceContext } from "./WorkspaceContext";
 import { checkIfBuildComplete, lineBreakRegex } from "./utilities/tasks";
+import { validFileTypes } from "./utilities/filesystem";
 
 interface ParsedDiagnostic {
     uri: string;
@@ -102,6 +103,17 @@ export class DiagnosticsManager implements vscode.Disposable {
                     context.outputChannel.log(`${e}`, 'Failed to provide "swiftc" diagnostics')
                 );
         });
+        const fileTypes = validFileTypes.join(",");
+        this.workspaceFileWatcher = vscode.workspace.createFileSystemWatcher(
+            `**/*.{${fileTypes}}`,
+            true,
+            true
+        );
+        this.onDidDeleteDisposible = this.workspaceFileWatcher.onDidDelete(uri => {
+            if (this.allDiagnostics.delete(uri.fsPath)) {
+                this.diagnosticCollection.delete(uri);
+            }
+        });
     }
 
     /**
@@ -276,6 +288,8 @@ export class DiagnosticsManager implements vscode.Disposable {
         this.diagnosticCollection.dispose();
         this.onDidStartTaskDisposible.dispose();
         this.onDidChangeConfigurationDisposible.dispose();
+        this.onDidDeleteDisposible.dispose();
+        this.workspaceFileWatcher.dispose();
     }
 
     private includeSwiftcDiagnostics(): boolean {
@@ -454,4 +468,6 @@ export class DiagnosticsManager implements vscode.Disposable {
 
     private onDidStartTaskDisposible: vscode.Disposable;
     private onDidChangeConfigurationDisposible: vscode.Disposable;
+    private onDidDeleteDisposible: vscode.Disposable;
+    private workspaceFileWatcher: vscode.FileSystemWatcher;
 }

src/PackageWatcher.ts

@@ -30,6 +30,7 @@ import { showReloadExtensionNotification } from "./ui/ReloadExtension";
  */
 export class PackageWatcher {
     private packageFileWatcher?: vscode.FileSystemWatcher;
+    private resolvedChangedDisposable?: vscode.Disposable;
     private resolvedFileWatcher?: vscode.FileSystemWatcher;
     private workspaceStateFileWatcher?: vscode.FileSystemWatcher;
     private snippetWatcher?: vscode.FileSystemWatcher;
@@ -59,6 +60,7 @@ export class PackageWatcher {
      */
     dispose() {
         this.packageFileWatcher?.dispose();
+        this.resolvedChangedDisposable?.dispose();
         this.resolvedFileWatcher?.dispose();
         this.workspaceStateFileWatcher?.dispose();
         this.snippetWatcher?.dispose();
@@ -77,11 +79,18 @@ export class PackageWatcher {
 
     private createResolvedFileWatcher(): vscode.FileSystemWatcher {
         const watcher = vscode.workspace.createFileSystemWatcher(
-            new vscode.RelativePattern(this.folderContext.folder, "Package.resolved")
+            new vscode.RelativePattern(this.folderContext.folder, "Package.resolved"),
+            // https://github.com/swiftlang/vscode-swift/issues/1571
+            // We can ignore create because that would be seemingly from a Package.resolved
+            // and will ignore delete as we don't know the reason behind. By still listening
+            // for change
+            true,
+            false,
+            true
+        );
+        this.resolvedChangedDisposable = watcher.onDidChange(
+            async () => await this.handlePackageResolvedChange()
         );
-        watcher.onDidCreate(async () => await this.handlePackageResolvedChange());
-        watcher.onDidChange(async () => await this.handlePackageResolvedChange());
-        watcher.onDidDelete(async () => await this.handlePackageResolvedChange());
         return watcher;
     }
 

src/TestExplorer/TestRunner.ts

@@ -18,7 +18,12 @@ import * as stream from "stream";
 import * as os from "os";
 import * as asyncfs from "fs/promises";
 import { FolderContext } from "../FolderContext";
-import { compactMap, execFile, getErrorDescription } from "../utilities/utilities";
+import {
+    compactMap,
+    execFile,
+    getErrorDescription,
+    IS_PRODUCTION_BUILD,
+} from "../utilities/utilities";
 import { createSwiftTask } from "../tasks/SwiftTaskProvider";
 import configuration from "../configuration";
 import { WorkspaceContext } from "../WorkspaceContext";
@@ -67,6 +72,7 @@ export interface TestRunState {
     passed: vscode.TestItem[];
     skipped: vscode.TestItem[];
     errored: vscode.TestItem[];
+    enqueued: vscode.TestItem[];
     unknown: number;
     output: string[];
 }
@@ -95,6 +101,7 @@ export class TestRunProxy {
             passed: [],
             skipped: [],
             errored: [],
+            enqueued: [],
             unknown: 0,
             output: [],
         };
@@ -181,10 +188,9 @@ export class TestRunProxy {
         for (const outputLine of this.queuedOutput) {
             this.performAppendOutput(this.testRun, outputLine);
         }
-        this.queuedOutput = [];
 
         for (const test of this.testItems) {
-            this.testRun.enqueued(test);
+            this.enqueued(test);
         }
     };
 
@@ -218,11 +224,17 @@ export class TestRunProxy {
         }
     }
 
+    private enqueued(test: vscode.TestItem) {
+        this.testRun?.enqueued(test);
+        this.runState.enqueued.push(test);
+    }
+
     public unknownTestRan() {
         this.runState.unknown++;
     }
 
     public started(test: vscode.TestItem) {
+        this.clearEnqueuedTest(test);
         this.runState.pending.push(test);
         this.testRun?.started(test);
     }
@@ -231,7 +243,29 @@ export class TestRunProxy {
         this.runState.pending = this.runState.pending.filter(t => t !== test);
     }
 
+    private clearEnqueuedTest(test: vscode.TestItem) {
+        if (IS_PRODUCTION_BUILD) {
+            // `runState.enqueued` exists only for test validation purposes.
+            return;
+        }
+
+        this.runState.enqueued = this.runState.enqueued.filter(t => t !== test);
+
+        if (!test.parent) {
+            return;
+        }
+
+        const parentHasEnqueuedChildren = Array.from(test.parent.children).some(([_, child]) =>
+            this.runState.enqueued.includes(child)
+        );
+
+        if (!parentHasEnqueuedChildren) {
+            this.clearEnqueuedTest(test.parent);
+        }
+    }
+
     public skipped(test: vscode.TestItem) {
+        this.clearEnqueuedTest(test);
         test.tags = [...test.tags, new vscode.TestTag(TestRunProxy.Tags.SKIPPED)];
 
         this.runState.skipped.push(test);
@@ -240,6 +274,7 @@ export class TestRunProxy {
     }
 
     public passed(test: vscode.TestItem, duration?: number) {
+        this.clearEnqueuedTest(test);
         this.runState.passed.push(test);
         this.clearPendingTest(test);
         this.testRun?.passed(test, duration);
@@ -250,6 +285,7 @@ export class TestRunProxy {
         message: vscode.TestMessage | readonly vscode.TestMessage[],
         duration?: number
     ) {
+        this.clearEnqueuedTest(test);
         this.runState.failed.push({ test, message });
         this.clearPendingTest(test);
         this.testRun?.failed(test, message, duration);
@@ -260,6 +296,7 @@ export class TestRunProxy {
         message: vscode.TestMessage | readonly vscode.TestMessage[],
         duration?: number
     ) {
+        this.clearEnqueuedTest(test);
         this.runState.errored.push(test);
         this.clearPendingTest(test);
         this.testRun?.errored(test, message, duration);
@@ -278,6 +315,21 @@ export class TestRunProxy {
             this.failed(test, new vscode.TestMessage("Test did not complete."));
         });
 
+        // If there are tests that never started, mark them as skipped.
+        // This can happen if there is a build error preventing tests from running.
+        this.runState.enqueued.forEach(test => {
+            // Omit adding the root test item as a skipped test to keep just the suites/tests
+            // in the test run output, just like a regular pass/fail test run.
+            if (test.parent) {
+                for (const output of this.queuedOutput) {
+                    this.appendOutputToTest(output, test);
+                }
+                this.skipped(test);
+            }
+        });
+
+        this.queuedOutput = [];
+
         this.reportAttachments();
         this.testRun?.end();
         this.testRunCompleteEmitter.fire();