Skip to content

Commit

Permalink
Merge pull request #178 from MikeMcC399/jest-usage
Browse files Browse the repository at this point in the history
chore: harmonize and describe jest usage
  • Loading branch information
jennifer-shehane committed Apr 22, 2024
2 parents c4c75ef + 6bdb064 commit 03a52b9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -5,9 +5,10 @@ Thanks for taking the time to contribute! :smile:
To add a new rule:
* Fork and clone this repository
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
* Run `yarn start` or `npm start`
* Write test scenarios then implement logic
* Describe the rule in the generated `docs` file
* Run `npm test` to run [Jest](https://jestjs.io/) or
* 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
* Make sure all tests are passing
* Add the rule to the [README](README.md) file
* Create a PR
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -42,7 +42,7 @@
"lint": "eslint \"*.js\" \"**/**/*.js\"",
"lint-fix": "npm run lint -- --fix",
"semantic-release": "semantic-release",
"start": "yarn run test-watch",
"start": "npm run test-watch",
"test": "jest",
"test-watch": "jest --watchAll",
"prepare": "husky install"
Expand Down

0 comments on commit 03a52b9

Please sign in to comment.