Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (20.x or later)
  • npm (comes with Node.js)
  • Visual Studio Code
  • git-lfs - Required for cloning the repository

​
Initial Setup

1

Clone the Repository

Clone the repository with git-lfs support:
git clone https://github.com/presidio-oss/hai-build-codegen.git
2

Open in VS Code

Open the project in Visual Studio Code:
code hai-build-codegen
3

Install Dependencies

Install the necessary dependencies for the extension and webview-gui:
npm run install:all
4

Generate Protocol Buffers

Generate Protocol Buffer files (required before first build):
npm run protos
5

Launch the Extension

Launch by pressing F5 (or Run → Start Debugging) to open a new VS Code window with the extension loaded.
You may need to install the esbuild problem matchers extension if you run into issues building the project.

​
VS Code Extensions

When opening the project, VS Code will prompt you to install recommended extensions. These extensions are required for development - please accept all installation prompts. If you dismissed the prompts, you can install them manually from the Extensions panel.

​
Development Workflow

​
Watch Mode

For an efficient development workflow, use one of these commands: 
# Generate protos and run watch mode
npm run dev

# Run watch mode (if protos already generated)
npm run watch
This will automatically rebuild the extension when you make changes to the source code.

​
Running Tests

Run tests locally: 
npm run test

​
Code Formatting

Before submitting a PR, format your code: 
npm run format:fix

​
Linux-Specific Setup

VS Code extension tests on Linux require the following system libraries:
  • dbus
  • libasound2
  • libatk-bridge2.0-0
  • libatk1.0-0
  • libdrm2
  • libgbm1
  • libgtk-3-0
  • libnss3
  • libx11-xcb1
  • libxcomposite1
  • libxdamage1
  • libxfixes3
  • libxkbfile1
  • libxrandr2
  • xvfb
These libraries provide necessary GUI components and system services for the test environment.

​
Installing on Debian-based distributions

For Debian-based distributions (e.g., Ubuntu), install these libraries using apt: 
sudo apt update
sudo apt install -y \
  dbus \
  libasound2 \
  libatk-bridge2.0-0 \
  libatk1.0-0 \
  libdrm2 \
  libgbm1 \
  libgtk-3-0 \
  libnss3 \
  libx11-xcb1 \
  libxcomposite1 \
  libxdamage1 \
  libxfixes3 \
  libxkbfile1 \
  libxrandr2 \
  xvfb

​
Webview Development

The project includes a separate webview UI component. To work on the webview: 
# Run webview in development mode
npm run dev:webview

# Build webview for production
npm run build:webview

# Run webview tests
npm run test:webview

​
Common Issues

Make sure you’ve run npm run protos before building the project.
Try closing the debug VS Code window and pressing F5 again. If the issue persists, run npm run clean:build and rebuild.

​
Next Steps

Architecture

Learn about the project structure

Contributing Guidelines

Read the contributing guidelines

Build docs developers (and LLMs) love

Get started for freeTalk to us