Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eclipse-cdt-cloud/tsp-typescript-client
Client-side implementation, in typescript, of the Trace Server Protocol (TSP)
https://github.com/eclipse-cdt-cloud/tsp-typescript-client
eclipse eclipse-foundation javascript npm trace trace-server-protocol trace-visualization tsp tsp-typescript-client typescript
Last synced: 5 days ago
JSON representation
Client-side implementation, in typescript, of the Trace Server Protocol (TSP)
- Host: GitHub
- URL: https://github.com/eclipse-cdt-cloud/tsp-typescript-client
- Owner: eclipse-cdt-cloud
- License: mit
- Created: 2018-10-17T17:12:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T21:02:35.000Z (18 days ago)
- Last Synced: 2024-12-07T21:32:09.493Z (15 days ago)
- Topics: eclipse, eclipse-foundation, javascript, npm, trace, trace-server-protocol, trace-visualization, tsp, tsp-typescript-client, typescript
- Language: TypeScript
- Homepage:
- Size: 524 KB
- Stars: 9
- Watchers: 13
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# tsp-typescript-client
Client-side implementation, in typescript, of the [Trace Server Protocol][protocol].
> Notice: this implementation is currently in the "Works on my computer" phase. Testing will come soon.
**👋 Want to help?** Read our [contributor guide][contributing].
## Build from sources
### Prerequisites
First, you need Node.js and yarn:
It'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:
```bash
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`:
```bash
npm i -g yarn # the default version should be ok
```
### Building
Clone the repository and run:
```shell
yarn
```
## Tests
### Running tests
To run tests once, at the root of the project do:
```shell
yarn test --verbose
```
To keep tests running do:
```shell
yarn test --verbose --watch
```
### Test coverage
The 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.
```shell
yarn test:coverage
```
You can then find a more detailed coverage report by opening the following file in a browser:
`tsp-typescript-client/coverage/lcov-report/index.html`
[contributing]: CONTRIBUTING.md
[protocol]: https://github.com/eclipse-cdt-cloud/trace-server-protocol
## Release/publish
Publishing this repository's npm package and creating a corresponding GitHub release with git tag (latest only), all happen on GitHub CI.
### Publish next package
A `next` package is automatically published to `npm` every time a PR is merged.
### Publish latest / release
Whenever 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:
Create a new branch for your PR. e.g.
```bash
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 version, according to the release type. A new release commit will be created:
``` bash
yarn version:major
# or
yarn version:minor
# or
yarn version:patch
```
Modify the _version tag_ in file `./RELEASE`, to match the new release. Then amend the release commit to include this change:
```bash
git add RELEASE && git commit --amend
```
Finally, 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`.