CONTRIBUTING.md

Contributing

• Contributing
  • Prerequisites
    • Setup for consuming GitHub Registry public packages
  • Build and lint
  • Packaging
  • Build and Package
  • Testing

The software is provided as is, there is no warranty of any kind. All users are encouraged to improve the source code with fixes and new features contributed by means of Pull Requests.

Prerequisites

Run

> npm install

to populate the dependencies in ./node_modules directory.

Setup for consuming GitHub Registry public packages

run-vcpkg depends on public NPM packages published by lukka/run-cmake-vcpkg-action-libs in the GitHub Packages registry. Unexpectedly, a public package still requires authentication when downloading it, hence if you want to npm install those packages correctly, you need to obtain a token with read:packages scope. Then create in the root of the repository a .npmrc file with the following content:

//npm.pkg.github.com/:_authToken=YOURTOKEN
@lukka:registry=https://npm.pkg.github.com/

Note: Never commit this .npmrc file!

Build and lint

Build with tsc running:

> npm run build

Launch lint by:

> npm run lint

Packaging

To package the extension for release purpose, run:

> npm run pack

Build and Package

To run linter, build and package all:

> npm run repack

Testing

To run the test suite:

> npm run test

To run a specific test by name:

> npx jest -t `<regular-expression>`

Validation tests on various scenarios are run using the workflows of the Samples.