BUILD.md

BUILD

Table of contents

1. About

2. Environment

3. Development

3.1. Install and Run

3.2. Style Guide

3.3. Security

4. Production

4.1. Publish an extension

About

The BUILD.md is a file to check the environment and build specifications of horusec-vscode-plugin project.

Environment

• vscode: ^1.51.X
• npm: 6.x
• node: 8.x

Development

We use Extension API for the extension's development.

Install and Run

To install the dependencies, run the command at the root of the project:

  npm install

• If you want to see the extension in development mode, use Visual Studio code and run the project using debug via the F5 key or through the Run and Debug tab.

Style Guide

The tool Eslint is used for code standardization in this project. You can check if your changes are in accordance with our Style Guide, run the following command:

  npm run lint

Security

We use Horusec CLI to maintain a secure codebase.

To make your installation and execution easier, we created a Make command, run:

  make security

Production

You need the npm package vsce installed globally to deploy in production, run the command below:

  npm install -g vsce

Publish an extension

To publish the extension on the VSCode Marketplace, follow the steps:

Step 1. Generate an access token;

Step 2. Run the command below, informing the generated token:

  vsce publish -p $YOUR_MARKETPLACE_TOKEN