diff --git a/pw_ide/ts/pigweed-vscode/CHANGELOG.md b/pw_ide/ts/pigweed-vscode/CHANGELOG.md index f1b145a48b..b74ddff6c7 100644 --- a/pw_ide/ts/pigweed-vscode/CHANGELOG.md +++ b/pw_ide/ts/pigweed-vscode/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log +## [0.1.2] + +- You can now submit bugs to the [Pigweed issue tracker](https://issues.pigweed.dev/issues?q=status:open) + directly from your editor. Just run `Pigweed: File Bug`. +- Several UX improvements, including: + - Auto-detection and activation in Pigweed projects is more reliable + - Clearer feedback on the need to install or disable extensions + - Target toolchains are now presented in alphabetical order + - Errors will not appear when working in Pigweed projects that don't define + project-level extensions + ## [0.1.1] - Fixes cases where "Pigweed: Check Extensions" was not running on startup. diff --git a/pw_ide/ts/pigweed-vscode/README.md b/pw_ide/ts/pigweed-vscode/README.md index 434603d7a9..b180d64fde 100644 --- a/pw_ide/ts/pigweed-vscode/README.md +++ b/pw_ide/ts/pigweed-vscode/README.md @@ -1,9 +1,46 @@ # Pigweed Extension for Visual Studio Code -This is highly experimental! +Work more effectively with [Pigweed](https://pigweed.dev) projects in Visual +Studio Code! + +## Usage + +Right now, all functionality is exposed through [tasks](https://code.visualstudio.com/docs/editor/tasks), +so your first step will be to open the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) +and select `Tasks: Run Task`. + +### Sync your IDE to your project + +Running the `Pigweed: Sync IDE` task is the equivalent of running the +[`pw ide sync`](https://pigweed.dev/pw_ide/#sync) CLI command. + +### Manage C++ target toolchains + +For more information, see [this page](https://pigweed.dev/docs/editors.html#c-c) +in the Pigweed docs. + +Running the `Pigweed: Set C++ Target Toolchain` will display a list of available +target toolchains. Simply select one, and `clangd` will be configured to use it. + +### Manage the Python virtual environment + +Usually, `Pigweed: Sync IDE` will automatically configure Visual Studio Code to +use the correct Pigweed Python virtual environment. But if you need to change +this manually, you can do so with `Pigweed: Set Python Virtual Environment`. + +### Other tasks + +- `Pigweed: Format` == `pw format --fix` +- `Pigweed: Presubmit` == `pw presubmit` + +### Found a bug? + +Run `Pigweed: File Bug` to let us know! ## Developing +If you want to contribute to this extension, here's how you can get started: + - Ensure that you have `npm` installed globally; this doesn't use the distribution provided by Pigweed yet. @@ -18,7 +55,7 @@ This is highly experimental! circle-with-an-arrow icon at the top of your development window to update the extension development host with the new build. -## Building +### Building - Install the build tool: `npm install -g @vscode/vsce` diff --git a/pw_ide/ts/pigweed-vscode/package.json b/pw_ide/ts/pigweed-vscode/package.json index 18d44b09f0..42b514d432 100644 --- a/pw_ide/ts/pigweed-vscode/package.json +++ b/pw_ide/ts/pigweed-vscode/package.json @@ -1,13 +1,14 @@ { "publisher": "pigweed", "name": "pigweed-vscode", - "displayName": "Pigweed Visual Studio Code Extension", + "displayName": "Pigweed", "description": "Visual Studio Code support for Pigweed projects", + "icon": "./icon.png", "repository": { "type": "git", "url": "https://pigweed.googlesource.com/pigweed/pigweed" }, - "version": "0.1.1", + "version": "0.1.2", "license": "Apache-2.0", "engines": { "vscode": "^1.64.0"