Skip to content

Commit

Permalink
Move test instructions from the packages README.md to the root README.md
Browse files Browse the repository at this point in the history
The package READEME.md is used on npm registry to give users information
about the library. Instructions for developers that develop the
theia-trace-extensions need to go in the root README.md

Update test script in the root package.json to allow forwarding
parameters to the packages test script execution. With this the test
can be executed from the root directory.

Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
  • Loading branch information
bhufmann committed Oct 8, 2021
1 parent 774943c commit f035adc
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,28 @@ It's possible to package the repo's example application with `electron-builder`.

The configured Linux packaging(s) will be generated in folder `examples/electron/dist`

## 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 --collectCoverageFrom='src/**/*.ts'
```

## Using the trace extension
This section describes how to operate the Theia trace extension to view and analyze traces. The UI, view interactions, and UX are prelimiary and subject to revisions in the future.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"start-all:browser": "yarn start:server & yarn start:browser",
"start-all:electron": "yarn start:server & yarn start:electron",
"lint": "lerna run lint",
"test": "lerna run test",
"test": "lerna run test --",
"publish:latest": "lerna publish --registry=https://registry.npmjs.org/ --exact --no-git-tag-version --no-push",
"publish:next": "lerna publish --registry=https://registry.npmjs.org/ --exact --canary minor --preid=next.$(git rev-parse --short HEAD) --dist-tag=next --no-git-tag-version --no-push --yes"
},
Expand Down
22 changes: 0 additions & 22 deletions packages/react-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,3 @@ The Trace Viewer react-components package contains views and utilities for visua
- [Theia Trace Viewer Extension](https://github.com/theia-ide/theia-trace-extension)
- [Trace Server Protocol](https://github.com/theia-ide/trace-server-protocol)
- [Reference Trace Server - Download (Eclipse Trace Compass)](https://download.eclipse.org/tracecompass.incubator/trace-server/rcp/)

## 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 --collectCoverageFrom='src/**/*.ts'
```

0 comments on commit f035adc

Please sign in to comment.