Clone the repository, then run npm install && npm run build
in the directory.
- Open repository directory in VS Code and press
F5
to run extension in a new VS Code window. - This allows extension debugging within VS Code.
- You can find output from your extension in the debug console and output channel.
Please install all recommended extension that are suggested by VS Code when first opening the cloned directory. You can also do install them manually with the list of extensions defined in .vscode/extensions.json
. This will ensure consistent formatting with the current codebase.
Code changes require extension reload when run in debug.
- You can relaunch the extension from the debug toolbar after changing code.
- You can also reload (
Ctrl+R
orCmd+R
on Mac) the VS Code window with your extension to load your changes.
- When run in debug, VS Code runs watch for TS files automatically for you.
- If not in debug, run
npm run watch-all
to track changes in both TS and SCSS files.- If you want to track changes to TS files only, use
npm run watch
. - If you want to track changes to SCSS files only, use
npm run watch-resources
.
- If you want to track changes to TS files only, use
-
Unit tests
- Run
npm run test:unit
for a single execution,npm run test:unit:watch
to watch for changes. - Make sure to re-run the command to pick up new files, if new
**.test.ts
is added.
- Run
-
Integration tests
- Run
npm run test:integration
.
- Run
You can debug tests via VS Code debugger, selecting "Extension Unit Tests" or "Extension Integration Tests" respectively.
To test for analytics, experimentation and error reporting integrations, create snyk.config.local.json
file in the root folder and copy the contents from snyk.config.json
, replacing config values with API keys for relevant integrations.
The code is organized in folders grouped by feature, unless it's product unrelated code. The overall layering tree loks like that:
├── snyk
│ ├── common
│ │ ├── Common code that is shared between different products.
│ ├── base
│ │ ├── Provides general utilities and basic extension building blocks.
│ ├── cli
│ │ ├── Code responsible for interaction with Snyk CLI.
│ ├── snykCode
│ │ ├── Snyk Code product specific code.
│ ├── snykOss
│ │ ├── Snyk Open Source product specific code.
├── test
│ ├── integration
│ │ ├── Integration tests.
│ ├── unit
│ │ ├── Unit tests.
You can open the full set of our API when you open the file node_modules/@types/vscode/index.d.ts
.