From ee040058ebb72cc6b8ff27ef02d4d4087e5afe8b Mon Sep 17 00:00:00 2001 From: Monil Bhavsar Date: Wed, 31 Jul 2024 17:29:12 +0530 Subject: [PATCH 1/2] Add testing steps --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 61a8eec..470e682 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,14 @@ This package provides Expensify's .eslintrc as an extensible shared config. Most 1. Make a change 2. Bump the version in package.json and submit your PR +### Testing + +After you have submitted a PR with a new version in the `package.json` file + +1. Get the full commitID of the last commit in your PR and run `npm install git+https://github.com/Expensify/eslint-config-expensify.git#COMMIT_ID` in the repo against which you want to test those changes. +2. This should update the version of `eslint-config-expensify` in `package-lock.json` file, and ensures the repo is referencing to the correct version of the eslint config. +3. Now, you can run `npm run lint` or perform any other tests you want in that repo. + ### After PR is merged You need to publish the newest version of this to NPM so that we can update it in the other repos 1. From the command line, in the directory for this repo: From ab418187a35951297bd89b7606e772431c378727 Mon Sep 17 00:00:00 2001 From: Monil Bhavsar Date: Wed, 31 Jul 2024 17:31:17 +0530 Subject: [PATCH 2/2] Formatting --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 470e682..c844a63 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ This package provides Expensify's .eslintrc as an extensible shared config. Most ### Testing -After you have submitted a PR with a new version in the `package.json` file +After you have submitted a PR with an updated version in the `package.json` file, -1. Get the full commitID of the last commit in your PR and run `npm install git+https://github.com/Expensify/eslint-config-expensify.git#COMMIT_ID` in the repo against which you want to test those changes. +1. Get the full commitID of the last commit in your PR, and run `npm install git+https://github.com/Expensify/eslint-config-expensify.git#COMMIT_ID` in the repo against which you want to test those changes. 2. This should update the version of `eslint-config-expensify` in `package-lock.json` file, and ensures the repo is referencing to the correct version of the eslint config. 3. Now, you can run `npm run lint` or perform any other tests you want in that repo.