Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.59 KB

development.md

File metadata and controls

74 lines (49 loc) · 2.59 KB
Raw

Installation for developers

Development workflow

After cloning the repository, enter this directory and install the dependencies with the command

npm install

Then you can compile, package, and install the extension with

npm run compile
npm run package
code --install-extension nisaba-0.0.1.vsix

If you open this directory in Visual Studio Code, you should be able to run the compile and package commands from the list of "npm scripts" in the sidebar on the left. (Re)start Visual Studio Code to make the changes take effect:

code

Running tests

After having installed all dependencies with npm install and compiled the package with npm run compile, you can run the tests for the package with

npm run test

Debugging tips

To debug the syntax highlighting (currently implemented as a Textmate grammar) trigger the scope inspector from the Command Palette (Ctrl+Shift+P) with the Developer: Inspect Editor Tokens and Scopes command.

Publishing the extension in VS Code Marketplace

The publisher ID we are using is "UCLResearchSoftwareDevelopmentGroup", and it's linked to RSDG's notifications email account (rsd-notifications). You can see login details for it in RSDG's shared passwords list in LastPass.

Then, update Nisaba's version number in package.json for the new release.

Once that's done, you can locally run:

npm run publish

which will package and publish the extension in the Marketplace.

Please note you'll be prompted to enter a Personal Account Token (PAT) when publishing the extension. The one we are using is currently saved in RSDG's LastPass. It will expire in one year (27th October 2022). Instructions to create a new one are also in the LastPass entry.

Updating a newly released version

If you make a mistake and want to update your release maintaining the same version number, you can't do it using vsce on the command line, you'll have to log in as rsd-notifications and update the release online (see LastPass for login details).

Unpublishing the extension

If you want to completely delete everything about the Nisaba extension from the Marketplace, including all published versions and usage statistics, you can do so as:

vsce unpublish UCLResearchSoftwareDevelopmentGroup.nisaba

After that you can publish again as indicated above if you wish.