xref: /aosp_15_r20/external/pigweed/pw_ide/guide/vscode/development.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_ide-guide-vscode-development:
2
3===========
4Development
5===========
6.. pigweed-module-subpage::
7   :name: pw_ide
8
9The Visual Studio Code extension is developed in the main Pigweed repository.
10If you want to contribute to the extension, the first step is to become a
11:ref:`Pigweed contributor<docs-contributing>`.
12
13---------------------
14Working with the code
15---------------------
16When working on the Visual Studio Code extension, it's more effective to open
17the extension's root directory instead of opening the repository root. That
18directory is: ``<repo root>/pw_ide/ts/pigweed-vscode``
19
20If you're using Visual Studio Code to write code for the Visual Studio Code
21extension, install any extensions that are recommended to you when you open
22the directory.
23
24----------------------
25Building the extension
26----------------------
27Start by installing the dependencies: ``npm install``
28
29Then the most effective way to work is to run the ``Run Extension`` launch
30configuration. This will start a build watcher that will continuously build and
31bundle the extension, and will launch a new Visual Studio Code instance with the
32current build of the extension.
33
34.. note::
35
36   You need to have the `TypeScript + Webpack Problem Matchers <https://marketplace.visualstudio.com/items?itemName=amodio.tsl-problem-matcher>`_
37   extension installed for the above to work.
38
39-----------------------
40Packaging the extension
41-----------------------
42It's one command: ``npm run package``
43