Skip to content

Commit 3153195

Browse files
committed
chore: replace npm comments with pnpm
1 parent 36c6c49 commit 3153195

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Tweaking ESLint rules is mostly about traversing through the AST. [AST Explorer]
1111

1212
1. Fork this repository
1313
2. Clone your forked repository
14-
3. Run `npm install` to install corresponding dependencies
14+
3. Run `pnpm install` to install corresponding dependencies
1515
4. Create a branch for your PR named like `pr/your-branch-name` (you can do this through git CLI with `git checkout -b pr/your-branch-name`)
1616

1717
> Tip: Keep your `main` branch pointing at the original repository and make
@@ -63,7 +63,7 @@ each rule has three files named with its identifier (e.g. `no-debugging-utils`):
6363
6464
Additionally, you need to do a couple of extra things:
6565
66-
- Run `npm run generate:rules-doc` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
66+
- Run `pnpm run generate:rules-doc` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
6767
6868
### Custom rule creator
6969
@@ -99,7 +99,7 @@ If you need some check related to Testing Library which is not available in any
9999
- pass it through `helpers`
100100
- write some generic test within `fake-rule.ts`, which is a dumb rule to be able to test all enhanced behavior from our custom Rule Creator.
101101
102-
Take also into account that we're using our own `recommendedConfig` meta instead of the default `recommended` one. This is done so that our tools can automatically generate (`npm run generate:configs`) our configs.
102+
Take also into account that we're using our own `recommendedConfig` meta instead of the default `recommended` one. This is done so that our tools can automatically generate (`pnpm run generate:configs`) our configs.
103103
104104
## Updating existing rules
105105

lib/configs/angular.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// THIS CODE WAS AUTOMATICALLY GENERATED
22
// DO NOT EDIT THIS CODE BY HAND
3-
// YOU CAN REGENERATE IT USING npm run generate:configs
3+
// YOU CAN REGENERATE IT USING pnpm run generate:configs
44

55
export = {
66
plugins: ['testing-library'],

lib/configs/dom.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// THIS CODE WAS AUTOMATICALLY GENERATED
22
// DO NOT EDIT THIS CODE BY HAND
3-
// YOU CAN REGENERATE IT USING npm run generate:configs
3+
// YOU CAN REGENERATE IT USING pnpm run generate:configs
44

55
export = {
66
plugins: ['testing-library'],

lib/configs/marko.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// THIS CODE WAS AUTOMATICALLY GENERATED
22
// DO NOT EDIT THIS CODE BY HAND
3-
// YOU CAN REGENERATE IT USING npm run generate:configs
3+
// YOU CAN REGENERATE IT USING pnpm run generate:configs
44

55
export = {
66
plugins: ['testing-library'],

lib/configs/react.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// THIS CODE WAS AUTOMATICALLY GENERATED
22
// DO NOT EDIT THIS CODE BY HAND
3-
// YOU CAN REGENERATE IT USING npm run generate:configs
3+
// YOU CAN REGENERATE IT USING pnpm run generate:configs
44

55
export = {
66
plugins: ['testing-library'],

lib/configs/vue.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// THIS CODE WAS AUTOMATICALLY GENERATED
22
// DO NOT EDIT THIS CODE BY HAND
3-
// YOU CAN REGENERATE IT USING npm run generate:configs
3+
// YOU CAN REGENERATE IT USING pnpm run generate:configs
44

55
export = {
66
plugins: ['testing-library'],

tools/generate-configs/utils.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const addAutoGeneratedComment = (code: string) =>
1010
[
1111
'// THIS CODE WAS AUTOMATICALLY GENERATED',
1212
'// DO NOT EDIT THIS CODE BY HAND',
13-
'// YOU CAN REGENERATE IT USING npm run generate:configs',
13+
'// YOU CAN REGENERATE IT USING pnpm run generate:configs',
1414
'',
1515
code,
1616
].join('\n');

0 commit comments

Comments
 (0)