{"id":22555465,"url":"https://github.com/eclipse-cdt-cloud/tsp-typescript-client","last_synced_at":"2025-04-09T18:16:55.548Z","repository":{"id":37803001,"uuid":"153494843","full_name":"eclipse-cdt-cloud/tsp-typescript-client","owner":"eclipse-cdt-cloud","description":"Client-side implementation, in typescript, of the Trace Server Protocol (TSP)","archived":false,"fork":false,"pushed_at":"2025-03-06T15:39:39.000Z","size":376,"stargazers_count":9,"open_issues_count":6,"forks_count":22,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-02T17:09:59.018Z","etag":null,"topics":["eclipse","eclipse-foundation","javascript","npm","trace","trace-server-protocol","trace-visualization","tsp","tsp-typescript-client","typescript"],"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.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2018-10-17T17:12:54.000Z","updated_at":"2025-03-06T15:39:23.000Z","dependencies_parsed_at":"2024-04-16T20:25:19.357Z","dependency_job_id":"7a18d79b-ca12-49f8-9100-5cad6b76f412","html_url":"https://github.com/eclipse-cdt-cloud/tsp-typescript-client","commit_stats":{"total_commits":133,"total_committers":19,"mean_commits":7.0,"dds":0.7593984962406015,"last_synced_commit":"d2adc0c81718de74256825cc2a131c171c056d86"},"previous_names":["theia-ide/tsp-typescript-client"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Ftsp-typescript-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Ftsp-typescript-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Ftsp-typescript-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-cdt-cloud%2Ftsp-typescript-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-cdt-cloud","download_url":"https://codeload.github.com/eclipse-cdt-cloud/tsp-typescript-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987092,"owners_count":21028891,"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","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","javascript","npm","trace","trace-server-protocol","trace-visualization","tsp","tsp-typescript-client","typescript"],"created_at":"2024-12-07T19:07:57.476Z","updated_at":"2025-04-09T18:16:55.531Z","avatar_url":"https://github.com/eclipse-cdt-cloud.png","language":"TypeScript","readme":"# tsp-typescript-client\n\nClient-side implementation, in typescript, of the [Trace Server Protocol][protocol].\n\n\u003e Notice: this implementation is currently in the \"Works on my computer\" phase. Testing will come soon.\n\n**👋 Want to help?** Read our [contributor guide][contributing].\n\n## Build from sources\n\n### Prerequisites\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\n### Building\n\nClone the repository and run:\n\n```shell\nyarn\n```\n\n## Tests\n\n### Running tests\n\nTo run tests once, at the root of the project do:\n\n```shell\nyarn test --verbose\n```\n\nTo keep tests running do:\n\n```shell\nyarn test --verbose --watch\n```\n\n### Test coverage\n\nThe following command prints a coverage report to the terminal. As of now it covers all typescript files of the project, including those that are not supposed to have tests.\n\n```shell\nyarn test:coverage\n```\n\nYou can then find a more detailed coverage report by opening the following file in a browser:\n\n `tsp-typescript-client/coverage/lcov-report/index.html`\n\n[contributing]: CONTRIBUTING.md\n[protocol]: https://github.com/eclipse-cdt-cloud/trace-server-protocol\n\n## Release/publish\n\nPublishing this repository's npm package and creating a corresponding GitHub release with git tag (latest only), all happen on GitHub CI.\n\n### Publish next package\n\nA `next` package is automatically published to `npm` every time a PR is merged.\n\n### Publish latest / release\n\nWhenever a new release is desired, including publishing a corresponding `latest` package to `npm`, it can be triggered through a PR. The following has to be done:\n\nCreate a new branch for your PR. 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 version, 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. Then amend the release commit to include this change:\n\n```bash\n\u003cedit ./RELEASES to update tag\u003e\ngit add RELEASE \u0026\u0026 git commit --amend\n```\n\nFinally, push the branch 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-latest` CI job should trigger and if everything goes well, publish the new version of the repo's package to `npm`.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-cdt-cloud%2Ftsp-typescript-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-cdt-cloud%2Ftsp-typescript-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-cdt-cloud%2Ftsp-typescript-client/lists"}