From 6bdb0644685d517477cffc6ff4f9754969130f2c Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Fri, 19 Apr 2024 15:00:40 +0200 Subject: [PATCH] chore: harmonize and describe jest usage --- CONTRIBUTING.md | 3 ++- package.json | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c9da284..3ad7048e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/package.json b/package.json index ca514b84..775ff2ea 100644 --- a/package.json +++ b/package.json @@ -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"