Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

89 lines (53 loc) · 2.05 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change.

Please note that this project is maintain on free personal time, be kind and do not except immediate answers.

Prerequisites

This extension is best developed in Visual Studio Code (VSC) itself. Even if you use other IDE to edit the code, VSC is required for debugging.

Visual Studio Code

To set up your VSC, install the following extensions:

  • Prettier - Code formatter

    Run ctrl+P and then ext install esbenp.prettier-vscode.

    The extension will automatically format the code on file save, or you can run ctrl+shift+I or ctrl+shift+P -> Format Document.

  • ESLint

    Run ctrl+P and then ext install dbaeumer.vscode-eslint.

Apicurio Registry

You need Apicurio Registry during development, or to run the testsuite. You can run a local instance with docker:

docker run -it -p 8080:8080 quay.io/apicurio/apicurio-registry-mem:2.5.x-snapshot

It will be available at http://localhost:8080.

Visual Studio Code Extensions (VSCE) tool

To package the extension for publishing, you need the vsce executable, which can be installed by running:

npm install -g @vscode/vsce

Dependencies

npm install

Develop

Use the Run and Debug panel to run and debug the extension. Make sure the Run Extension task is selected and press F5.

The task will compile the extension and launch a VSC instance with the extension loaded.

Compile

npm run compile

or

npm run vscode:prepublish

Test

To run the testsuite, an Apicurio Registry instance at localhost:8080 is required.

npm run test

or

npm run test-no-timeout

without the default Mocha promise timeout.

Package

Using VSCE, run:

vsce package