mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-29 12:44:57 +01:00
Chandler CarruthandRichard Smith
cfd1ed8484
Rumdl already appears to have _significantly_ fewer bugs than prettier, and a solid LSP for editor integration. The tool is: https://github.com/rvben/rumdl/ I've separated out the change across three commits for easier review. The configuration tries to match the existing formatting, the changes to the all the files are to correct issues found by the new tool. Assisted-by: Antigravity with Gemini --------- Co-authored-by: Richard Smith <richard@metafoo.co.uk>
79 lines
2.6 KiB
Markdown
79 lines
2.6 KiB
Markdown
# Extension development
|
|
|
|
<!--
|
|
Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
Exceptions. See /LICENSE for license information.
|
|
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
-->
|
|
|
|
## Tool setup
|
|
|
|
NodeJS is required to build the extension. You will also need to install `vsce`
|
|
and `ovsx`:
|
|
|
|
```
|
|
npm install -g @vscode/vsce ovsx
|
|
```
|
|
|
|
This installs `vsce` and `ovsx` to `/usr/local/bin`. Ensure that
|
|
`/usr/local/bin` is in your `$PATH` environment variable to use it.
|
|
|
|
## Common operations
|
|
|
|
- Build and install:
|
|
|
|
- Locally:
|
|
|
|
```
|
|
npm install && vsce package -o carbon.vsix && code --install-extension carbon.vsix
|
|
```
|
|
|
|
- From a remote SSH host using VS Code Server:
|
|
|
|
```
|
|
npm install && vsce package -o carbon.vsix && ~/.vscode-server/cli/servers/Stable-*/server/bin/code-server --install-extension carbon.vsix
|
|
```
|
|
|
|
- Using the UI:
|
|
|
|
1. `npm install && vsce package -o carbon.vsix && realpath carbon.vsix`
|
|
- This installs dependencies, builds the VSIX file, and prints the
|
|
path.
|
|
2. Open the
|
|
[command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
|
|
and select "Extensions: Install from VSIX...".
|
|
3. Enter the path printed by the above command.
|
|
|
|
- Publish a new release:
|
|
|
|
1. Increase the version number in `package.json`.
|
|
2. Build and publish to the VSCode Marketplace using the website:
|
|
1. `npm install && vsce package -o carbon.vsix && realpath carbon.vsix`
|
|
2. Go to
|
|
https://marketplace.visualstudio.com/manage/publishers/carbon-lang
|
|
- We use `infra-role@carbon-lang.dev` for publishing; the GitHub
|
|
account `CarbonInfraBot` can also be used for login. Contact leads
|
|
if you require access.
|
|
3. Next to the extension name, click the "..." and select "Update".
|
|
4. Select the `carbon.vsix` file.
|
|
3. Build and publish to the Open VSX Registry by following the
|
|
[Open VSX documentation for publishing extensions](https://github.com/EclipseFdn/open-vsx.org/wiki/Publishing-Extensions).
|
|
|
|
## Development
|
|
|
|
1. `bazel build //toolchain` in project root.
|
|
2. Open utils/vscode folder in VS Code.
|
|
3. Launch the extension using Run command (F5).
|
|
4. In the opened window, open the carbon-lang repository as folder.
|
|
5. Open a carbon file.
|
|
6. Open code outline (Ctrl+Shift+O).
|
|
|
|
## Debugging output
|
|
|
|
1. Go to the "Output" panel.
|
|
2. In the top right, there is a dropdown; select "Carbon Language Server".
|
|
|
|
## Updating dependencies
|
|
|
|
To update dependencies, run `npm update`.
|