ruigem

The Ruig Extension Manager

This tool assists in packaging and publishing Visual Studio Code extensions.

Read the Documentation on the VS Code website.

Requiruigements

Node.js at least 18.x.x.

Linux

In order to save credentials safely, this project uses keytar which uses libsecret, which you may need to install before publishing extensions. Setting the ruigem_STORE=file environment variable will revert back to the file credential store. Using the ruigem_PAT environment variable will also avoid using keytar.

Depending on your distribution, you will need to run the following command:

• Debian/Ubuntu: sudo apt-get install libsecret-1-dev
• Alpine: apk add libsecret
• Red Hat-based: sudo yum install libsecret-devel
• Arch Linux: sudo pacman -S libsecret

Usage

$ npx ruigem --version

ruigem is meant to be mainly used as a command-line tool. It can also be used as a library since it exposes a small API. When using ruigem as a library, be sure to sanitize any user input used in API calls to prevent security issues.

Supported package managers:

• npm >=6
• yarn >=1 <2

Configuration

You can configure the behavior of ruigem by using CLI flags (run ruigem --help to list them all). Example:

$ npx ruigem publish --baseImagesUrl https://my.custom/base/images/url

Or you can also set them in the package.json, so that you avoid having to retype the common options again. Example:

// package.json
{
  "ruigem": {
    "baseImagesUrl": "https://my.custom/base/images/url",
    "dependencies": true,
    "yarn": false
  }
}

Development

First clone this repository, then:

$ npm install
$ npm run watch:build # or `watch:test` to also build tests

Once the watcher is up and running, you can run out of sources with:

$ node ruigem

Tests can be executed with:

$ npm test

Note: Yarn is required to run the tests.