Skip to content

Commit

Permalink
update docs per review
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>
  • Loading branch information
andreasgerstmayr committed Oct 8, 2024
1 parent c350dba commit 0c13aa5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Note that `./packages/plexus` does not yet have any tests, as tracked in issue [
`./packages/jaeger-ui` uses [Jest](https://jestjs.io/) for testing. It can be useful to directly run tests for that package by running `npm test` from its directory, rather than the repository root.

To run an individual test file specify the file name, e.g. `npm test src/utils/readJsonFile.test.js`
Tests for React components in `./packages/jaeger-ui` make extensive use of Jest's [snapshot testing](https://jestjs.io/docs/28.x/snapshot-testing) functionality. These snapshots can be regenerated by running `npm test -- -u` from the package directory to regenerate all snapshots, or `npm test -- -u --testNamePattern <test name>` to regenerate snapshots for a subset of tests only.
Tests for React components in `./packages/jaeger-ui` make extensive use of Jest's [snapshot testing](https://jestjs.io/docs/29.6/snapshot-testing) functionality. These snapshots can be regenerated by running `npm test -- -u` from the package directory to regenerate all snapshots, or `npm test -- -u -t <regex>` to regenerate snapshots for a subset of tests only (`<regex>` matches against the full test name, [i.e. the test name and all surrounding describe blocks](https://jestjs.io/docs/29.6/cli#--testnamepatternregex)).

### `husky` . `hooks` . `pre-commit`

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ nvm use
Install dependencies via `npm`:

```
npm install
npm ci
```

Make sure you have the Jaeger Query service running on http://localhost:16686. For example, you can run Jaeger all-in-one Docker image as described in the [documentation][aio-docs].
Expand Down Expand Up @@ -81,8 +81,8 @@ The above command will run a web server on `http://localhost:5173` that will ser

| Command | Description |
| --------------- | ------------------------------------------------------------------- |
| `npm run start` | Starts development server with hot reloading and api proxy. |
| `npm run test` | Run all the tests |
| `npm start` | Starts development server with hot reloading and api proxy. |
| `npm test` | Run all the tests |
| `npm run lint` | Lint the project (eslint, prettier, typescript) |
| `npm run fmt` | Apply Prettier source code formatting |
| `npm run build` | Runs production build. Outputs files to `packages/jaeger-ui/build`. |
Expand Down

0 comments on commit 0c13aa5

Please sign in to comment.