From c1d850fd43fd88adab07a267ac49b2c2e9b50f81 Mon Sep 17 00:00:00 2001 From: Justin Halsall Date: Mon, 10 Jun 2024 13:37:38 +0200 Subject: [PATCH] chore: its important to run `yarn build:all` before running `yarn dev` --- README.md | 2 +- turbo.json | 15 ++++++--------- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 17e6b5591a..e73c2a8768 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Since we want the record and replay sides to share a strongly typed data structu 1. Fork this repository. 2. Run `yarn install` in the root to install required dependencies for all sub-packages (note: `npm install` is _not_ recommended). -3. Run `yarn dev` in the root to get auto-building for all the sub-packages whenever you modify anything. +3. Run `yarn build:all` to build all packages and get a stable base, then `yarn dev` in the root to get auto-building for all the sub-packages whenever you modify anything. 4. Navigate to one of the sub-packages (in the `packages` folder) where you'd like to make a change. 5. Patch the code and run `yarn test` to run the tests, make sure they pass before you commit anything. Add test cases in order to avoid future regression. 6. If tests are failing, but the change in output is desirable, run `yarn test:update` and carefully commit the changes in test output. diff --git a/turbo.json b/turbo.json index 55987d162f..f1e05b29ce 100644 --- a/turbo.json +++ b/turbo.json @@ -8,6 +8,7 @@ "vite.config.defaults.ts", "tsconfig.json" ], + "globalPassThroughEnv": ["CLEAR_DIST_DIR", "PUPPETEER_HEADLESS"], "tasks": { "prepublish": { "dependsOn": ["^prepublish"], @@ -21,22 +22,18 @@ ] }, "test": { - "dependsOn": ["^prepublish"], - "passThroughEnv": ["PUPPETEER_HEADLESS"] + "dependsOn": ["^prepublish"] }, "test:watch": { - "persistent": true, - "passThroughEnv": ["PUPPETEER_HEADLESS"] + "persistent": true }, "test:update": { - "dependsOn": ["^prepublish"], - "passThroughEnv": ["PUPPETEER_HEADLESS"] + "dependsOn": ["^prepublish"] }, "dev": { - // "dependsOn": ["^prepublish"], + // "dependsOn": ["prepublish", "^prepublish"], "persistent": true, - "cache": false, - "passThroughEnv": ["CLEAR_DIST_DIR"] + "cache": false }, "lint": {}, "check-types": {}