Skip to content

Commit bc00173

Browse files
matthewbastienfedericobucchi
authored andcommitted
address Robin's suggested changes
1 parent 0186280 commit bc00173

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

documentation/articles/getting-started-with-vscode-swift.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Swift extension includes:
1616
- Code navigation features such as Go to Definition and Find All References
1717
- Refactoring and quick fixes to code
1818
- Package management and tasks with support for Swift Package Manager
19-
- Rich support for debugging
19+
- Rich support for debugging
2020
- Testing with XCTest or Swift Testing frameworks
2121

2222
The Swift extension is designed to support the following projects:
@@ -27,18 +27,18 @@ The Swift extension is designed to support the following projects:
2727
## Install the Extension
2828

2929
1. First, install Swift. If you do not already have Swift installed on your system, see the
30-
[Getting Started Guide on Swift.org](https://www.swift.org/getting-started/).
30+
[Getting Started Guide on Swift.org](https://www.swift.org/getting-started/).
3131
2. Download and install [Visual Studio Code](https://code.visualstudio.com/Download).
3232
3. Install the Swift extension from the
33-
[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sswg.swift-lang)
34-
or directly from within the VS Code extensions pane.
33+
[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sswg.swift-lang)
34+
or directly from within the VS Code extensions pane.
3535

3636
![Installing the vscode-swift extension from the extensions pane](/assets/images/getting-started-with-vscode-swift/installation.png)
3737

3838
## Creating a new Swift project
3939

40-
To create a new Swift project, you can use the `Swift: Create New Project...` command in
41-
the Swift extension to guide you through the process. You can find this command by opening
40+
To create a new Swift project, you can use the `Swift: Create New Project...` command in
41+
the Swift extension to guide you through the process. You can find this command by opening
4242
the Command Palette and following the instructions below.
4343

4444
- For macOS: `CMD + Shift + P`
@@ -67,17 +67,17 @@ editor. Use these links to see the VS Code documentation for each topic:
6767
- [Diagnostics](https://code.visualstudio.com/docs/editor/editingevolved#_errors-warnings)
6868
- [Quick Fixes](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
6969

70-
![Package swift actions](/assets/images/getting-started-with-vscode-swift/language-features/package_actions.png)
71-
7270
SourceKit LSP also provides code actions to automate common tasks. Code actions in VS Code
73-
appear as a light bulb near the editor margin (see the above screenshot for an
71+
appear as a light bulb near the editor margin (see the below screenshot for an
7472
example of this). Clicking on the light bulb will show you the available actions
7573
which can include:
7674

7775
- Adding targets to your `Package.swift`
7876
- Converting JSON to protocols
7977
- Adding documentation to your functions
8078

79+
![Package swift actions](/assets/images/getting-started-with-vscode-swift/language-features/package_actions.png)
80+
8181
<div class="warning" markdown="1">
8282
Before language features can be used you must perform a `swift build` command on your
8383
project either on the command line or using a task in VS Code. This populates the index in sourcekit-lsp.
@@ -163,10 +163,10 @@ target in your Swift package. You may configure these yourself by adding a
163163
}
164164
```
165165

166-
You can launch a debugging session via the Debug view in VS Code.
166+
You can launch a debugging session via the Debug view in VS Code.
167167

168-
1. Select the launch configuration you wish to debug
169-
2. Click on the green play button to lauch a debugging session.
168+
1. Select the launch configuration you wish to debug.
169+
2. Click on the green play button to launch a debugging session.
170170

171171
The executable will be launched and you can set breakpoints in
172172
your Swift code that will be hit as code executes.
@@ -182,6 +182,7 @@ their variable values:
182182

183183
Visual Studio Code provides a Test Explorer view in the left sidebar which can
184184
be used:
185+
185186
- To navigate to tests
186187
- To run tests
187188
- To Debug tests
@@ -193,6 +194,7 @@ As you write tests they are automatically added to the Test Explorer.
193194
![Inline test errors](/assets/images/getting-started-with-vscode-swift/testing/inline_assertion_failures.png)
194195

195196
To debug a test:
197+
196198
1. Set a breakpoint
197199
2. Run the test, suite, or entire test target with the `Debug Test` profile.
198200

0 commit comments

Comments
 (0)