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
Update CONTRIBUTING.md with instructions on building a .vsix (#893)
* Update CONTRIBUTING.md with instructions on building a .vsix
Add instructions that outline how to build and install a .vsix from a
local repository. This will help users who want to live on unreleased
features without having to build and run the extension in an extension
host.
Co-authored-by: Adam Fowler <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34-2Lines changed: 34 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Welcome to the Swift Community!
1
+
# Welcome to the Swift Community!
2
2
3
3
Contributions to vscode-swift are welcomed and encouraged! Please see the [Contributing to Swift guide](swift.org/contributing) and check out the [structure of the community](https://www.swift.org/community/#community-structure).
More details on nvm installation can be found in the [README](https://github.com/nvm-sh/nvm/blob/master/README.md) from its GitHub repository.
18
18
19
-
Once you have installed nvm, clone this repository, and in the project directory run `nvm install`. This will install the correct version of Node.js for developing the extension. Then you should run `npm install` to install all the dependencies the extension requires.
19
+
Once you have installed nvm, you can clone and configure the repository.
# Install the correct version of Node.JS for developing the extension
25
+
nvm install
26
+
27
+
# Installs all the dependencies the extension requires
28
+
npm install
29
+
```
20
30
21
31
When you first open the project in VS Code you will be recommended to also install [`ESLint`](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), [`Prettier - Code formatter`](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [`esbuild Problem Matchers`](https://marketplace.visualstudio.com/items?itemName=connor4312.esbuild-problem-matchers). Please do so. `ESLint`, `Prettier - Code formatter` is used to ensure a consistent style and we expect everyone who contributes to follow this style as well. `esbuild Problem Matchers` provides proper error output from building the project.
22
32
23
33
To run your version of the Swift extension while in VS Code, press `F5`. This will open up another instance of VS Code with it running. You can use the original version of VS Code to debug it.
24
34
35
+
### Installing a pre-released version
36
+
37
+
If you'd like to try out a change during your day to day work that has not yet been released to the VS Code Marketplace you can build and install your own `.vsix` package from this repository.
38
+
39
+
#### Building
40
+
41
+
If you haven't already, follow the instructions in [Development](#development) to clone the repository and install its dependencies. Now we can generate the `.vsix` package:
42
+
43
+
```sh
44
+
npm run dev-package
45
+
```
46
+
47
+
This builds a file that looks like `swift-lang-[version]-dev.vsix`. Now install the extension with:
Alternatively you can install the extension from the Extensions panel by clicking the `...` button at the top of the panel and choosing `Install from VSIX...`.
54
+
55
+
If you'd like to return to using the released version of the extension you can uninstall then reinstall Swift for VS Code from the Extensions panel.
56
+
25
57
## Submitting a bug or issue
26
58
27
59
Please ensure to include the following in your bug report:
0 commit comments