Additional VS Code extensions for Fuchsia

The following VS Code extensions may provide a productive development environment for Fuchsia:

Official Fuchsia-specific extensions

Fuchsia-specific extensions provide support for working with Fuchsia software and systems. These extensions are currently supported by the Fuchsia project.

Fuchsia extension for VS Code

The Fuchsia extension for VS Code provides support for debugging Fuchsia devices, logging, and syntax highlighting. This extension is Fuchsia’s official extension and can be used with the source tree and the SDK. For more information see the Fuchsia developer extension page.

This figure shows the image of the fuchsia developer extension in the Visual Studio Code marketplace

Community contributed extensions

These extensions are developed by Fuchsia contributors. Extensions listed are unsupported and could conflict with the official Fuchsia developer extension. It is recommended to use the Fuchsia developer extension.

Fuchsia.git Helper

Fuchsia.git Helper adds an "Open in...", which allows you to open a file in OSS Code Search.

To use this extension:

  1. Right click a file in the file editor.
  2. Select Open in OSS Code Search.

This figure shows the VS Code menu to open a file in OSS code search.

FuchsiAware

FuchsiAware assists with browsing Fuchsia artifacts, such as by linking from component URLs to component manifests.

This figure shows hyperlinks to fuchsia-pkg urls in VS Code.

Build system extensions

GN

GN adds syntax highlighting for GN files.

This figure shows syntax highlighting for GN files in VS Code.

GNFormat

GNFormat provides GN file formatting.

You may need to configure GNFormat with the file path to your GN binary and buildtools. Do the following:

  1. In VS Code, launch Quick Open by running CMD/CTRL + P.
  2. Type settings in the search field.
  3. Click Preferences: Open Settings (JSON).
  4. Add the following configuration and restart VS Code:
"gnformat.path.gn": "FILE_PATH",
"gnformat.path.buildtools": "BUILD_TOOLS_PATH"

General workflow extensions

General workflow extensions provide an overall productive workflow when working with Fuchsia.

GitLens

GitLens provides highly customizable insights of git history, which allows you to see code evolution.

This figure shows an overlay of git commit history in VS Code.

Language specific extensions

FIDL language support

FIDL Language Support provides syntax support and LSP-based language features in FIDL.

This figure shows syntax highlighting for FIDL files in VS Code.

JSON5

In some cases, you may work on Fuchsia components using a structured configuration written in JSON5. JSON5 adds syntax highlighting for JSON5 files.

This figure shows syntax highlighting for JSON5 files in VS Code.

Rust-analyzer

Rust-analyzer is a Language Server Protocol (LSP) implementation for the Rust language.

To use rust-analyzer with VS Code, Fuchsia recommends:

Configure workflow

Using the fuchsia.code-workspace configuration file will set recommended defaults for using rust-analyzer on Fuchsia. If you aren't using the workspace file, here are some settings you may want to add to your settings.json:


  // disable cargo check on save
  "rust-analyzer.checkOnSave.enable": false,
  "rust-analyzer.checkOnSave.allTargets": false,

  // workaround for https://fxbug.dev/42053708
  // needed if you see errors about extension host crashing
  "rust-analyzer.files.watcher": "server",

Additionally, you may want to configure smaller tooltips and hide parameter hints to optimize your workspace:


  // optional: only show summary docs for functions (keeps tooltips small)
  "rust-analyzer.callInfo.full": false,
  // optional: don't activate parameterHints automatically
  "editor.parameterHints.enabled": false,

Enable rustfmt

The rust-analyzer extension relies on the rustup installer to invoke rustfmt, a tool for formatting Rust code according to style guidelines.

To configure rustup with your Fuchsia source code, run:

rustup toolchain link fuchsia FUCHSIA_DIR/prebuilt/third_party/rust/HOST_OS

After configuring rustup, the rust-analyzer extension supports additional configuration with Fuchsia's Rust style guide, rustfmt.toml.

Add the following snippet to your settings.json using the same steps from Configuring workflow:


    // use fuchsia toolchain and fuchsia's rules for rustfmt:
    "rust-analyzer.rustfmt.extraArgs": [
        "+fuchsia",
        "--config-path=FUCHSIA_DIR/rustfmt.toml"
    ],

Fuchsia SDK extensions

Bazel

The Fuchsia SDK uses the Bazel build system. The Bazel extension can build and run components directly from VS Code.

This figure shows a successful Bazel build in VS Code.