Merge branch 'main' into remove-5.8-support

Author: plemarquand

.devcontainer/Dockerfile

@@ -1,5 +1,6 @@
-FROM swiftlang/swift:nightly-6.2-jammy
+FROM swiftlang/swift:nightly-jammy
 
+#  python3-lldb-13 is only needed for swiftly and a great dep to remove to test post-install script ;)
 RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
     && apt-get -q update \
     && apt-get -q dist-upgrade -y \
@@ -9,8 +10,11 @@ RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
       libsqlite3-dev \
       libncurses5-dev \
       python3 \
-      build-essential
+      python3-lldb-13 \
+      build-essential \
+      sudo
 
+# Install nvm / Node.js
 RUN mkdir -p /usr/local/nvm
 ENV NVM_DIR /usr/local/nvm
 ENV NODE_VERSION v20.19.0
@@ -21,3 +25,24 @@ ENV PATH $NODE_PATH:$PATH
 RUN npm -v
 RUN node -v
 
+# Create a "vscode" user that is a sudoer
+RUN useradd -ms /bin/bash vscode
+RUN echo "vscode:vscode" | chpasswd
+RUN adduser vscode sudo
+
+# Install swiftly
+USER vscode
+ENV SWIFTLY_HOME_DIR /home/vscode/.swiftly
+ENV SWIFTLY_BIN_DIR /home/vscode/.swiftly/bin
+ENV SWIFTLY_TOOLCHAINS_DIR /home/vscode/.swiftly/bin
+RUN mkdir -p $SWIFTLY_HOME_DIR
+RUN cd ~ && curl -O https://download.swift.org/swiftly/linux/swiftly-$(uname -m).tar.gz && \
+    tar zxf swiftly-$(uname -m).tar.gz && \
+    ./swiftly init --quiet-shell-followup && \
+    . "${SWIFTLY_HOME_DIR}/env.sh" && \
+    hash -r
+
+# Use swiftly toolchain by default
+RUN echo "export SWIFTLY_HOME_DIR=$SWIFTLY_HOME_DIR" >> ~/.bashrc
+RUN echo "export SWIFTLY_BIN_DIR=$SWIFTLY_BIN_DIR" >> ~/.bashrc
+RUN echo '. "${SWIFTLY_HOME_DIR}/env.sh"' >> ~/.bashrc

.devcontainer/devcontainer.json

@@ -4,9 +4,6 @@
     "features": {
         "ghcr.io/devcontainers/features/common-utils:2": {
             "installZsh": "false",
-            "username": "vscode",
-            "userUid": "1000",
-            "userGid": "1000",
             "upgradePackages": "false"
         },
         "ghcr.io/devcontainers/features/git:1": {
@@ -35,7 +32,8 @@
         "source=node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
     ],
     // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "sudo chown vscode node_modules && npm install",
+    // Modify /etc/sudoers.d/vscode to make sure we're always prompted for root password for testing askpass.
+    "postCreateCommand": "sudo chown vscode node_modules && echo 'vscode ALL=(ALL:ALL) ALL' | sudo tee /etc/sudoers.d/vscode && npm install",
     // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
     "remoteUser": "vscode"
 }

.eslintrc.json

@@ -6,14 +6,22 @@
     "sourceType": "module",
     "project": true
   },
