You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This change migrates the markdown based documentation into a DocC
bundle with the goal to publish this documentation on swift.org.
This change:
* Adds a DocC bundle with the existing documentation
* Pares down the readme to remove most of the documentation and
links out to the documentation instead
* Adds a command to the extension to open the documentation
* Adds the open documentation command to the project view
Copy file name to clipboardexpand all lines: README.md
+4-107
Original file line number
Diff line number
Diff line change
@@ -10,116 +10,13 @@ This extension adds language support for Swift to Visual Studio Code, providing
10
10
* Package dependency view
11
11
* Test Explorer view
12
12
13
-
This extension uses [SourceKit LSP](https://github.com/apple/sourcekit-lsp) for the [language server](https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/), which powers code completion. It also has a dependency on [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap) for debugging.
14
-
15
-
To propose new features, you can post on the [swift.org forums](https://forums.swift.org) in the [VS Code Swift Extension category](https://forums.swift.org/c/related-projects/vscode-swift-extension/). If you run into something that doesn't work the way you'd expect, you can [file an issue in the GitHub repository](https://github.com/swiftlang/vscode-swift/issues/new).
16
-
17
-
## Installation
18
-
19
-
The Swift extension is supported on macOS, Linux, and Windows. To install, firstly ensure you have [Swift installed on your system](https://www.swift.org/install/). Then [install the Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode). Once your machine is ready, you can get started with the **Swift: Create New Project...** command.
20
-
21
-
## Features
22
-
23
-
### Language features
24
-
25
-
The extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). To ensure the extension functions correctly, it’s important to first build the project so that SourceKit-LSP has access to all the symbol data. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.
26
-
27
-
### Automatic task creation
28
-
29
-
For workspaces that contain a **Package.swift** file, this extension will add the following tasks:
30
-
31
-
-**Build All**: Build all targets in the Package
32
-
-**Build Debug <Executable>**: Each executable in a Package.swift get a task for building a debug build
33
-
-**Build Release <Executable>**: Each executable in a Package.swift get a task for building a release build
34
-
35
-
These tasks are available via **Terminal ▸ Run Task...** and **Terminal ▸ Run Build Task...**.
36
-
37
-
### Commands
38
-
39
-
The extension adds the following commands, available via the command palette.
40
-
41
-
#### Configuration
42
-
43
-
-**Create New Project...**: Create a new Swift project using a template. This opens a dialog to guide you through creating a new project structure.
44
-
-**Create New Swift File...**: Create a new `.swift` file in the current workspace.
45
-
-**Select Toolchain**: Select the locally installed Swift toolchain (including Xcode toolchains on macOS) that you want to use Swift tools from.
46
-
47
-
The following command is only available on macOS:
48
-
49
-
-**Select Target Platform**: This is an experimental command that offers code editing support for iOS, tvOS, watchOS and visionOS projects.
50
-
51
-
#### Building and Debugging
52
-
53
-
-**Run Build**: Run `swift build` for the package associated with the open file.
54
-
-**Debug Build**: Run `swift build` with debugging enabled for the package associated with the open file, launching the binary and attaching the debugger.
55
-
-**Attach to Process...**: Attach the debugger to an already running process for debugging.
56
-
-**Clean Build Folder**: Clean the build folder for the package associated with the open file, removing all previously built products.
57
-
58
-
#### Dependency Management
13
+
# Documentation
59
14
60
-
-**Resolve Package Dependencies**: Run `swift package resolve` on packages associated with the open file.
61
-
-**Update Package Dependencies**: Run `swift package update` on packages associated with the open file.
62
-
-**Reset Package Dependencies**: Run `swift package reset` on packages associated with the open file.
63
-
-**Add to Workspace**: Add the current package to the active workspace in VS Code.
64
-
-**Clean Build**: Run `swift package clean` on packages associated with the open file.
65
-
-**Open Package.swift**: Open `Package.swift` for the package associated with the open file.
66
-
-**Use Local Version**: Switch the package dependency to use a local version of the package instead of the remote repository version.
67
-
-**Edit Locally**: Make the package dependency editable locally, allowing changes to the dependency to be reflected immediately.
68
-
-**Revert To Original Version**: Revert the package dependency to its original, unedited state after local changes have been made.
69
-
-**View Repository**: Open the external repository of the selected Swift package in a browser.
15
+
The official documentation for this extension is available at [vscode-swift](https://www.swift.org/vscode/documentation/vscode)
70
16
71
-
#### Testing
72
-
73
-
-**Test: Run All Tests**: Run all the tests across all test targes in the open project.
74
-
-**Test: Rerun Last Run**: Perform the last test run again.
75
-
-**Test: Open Coverage**: Open the last generated coverage report, if one exists.
76
-
-**Test: Run All Tests in Parallel**: Run all tests in parallel. This action only affects XCTests. Swift-testing tests are parallel by default, and their parallelism [is controlled in code](https://developer.apple.com/documentation/testing/parallelization).
77
-
78
-
#### Snippets and Scripts
79
-
80
-
-**Insert Function Comment**: Insert a standard comment block for documenting a Swift function in the current file.
81
-
-**Run Swift Script**: Run the currently open file, as a Swift script. The file must not be part of a build target. If the file has not been saved it will save it to a temporary file so it can be run.
82
-
-**Run Swift Snippet**: If the currently open file is a Swift snippet then run it.
83
-
-**Debug Swift Snippet**: If the currently open file is a Swift snippet then debug it.
84
-
85
-
#### Diagnostics
86
-
87
-
-**Capture VS Code Swift Diagnostic Bundle**: Capture a diagnostic bundle from VS Code, containing logs and information to aid in troubleshooting Swift-related issues.
88
-
-**Clear Diagnostics Collection**: Clear all collected diagnostics in the current workspace to start fresh.
89
-
-**Restart LSP Server**: Restart the Swift Language Server Protocol (LSP) server for the current workspace.
90
-
-**Re-Index Project**: Force a re-index of the project to refresh code completion and symbol navigation support.
91
-
92
-
### Package dependencies
93
-
94
-
If your workspace contains a package that has dependencies, this extension will add a **Package Dependencies** view to the Explorer:
95
-
96
-
97
-
98
-
Additionally, the extension will monitor `Package.swift` and `Package.resolved` for changes, resolve any changes to the dependencies, and update the view as needed.
99
-
100
-
### Debugging
101
-
102
-
The Swift extension uses the [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap) extension for debugging.
103
-
104
-
When you open a Swift package (a directory containing a `Package.swift` file), the extension automatically generates build tasks and launch configurations for each executable within the package. Additionally, if the package includes tests, the extension creates a configuration specifically designed to run those tests. These configurations all leverage the CodeLLDB extension as the debugger of choice.
105
-
106
-
Use the **Run > Start Debugging** menu item to run an executable and start debugging. If you have multiple launch configurations you can choose which launch configuration to use in the debugger view.
107
-
108
-
CodeLLDB includes a version of `lldb` that it uses by default for debugging, but this version of `lldb` doesn’t support Swift. The Swift extension will automatically identify the required version and offer to update the CodeLLDB configuration as necessary so that debugging is supported.
109
-
110
-
### Test Explorer
111
-
112
-
If your package contains tests then they can be viewed, run and debugged in the Test Explorer.
113
-
114
-
115
-
116
-
Once your project is built, the Test Explorer will list all your tests. These tests are grouped by package, then test target, and finally, by XCTestCase class. From the Test Explorer, you can initiate a test run, debug a test run, and if a file has already been opened, you can jump to the source code for a test.
117
-
118
-
### Documentation
17
+
This extension uses [SourceKit LSP](https://github.com/apple/sourcekit-lsp) for the [language server](https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/), which powers code completion. It also has a dependency on [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap) for debugging.
119
18
120
-
*[Extension Settings](docs/settings.md)
121
-
*[Test Coverage](docs/test-coverage.md)
122
-
*[Visual Studio Code Dev Containers](docs/remote-dev.md)
19
+
To propose new features, you can post on the [swift.org forums](https://forums.swift.org) in the [VS Code Swift Extension category](https://forums.swift.org/c/related-projects/vscode-swift-extension/). If you run into something that doesn't work the way you'd expect, you can [file an issue in the GitHub repository](https://github.com/swiftlang/vscode-swift/issues/new).
vscode-swift adds various commands to Visual Studio Code.
4
+
5
+
The extension adds the following commands, available via the command palette.
6
+
7
+
#### Configuration
8
+
9
+
-**Create New Project...**: Create a new Swift project using a template. This opens a dialog to guide you through creating a new project structure.
10
+
-**Create New Swift File...**: Create a new `.swift` file in the current workspace.
11
+
-**Select Toolchain**: Select the locally installed Swift toolchain (including Xcode toolchains on macOS) that you want to use Swift tools from.
12
+
13
+
The following command is only available on macOS:
14
+
15
+
-**Select Target Platform**: This is an experimental command that offers code completion for iOS and tvOS projects.
16
+
17
+
#### Building and Debugging
18
+
19
+
-**Run Build**: Run `swift build` for the package associated with the open file.
20
+
-**Debug Build**: Run `swift build` with debugging enabled for the package associated with the open file, launching the binary and attaching the debugger.
21
+
-**Attach to Process...**: Attach the debugger to an already running process for debugging.
22
+
-**Clean Build Folder**: Clean the build folder for the package associated with the open file, removing all previously built products.
23
+
24
+
#### Dependency Management
25
+
26
+
-**Resolve Package Dependencies**: Run `swift package resolve` on packages associated with the open file.
27
+
-**Update Package Dependencies**: Run `swift package update` on packages associated with the open file.
28
+
-**Reset Package Dependencies**: Run `swift package reset` on packages associated with the open file.
29
+
-**Add to Workspace**: Add the current package to the active workspace in VS Code.
30
+
-**Clean Build**: Run `swift package clean` on packages associated with the open file.
31
+
-**Open Package.swift**: Open `Package.swift` for the package associated with the open file.
32
+
-**Use Local Version**: Switch the package dependency to use a local version of the package instead of the remote repository version.
33
+
-**Edit Locally**: Make the package dependency editable locally, allowing changes to the dependency to be reflected immediately.
34
+
-**Revert To Original Version**: Revert the package dependency to its original, unedited state after local changes have been made.
35
+
-**View Repository**: Open the external repository of the selected Swift package in a browser.
36
+
37
+
#### Testing
38
+
39
+
-**Test: Run All Tests**: Run all the tests across all test targes in the open project.
40
+
-**Test: Rerun Last Run**: Perform the last test run again.
41
+
-**Test: Open Coverage**: Open the last generated coverage report, if one exists.
42
+
-**Test: Run All Tests in Parallel**: Run all tests in parallel. This action only affects XCTests. Swift-testing tests are parallel by default, and their parallelism [is controlled in code](https://developer.apple.com/documentation/testing/parallelization).
43
+
44
+
#### Snippets and Scripts
45
+
46
+
-**Insert Function Comment**: Insert a standard comment block for documenting a Swift function in the current file.
47
+
-**Run Swift Script**: Run the currently open file, as a Swift script. The file must not be part of a build target. If the file has not been saved it will save it to a temporary file so it can be run.
48
+
-**Run Swift Snippet**: If the currently open file is a Swift snippet then run it.
49
+
-**Debug Swift Snippet**: If the currently open file is a Swift snippet then debug it.
50
+
51
+
#### Diagnostics
52
+
53
+
-**Capture VS Code Swift Diagnostic Bundle**: Capture a diagnostic bundle from VS Code, containing logs and information to aid in troubleshooting Swift-related issues.
54
+
-**Clear Diagnostics Collection**: Clear all collected diagnostics in the current workspace to start fresh.
55
+
-**Restart LSP Server**: Restart the Swift Language Server Protocol (LSP) server for the current workspace.
56
+
-**Re-Index Project**: Force a re-index of the project to refresh code completion and symbol navigation support.
vscode-swift allows you to debug your Swift packages.
4
+
5
+
> Tip: Debugging works best when using a version of the Swift toolchain 6.0 or higher
6
+
7
+
When you open a Swift package (a directory containing a `Package.swift` file), the extension automatically generates build tasks and launch configurations for each executable within the package. Additionally, if the package includes tests, the extension creates a configuration specifically designed to run those tests. These configurations all leverage the CodeLLDB extension as the debugger of choice.
8
+
9
+
Use the **Run > Start Debugging** menu item to run an executable and start debugging. If you have multiple launch configurations you can choose which launch configuration to use in the debugger view.
vscode-code Swift is installed through the extension marketplace.
4
+
5
+
The Swift extension is supported on macOS, Linux, and Windows.
6
+
7
+
To install, firstly ensure you have [Swift installed on your system](https://www.swift.org/install/). Then [install the Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode). Once your machine is ready, you can get started with the **Swift: Create New Project...** command.
vscode-swift provides various language features to help you write Swift code.
4
+
5
+
The extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). To ensure the extension functions correctly, it’s important to first build the project so that SourceKit-LSP has access to all the symbol data. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.
If your workspace contains a package, this extension will add a **Swift Project** view to the Explorer:
6
+
7
+
8
+
9
+
Additionally, the extension will monitor `Package.swift` and `Package.resolved` for changes, resolve any changes to the dependencies, and update the view as needed.
Copy file name to clipboardexpand all lines: userdocs/userdocs.docc/remote-dev.md
+2
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Visual Studio Code Dev Containers
2
2
3
+
Dev containers can be used as an easy way to develop when building for other platforms.
4
+
3
5
[VS Code Dev Containers](https://code.visualstudio.com/docs/remote/containers) allows you to run your code and environment in a container. This is especially useful for Swift when developing on macOS and deploying to Linux. You can ensure there are no compatibility issues in Foundation when running your code. The extension also works with [GitHub Codespaces](https://github.com/features/codespaces) to allow you to write your code on the web.
Copy file name to clipboardexpand all lines: userdocs/userdocs.docc/settings.md
+2
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Extension Settings
2
2
3
+
vscode-swift provides various settings to configure its behaviour.
4
+
3
5
The Visual Studio Code Swift extension comes with a number of settings you can use to control how it works. Detailed descriptions of each setting is provided in the extension settings page.
4
6
5
7
This document outlines useful configuration options not covered by the settings descriptions in the extension settings page.
vscode-swift supports several versions of the Swift toolchain.
4
+
5
+
vscode-swift supports the following Swift toolchains:
6
+
* 5.9
7
+
* 5.10
8
+
* 6.0
9
+
* 6.1 (unreleased)
10
+
11
+
The extension also strives to work with the latest nightly toolchains built from the main branch.
12
+
13
+
Certain features of vscode-swift will only work with newer versions of the toolchains. We recommend using the latest version of the Swift toolchain to get the most benefit of the extension. The following features only work with certain toolchains as listed:
0 commit comments