From 22d25caa1e9316fb8e8c04467f2497e05858f2ab Mon Sep 17 00:00:00 2001 From: ota-meshi Date: Wed, 13 Mar 2024 08:52:21 +0900 Subject: [PATCH] chore: fix CONTRIBUTING.md --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7dd8e4bad..4c273bea6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,22 +13,22 @@ pnpm install ## Running the tests ```sh -pnpm test +pnpm run test ``` -To run the tests with debugging log, you can use `pnpm test:debug`. +To run the tests with debugging log, you can use `pnpm run 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 `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. +This plugin is used to lint itself. The style is checked when `pnpm run lint` is run, and the build will fail if there are any linting errors. You can use `pnpm run lint-fix` to fix some linting errors. ## Other Development Tools -- `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. +- `pnpm run test` runs tests. +- `pnpm run cover` runs tests and measures coverage. +- `pnpm run new -- [new-rule-name]` generate the files needed to implement the new rule. +- `pnpm run update` runs in order to update readme and recommended configuration. +- `pnpm run docs:watch` launch the document site in development mode. ## Test the Rule @@ -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 -pnpm test -g indent +pnpm run test -- -g indent ``` Take as reference for details.