tree: bc76893d7af6855c605450616a1a8ad5d614d51a [path history] [tgz]
  1. .vscode/
  2. AUTHORS
  3. CHANGELOG.md
  4. CONTRIBUTING.md
  5. LICENSE
  6. PATENTS
  7. README.md
  8. images/
  9. language-configuration.json
  10. package-lock.json
  11. package.json
  12. src/
  13. syntaxes/
  14. tools/
  15. tsconfig.json
  16. tslint.json
vscode-language-fidl/README.md

FIDL Language Support for Visual Studio Code

This extension provides support for fidl-lsp, an LSP language server for FIDL. For more information about the language server, how to run a test instance, and how to contribute, see the fidl-lsp README.

Getting Started

  1. Run fx gen and fx build build/fidl:validate_fidl_project_json
  2. Download VSCode and install the FIDL Language extension.
  3. Either set your FUCHSIA_DIR environment variable, or configure these settings in VSCode and reload the editor:
    • Fidl > Project Root should be the root directory of your fuchsia.git checkout, e.g. ‘/usr/local/google/home/$LDAP/fuchsia’
    • Fidl > Fidl Project should be the absolute path to your fidl_project.json, which is generated in your build output directory, such as ‘${env:FUCHSIA_DIR}/out/default/fidl_project.json’ (see here for how to use env vars in VSCode settings)
  4. Open a FIDL file in VSCode, and you should be ready to go!

If you want to use local versions of fidlc and fidl-format instead of the latest SDK versions, you can edit the extension settings in VSCode. (You may need to reload the editor for the settings to take effect.)

Syntax Highlighting

In addition to LSP capabilities, this extension provides syntax highlighting. The syntax highlighting is generated by a script called generate-syntax.ts. That can be run by:

npm install
npm run-script build-syntax