Skip to content

Commit

Permalink
chore: fix CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ota-meshi committed Mar 12, 2024
1 parent 0759fd3 commit 5a3655b
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,28 @@ Thanks for contributing!
```sh
git clone https://github.com/sveltejs/eslint-plugin-svelte.git
cd eslint-plugin-svelte
yarn
pnpm install
```

## Running the tests

```sh
yarn test
pnpm test
```

To run the tests with debugging log, you can use `yarn test:debug`.
To run the tests with debugging log, you can use `pnpm test:debug`.

This is an [ESLint](http://eslint.org) plugin. Documentation for the APIs that it uses can be found on ESLint's [Working with Plugins](http://eslint.org/docs/developer-guide/working-with-plugins) page.

This plugin is used to lint itself. The style is checked when `yarn lint` is run, and the build will fail if there are any linting errors. You can use `yarn lint-fix` to fix some linting errors.
This plugin is used to lint itself. The style is checked when `pnpm lint` is run, and the build will fail if there are any linting errors. You can use `pnpm lint-fix` to fix some linting errors.

## Other Development Tools

- `yarn test` runs tests.
- `yarn cover` runs tests and measures coverage.
- `yarn new [new-rule-name]` generate the files needed to implement the new rule.
- `yarn update` runs in order to update readme and recommended configuration.
- `yarn docs:watch` launch the document site in development mode.
- `pnpm test` runs tests.
- `pnpm cover` runs tests and measures coverage.
- `pnpm new [new-rule-name]` generate the files needed to implement the new rule.
- `pnpm update` runs in order to update readme and recommended configuration.
- `pnpm docs:watch` launch the document site in development mode.

## Test the Rule

Expand All @@ -52,7 +52,7 @@ To verify the output of invalid test cases requires `*-errors.json`, and `*-outp
If you want to test only one rule, run the following command (for `indent` rule):

```sh
yarn test -g indent
pnpm test -g indent
```

Take <https://stackoverflow.com/questions/10832031/how-to-run-a-single-test-with-mocha> as reference for details.
Expand Down

0 comments on commit 5a3655b

Please sign in to comment.