Skip to content

Commit 048fc9a

Browse files
Walkthrough (#1709)
* Add an extension walkthrough Adds a walkthrough to the package.json that guides users through: - Installing Swift - Creating a New Project - Extension Commands - Running Tests - Selecting a Toolchain * Ensure assets are added to .vsix * Properly theme swiftCommands.svg * Fixup wording * Update the walkthrough Add some GIFs and additional steps for running, debugging and DocC previewing. Issue: #1560 * Update walkthrough based on feedback - Add additional pictures to clarify certain instructions - Update the GIFs for testing view and DocC preview - Ensure that each step has a unique completion action to ensure that the checkbox is only checked after that step is viewed * Simplify create project step Remove additional details and make the "Try it out" button launch the swift extension create new project command directly. * Update changelog * Remove unused pictures * Incorporate suggestions from @award999 --------- Co-authored-by: Paul LeMarquand <[email protected]>
1 parent 831cf10 commit 048fc9a

26 files changed

+298
-2
lines changed

.vscodeignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
!images/**
1010
!snippets/**
1111
!assets/icons/**
12+
!assets/walkthrough/**
1213
!assets/documentation-webview/**
1314
!assets/swift-docc-render/**
1415
!node_modules/@vscode/codicons/**

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
### Changed
1313
- Added log levels and improved Swift extension logging so a logfile is produced in addition to logging messages to the existing `Swift` output channel. Deprecated the `swift.diagnostics` setting in favour of the new `swift.outputChannelLogLevel` setting ([#1746](https://github.com/swiftlang/vscode-swift/pull/1746))
14+
- A walkthrough for first time extension users ([#1560](https://github.com/swiftlang/vscode-swift/issues/1560))
1415

1516
## 2.10.0 - 2025-07-28
1617

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Create a New Swift Project
2+
![Create new project](./images/createNewProject.gif)
3+
4+
When you select a project template, you'll be prompted to enter a name for your new project. This will be the name of the folder created in your workspace. You can then choose any location in your workspace, or create a new folder for the project.
5+
6+
# Opening Existing Projects
7+
8+
![Open existing project](./images/openProject.gif)
9+
10+
When you open an existing project with a ``Package.swift`` file the extension will activate automatically.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Swift Extension Settings
2+
3+
![Swift Extension Settings](./images/settings.gif)
4+
5+
The Swift Extension contains several settings you can customize. You can filter settings Swift extension settings by searching for `@ext:swiftlang.swift-vscode`.
6+
7+
## Language Settings
8+
9+
Some language settings such as those for inlay hints for inferred variable types are turned on by default in VS Code.
10+
11+
![Disable Inlay Hints](./images/disableInlayHints.gif)
12+
13+
You can turn off inlay hints for Swift by adding `[swift]` specific settings to your `settings.json` file:
14+
15+
```
16+
"[swift]": {
17+
"editor.inlayHints.enabled": "off"
18+
},
19+
```
1.43 MB
Loading
Lines changed: 55 additions & 0 deletions
Loading
763 KB
Loading
818 KB
Loading
532 KB
Loading
1.23 MB
Loading

0 commit comments

Comments
 (0)