{"id":22555459,"url":"https://github.com/eclipse-cdt-cloud/vscode-trace-server","last_synced_at":"2025-09-08T13:49:46.146Z","repository":{"id":177410719,"uuid":"650553366","full_name":"eclipse-cdt-cloud/vscode-trace-server","owner":"eclipse-cdt-cloud","description":"Extension to start and stop a trace server used by the vscode-trace-extension. This extension can run in Eclipse Theia and VSCode compatible applications","archived":false,"fork":false,"pushed_at":"2025-08-21T20:27:21.000Z","size":842,"stargazers_count":0,"open_issues_count":3,"forks_count":6,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-08-21T21:55:42.610Z","etag":null,"topics":["eclipse","eclipse-foundation","eclipse-theia","javascript","open-vsx","trace-compass","trace-server","trace-server-protocol","trace-viewer","tsp","tsp-typescript-client","typescript","visual-studio-marketplace","vscode","vscode-extension","vscode-trace-extension","vscode-trace-server"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipse-cdt-cloud.png","metadata":{"files":{"readme":"README-dev.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-07T10:07:19.000Z","updated_at":"2025-06-03T15:03:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"54e9db2a-e422-408e-9c95-fea7d9887d92","html_url":"https://github.com/eclipse-cdt-cloud/vscode-trace-server","commit_stats":null,"previous_names":["eclipse-cdt-cloud/vscode-trace-server"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/eclipse-cdt-cloud/vscode-trace-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Fvscode-trace-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Fvscode-trace-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Fvscode-trace-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Fvscode-trace-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-cdt-cloud","download_url":"https://codeload.github.com/eclipse-cdt-cloud/vscode-trace-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Fvscode-trace-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274195896,"owners_count":25239148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eclipse","eclipse-foundation","eclipse-theia","javascript","open-vsx","trace-compass","trace-server","trace-server-protocol","trace-viewer","tsp","tsp-typescript-client","typescript","visual-studio-marketplace","vscode","vscode-extension","vscode-trace-extension","vscode-trace-server"],"created_at":"2024-12-07T19:07:57.061Z","updated_at":"2025-09-08T13:49:46.093Z","avatar_url":"https://github.com/eclipse-cdt-cloud.png","language":"TypeScript","readme":"# VSCode Trace Server extension\n\nThis file contains information that could be interesting to developers, that want to modify, build, test, and debug this extension.\n\nFor general information, see the main [README.md](README.md)\n\n* This is a TypeScript extension, officially named `vscode-trace-server`.\n* It is meant as companion to the [vscode-trace-extension][vscode-trace-extension].\n* It registers `Trace Server:` start/stop commands, for a default instance locally.\n* It depends on the [tsp-typescript-client][client] for server health check purposes.\n\nThis extension was started from Code's [guide][guide] and related [sample][sample].\n\n## Documentation\n\nThis README is the usual entry point for documenting this extension.\n\n* One may refer to the [contribution guide](CONTRIBUTING.md) for how to contribute.\n* Please also refer to the [security policy](SECURITY.md) on a need basis.\n* The usual [license description](LICENSE.md) file accompanies these too.\n\n## Build\n\nFirst, you need Node.js and yarn:\n\nIt's suggested to install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to manage node on your machine. Once that's done, install the required version:\n\n```bash\n   nvm install 18\n   # optional: make it the default version\n   nvm alias default\n   # or set it every time like so\n   nvm use 18\n```\n\nThen install `yarn`:\n\n```bash\nnpm i -g yarn  # the default version should be ok\n```\n\nTo build, run `yarn`, which should automatically trigger `yarn install`.\n\n* This extension is bundled using `webpack`, originally based on [the guide][guide].\n* There is only a modest automated CI test suite being run on GitHub\n\n## Test\n\nRun `yarn test` on a need basis.\n\nAlternatively, launch `Extension Tests` under `Run and Debug`.\n\n## Installation\n\n1. After [having built](#build) at least once, run `yarn vsce:package` ([more][vsce]) at will.\n1. [Install][install] the hereby generated `vscode-trace-server-*.vsix` file.\n1. Alternatively, simply launch the packaged extension using `Run Extension`.\n1. Through `Command Palette`, the `Trace Server:` start/stop commands should be available.\n\nThis extension can be installed in either one (or many) of:\n\n* [VS Code][code] or [Codium][codium]/Code-OSS, or\n* a [Theia][theia] application such as [Blueprint][blueprint].\n\nThe dependent [Trace Viewer for VSCode][vscode-trace-extension] extension renders a `Trace Server`\n[status bar item][item]. A note:\n\nReinstalling an amended extension that has the same version requires removing the unpacked extension, found under one of the following folders:\n\n* [Theia Blueprint][blueprint]:  extracts installed extensions under `/tmp/vscode-unpacked/`.\n* VSCode: extracts the installed extensions under the user's home, in folder `.vscode/extensions/`.\n\nAlternatively, you may step the extension's version to avoid this issue.\n\n## Debugging\n\n* One may launch the extension using `Run Extension`, to debug it with breakpoints, as usual.\n* The same can be done for tests, launching `Extension Tests` to debug them.\n* The enabled breakpoints get bound only upon exercising the extension.\n\n## Development\n\nThe usual [Prettier][prettier] and [ESLint][eslint] combo in VS Code or Codium OSS is used.\n\n* [This matcher][matcher] is also used, since the originally generated extension per [guide].\n* Markdown gets linted with the (usual) [vscode-markdownlint][markdownlint] extension.\n* [SonarLint][sonarlint] is also assumed while further developing this extension.\n\nThese are actual [recommended extensions herein](.vscode/extensions.json).\n\n* Beside using [the extension][prettier], one may run `prettier` from the CLI:\n\n```bash\n# confirm formatting is ok:\nyarn format:check\n# correct the formatting:\nyarn format:write\n\n```\n\n## Release/publish\n\nWe 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.\n\n### Triggering a new release\n\nWhenever a new release is desired, it can be triggered through a PR, as per the following:\n\nCreate a new branch for your PR, based on the repo's latest state. e.g.\n\n```bash\ngit branch new-release \u0026\u0026 git checkout new-release\n```\n\nThen 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:\n\n``` bash\nyarn version:major\n# or\nyarn version:minor\n# or\nyarn version:patch\n```\n\nModify the _version tag_ in file `./RELEASE`, to match the new release. Amend the release commit to include this change:\n\n```bash\ngit add RELEASE \u0026\u0026 git commit --amend\n```\n\nFinally, 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.\n\n[backlog]: https://github.com/eclipse-cdt-cloud/vscode-trace-extension/issues/15\n[blueprint]: https://theia-ide.org/docs/blueprint_download\n[client]: https://github.com/eclipse-cdt-cloud/tsp-typescript-client\n[code]: https://code.visualstudio.com\n[codium]: https://vscodium.com\n[eslint]: https://open-vsx.org/extension/dbaeumer/vscode-eslint\n[guide]: https://code.visualstudio.com/api/get-started/your-first-extension\n[install]: https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix\n[item]: https://github.com/eclipse-cdt-cloud/vscode-trace-extension/pull/120\n[markdownlint]: https://open-vsx.org/extension/DavidAnson/vscode-markdownlint\n[matcher]: https://open-vsx.org/extension/amodio/tsl-problem-matcher\n[prettier]: https://open-vsx.org/extension/esbenp/prettier-vscode\n[sample]: https://github.com/microsoft/vscode-extension-samples/blob/main/helloworld-sample\n[server]: https://git.eclipse.org/r/plugins/gitiles/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/refs/heads/master/trace-server/#running-the-server\n[sonarlint]: https://open-vsx.org/extension/SonarSource/sonarlint-vscode\n[theia]: https://theia-ide.org\n[tsp]: https://github.com/eclipse-cdt-cloud/trace-server-protocol\n[vsce]: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce\n[vscode-trace-extension]: https://github.com/eclipse-cdt-cloud/vscode-trace-extension\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-cdt-cloud%2Fvscode-trace-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-cdt-cloud%2Fvscode-trace-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-cdt-cloud%2Fvscode-trace-server/lists"}