-  "plugins": ["@typescript-eslint"],
+  "plugins": ["@typescript-eslint", "mocha"],
   "rules": {
     "curly": "error",
     "eqeqeq": "warn",
     "no-throw-literal": "warn",
     // TODO "@typescript-eslint/semi" rule moved to https://eslint.style
     "semi": "error",
     "no-console": "warn",
+    "mocha/no-exclusive-tests": "error",
+    "no-restricted-syntax": [
+      "error",
+      {
+        "selector": "CallExpression[callee.object.object.callee.name='tag'][callee.property.name='only']",
+        "message": "Unexpected exclusive mocha test with tag().suite.only() or tag().test.only()"
+      }
+    ],
     "@typescript-eslint/no-floating-promises": ["warn", { "checkThenables": true }],
     "@typescript-eslint/await-thenable": "warn",
     // Mostly fails tests, ex. expect(...).to.be.true returns a Chai.Assertion

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,5 +26,10 @@ A clear and concise description of what you expected to happen.
  - Visual Studio Code version:
  - vscode-swift version:
 
+**Diagnostics Bundle**
+The diagnostics bundle can help determine the root cause of bugs much quicker. To share this information execute the `>Swift: Capture Diagnostics Bundle` command and attach the archive to the bug report.
+
+*Select the "Minimal" bundle to only share the Swift extension's log and your configured `swift.` settings. Select the "Full" bundle if you're comfortable sharing the SourceKit-LSP diagnostic bundle and LLDB-DAP logs, which may contain source code*
+
 **Additional context**
 Add any other context about the problem here.

.github/dependabot.yml

@@ -4,6 +4,8 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 7
     open-pull-requests-limit: 5
     allow:
       - dependency-type: direct
@@ -22,6 +24,11 @@ updates:
       - dependency-name: "@types/svgicons2svgfont"
       - dependency-name: "octokit"
         update-types: ["version-update:semver-major"]
+      - dependency-name: "eslint-plugin-mocha"
+        update-types: ["version-update:semver-major"]
+      # Newer versions of fantasticon are broken on Windows.
+      # https://github.com/tancredi/fantasticon/issues/470
+      - dependency-name: "fantasticon"
     groups:
       all-dependencies:
         patterns:

.github/workflows/nightly.yml

@@ -1,9 +1,17 @@
 name: Nightly
 
+permissions:
+  contents: read
+
 on:
   schedule:
     - cron: "0 0 * * *"
   workflow_dispatch:
+    inputs:
+      patchRelease:
+        description: 'Make a patch release'
+        required: false
+        type: boolean
 
 jobs:
   package:
@@ -24,7 +32,12 @@ jobs:
           . .github/workflows/scripts/setup-linux.sh
           [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
           npm ci
-          npm run package
+          if [ "${{github.event.inputs.patchRelease}}" = "true" ]; then
+            echo "Making patch release\n"
+            npm run patch-package
+          else
+            npm run package
+          fi
           npm run preview-package
           for file in *.vsix; do
             name="$(basename "$file" .vsix)-${{github.run_number}}.vsix"
@@ -62,7 +75,7 @@ jobs:
       linux_pre_build_command: . .github/workflows/scripts/setup-linux.sh
       linux_build_command: ./scripts/test.sh
       # Windows
-      windows_exclude_swift_versions: '[{"swift_version": "nightly-6.1"},{"swift_version": "nightly"}]'  # Missing https://github.com/swiftlang/swift/pull/80144
+      windows_exclude_swift_versions: '[{"swift_version": "nightly-6.1"}, {"swift_version": "nightly"},  {"swift_version": "6.2"}]'  # Missing https://github.com/swiftlang/swift/pull/80144
       windows_env_vars: |
         CI=1
         VSCODE_SWIFT_VSIX_ID=${{needs.package.outputs.artifact-id}}
@@ -101,3 +114,5 @@ jobs:
       windows_pre_build_command: . .github\workflows\scripts\windows\setup.ps1
       windows_build_command: Invoke-Program scripts\test_windows.ps1
       enable_windows_docker: false
+      # TODO re-enable when 6.2.1 toolchain working
+      enable_windows_checks: false

.github/workflows/pull_request.yml

@@ -1,5 +1,8 @@
 name: Pull request
 
+permissions:
+  contents: read
+
 on:
   pull_request:
     types: [opened, reopened, synchronize]
@@ -61,7 +64,7 @@ jobs:
       linux_pre_build_command: . .github/workflows/scripts/setup-linux.sh
       linux_build_command: ./scripts/test.sh
       # Windows
-      windows_exclude_swift_versions: "${{ contains(github.event.pull_request.labels.*.name, 'full-test-run') && '[{\"swift_version\": \"nightly-6.1\"},{\"swift_version\": \"nightly\"}]' || '[{\"swift_version\": \"nightly-6.1\"},{\"swift_version\": \"nightly-6.2\"},{\"swift_version\": \"nightly\"}]' }}"
+      windows_exclude_swift_versions: "${{ contains(github.event.pull_request.labels.*.name, 'full-test-run') && '[{\"swift_version\": \"nightly-6.1\"},{\"swift_version\": \"nightly\", {\"swift_version\": \"6.2\"}}]' || '[{\"swift_version\": \"nightly-6.1\"},{\"swift_version\": \"nightly-6.2\"},{\"swift_version\": \"nightly\"}]' }}"
       windows_env_vars: |
         CI=1
         FAST_TEST_RUN=${{ contains(github.event.pull_request.labels.*.name, 'full-test-run') && '0' || '1'}}

.github/workflows/scripts/windows/setup.ps1

@@ -2,7 +2,7 @@
 . .github\workflows\scripts\windows\install-nodejs.ps1
 
 # Download the VSIX archived upstream
-npm ci -ignore-script node-pty
+npm ci
 $Process = Start-Process npx "tsx scripts/download_vsix.ts" -Wait -PassThru -NoNewWindow
 if ($Process.ExitCode -eq 0) {
     Write-Host 'SUCCESS'

.gitignore

@@ -6,6 +6,9 @@ coverage
 test-results
 userdocs/userdocs.docc/.docc-build
 
+# SwiftPM cache for tests
+.spm-cache
+
 # Generated Assets
 assets/documentation-webview
 assets/icons

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/