Skip to content

docs: update testing commands in CONTRIBUTING.md #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 29, 2024
Merged

docs: update testing commands in CONTRIBUTING.md #497

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7f2670
docs: update testing commands in CONTRIBUTING.md
chenjiahan Nov 29, 2024
1b7ee00
fix
chenjiahan Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thanks for that you are interested in contributing to Rslib. Before starting you

## Install Node.js

Use [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to run the command below. This will switch to the Node.js version (currently 18) specified in the project's `.nvmrc` file.
Use [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to run the command below. This will switch to the Node.js version specified in the project's `.nvmrc` file.

```bash
# with fnm
Expand Down Expand Up @@ -88,21 +88,27 @@ You can also run the unit tests of single package:
pnpm run test:unit packages/core
```

### Run artifact tests
Update snapshots:

Rslib will also verify the correctness of generated artifacts. You can run the artifact tests by executing the following command:
```sh
pnpm run test:unit -u
```

### Run integration tests

Rslib will also verify the correctness of generated artifacts. You can run the integration tests by executing the following command:

```sh
pnpm run test:artifact
pnpm run test:integration
```

If you need to run a specified test, you can add keywords to filter:

```sh
# Only run test cases which contains `dts` keyword in file path
pnpm test:artifact dts
pnpm test:integration dts
# Only run test cases which contains `dts` keyword in test name
pnpm test:artifact -t dts
pnpm test:integration -t dts
```

## Linting
Expand Down
Loading