Skip to content

Latest commit

 

History

History
151 lines (104 loc) · 6.26 KB

README-dev.md

File metadata and controls

151 lines (104 loc) · 6.26 KB
Raw

VSCode Trace Server extension

This file contains information that could be interesting to developers, that want to modify, build, test, and debug this extension.

For general information, see the main README.md

  • This is a TypeScript extension, officially named vscode-trace-server.
  • It is meant as companion to the vscode-trace-extension.
  • It registers Trace Server: start/stop commands, for a default instance locally.
  • It depends on the tsp-typescript-client for server health check purposes.

This extension was started from Code's guide and related sample.

Documentation

This README is the usual entry point for documenting this extension.

Build

First, you need Node.js and yarn:

It's suggested to install nvm to manage node on your machine. Once that's done, install the required version:

   nvm install 18
   # optional: make it the default version
   nvm alias default
   # or set it every time like so
   nvm use 18

Then install yarn:

npm i -g yarn  # the default version should be ok

To build, run yarn, which should automatically trigger yarn install.

  • This extension is bundled using webpack, originally based on the guide.
  • There is only a modest automated CI test suite being run on GitHub

Test

Run yarn test on a need basis.

Alternatively, launch Extension Tests under Run and Debug.

Installation

  1. After having built at least once, run yarn vsce:package (more) at will.
  2. Install the hereby generated vscode-trace-server-*.vsix file.
  3. Alternatively, simply launch the packaged extension using Run Extension.
  4. Through Command Palette, the Trace Server: start/stop commands should be available.

This extension can be installed in either one (or many) of:

The dependent Trace Viewer for VSCode extension renders a Trace Server status bar item. A note:

Reinstalling an amended extension that has the same version requires removing the unpacked extension, found under one of the following folders:

  • Theia Blueprint: extracts installed extensions under /tmp/vscode-unpacked/.
  • VSCode: extracts the installed extensions under the user's home, in folder .vscode/extensions/.

Alternatively, you may step the extension's version to avoid this issue.

Debugging

  • One may launch the extension using Run Extension, to debug it with breakpoints, as usual.
  • The same can be done for tests, launching Extension Tests to debug them.
  • The enabled breakpoints get bound only upon exercising the extension.

Development

The usual Prettier and ESLint combo in VS Code or Codium OSS is used.

These are actual recommended extensions herein.

# confirm formatting is ok:
yarn format:check
# correct the formatting:
yarn format:write

Release/publish

We use GitHub CI to create a GitHub release and the corresponding git tag, and also to publish this repo's VSCode extension to the open-vsx.org and the Visual Studio Marketplace registries.

Triggering a new release

Whenever a new release is desired, it can be triggered through a PR, as per the following:

Create a new branch for your PR, based on the repo's latest state. e.g.

git branch new-release && git checkout new-release

Then decide if the release shall be a Major, Minor or Patch release and use the corresponding command below to step the package's versions, according to the release type. A new release commit will be created:

yarn version:major
# or
yarn version:minor
# or
yarn version:patch

Modify the version tag in file ./RELEASE, to match the new release. Amend the release commit to include this change:

git add RELEASE && git commit --amend

Finally, push the branch to the main repository (not a fork!) and use it to create a PR. When the PR is merged, a GitHub release should be created with auto-generated release notes, as well as a git tag. Then the publish-* CI jobs should trigger, and if everything goes well, publish the new version of the extension to both registries.