Skip to content

Commit 03a52b9

Browse files
Merge pull request #178 from MikeMcC399/jest-usage
chore: harmonize and describe jest usage
2 parents c4c75ef + 6bdb064 commit 03a52b9

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ Thanks for taking the time to contribute! :smile:
55
To add a new rule:
66
* Fork and clone this repository
77
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
8-
* Run `yarn start` or `npm start`
98
* Write test scenarios then implement logic
109
* Describe the rule in the generated `docs` file
10+
* Run `npm test` to run [Jest](https://jestjs.io/) or
11+
* Run `npm start` to run [Jest](https://jestjs.io/) in [watchAll](https://jestjs.io/docs/cli#--watchall) mode where it remains active and reruns when source changes are made
1112
* Make sure all tests are passing
1213
* Add the rule to the [README](README.md) file
1314
* Create a PR

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"lint": "eslint \"*.js\" \"**/**/*.js\"",
4343
"lint-fix": "npm run lint -- --fix",
4444
"semantic-release": "semantic-release",
45-
"start": "yarn run test-watch",
45+
"start": "npm run test-watch",
4646
"test": "jest",
4747
"test-watch": "jest --watchAll",
4848
"prepare": "husky install"

0 commit comments

Comments
 (0)