add build command; fix make dev for first-time users (#526)

segmentio · Jul 7, 2022 · 908f47d · 908f47d
1 parent 59ac4e3
commit 908f47d
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 4 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -102,7 +102,7 @@ steps:
       - echo "--- Install dependencies"
       - yarn install --immutable
       - echo "+++ Run tests"
-      - yarn workspace @segment/analytics-next build:dev
+      - yarn workspace @segment/analytics-next build
       - yarn workspace with-next-js lint
       - yarn workspace with-next-js build
     plugins:

diff --git a/.changeset/wild-pens-fix.md b/.changeset/wild-pens-fix.md
@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': patch
+---
+
+Updated dev instructions in README
diff --git a/README.md b/README.md
@@ -168,6 +168,8 @@ $ cd analytics-next
 $ yarn dev
 ```
 
+> If you get "Cannot find module '@segment/analytics-next' or its corresponding type declarations.ts(2307)" (in VSCode), you may have to "cmd+shift+p -> "TypeScript: Restart TS server"
+
 Then, make your changes and test them out in the test app!
 
 <img src="https://user-images.githubusercontent.com/2866515/135407053-7561d522-b969-484d-8d3a-6f1c4d9c025b.gif" alt="Example of the development app" width="500px">

diff --git a/package.json b/package.json
@@ -12,8 +12,8 @@
   "scripts": {
     "test": "echo 'Running all tests...' && yarn workspaces foreach run test",
     "lint": "echo 'Linting all workspaces...' && yarn constraints && yarn workspaces foreach -p run lint",
-    "build:dev": "yarn workspace @segment/analytics-next build:dev",
     "dev": "yarn workspace @segment/analytics-next exec make dev",
+    "build": "yarn workspaces foreach -pt --no-private run build",
     "postinstall": "husky install",
     "changeset": "changeset",
     "update-versions-and-changelogs": "changeset version && yarn version-run-all",

diff --git a/packages/browser/Makefile b/packages/browser/Makefile
@@ -87,5 +87,6 @@ analyze:
 .PHONY: analyze
 
 dev: ## Starts a dev server that is ready for development
-	$(yarn_run) concurrently "yarn workspace with-next-js dev" "$(yarn_run) pkg -w"
+	$(yarn_run) pkg --incremental
+	$(yarn_run) concurrently "sleep 2 && yarn workspace with-next-js dev" "$(yarn_run) pkg -w"
 .PHONY: dev
diff --git a/packages/browser/README.md b/packages/browser/README.md
@@ -168,6 +168,8 @@ $ cd analytics-next
 $ yarn dev
 ```
 
+> If you get "Cannot find module '@segment/analytics-next' or its corresponding type declarations.ts(2307)" (in VSCode), you may have to "cmd+shift+p -> "TypeScript: Restart TS server"
+
 Then, make your changes and test them out in the test app!
 
 <img src="https://user-images.githubusercontent.com/2866515/135407053-7561d522-b969-484d-8d3a-6f1c4d9c025b.gif" alt="Example of the development app" width="500px">

diff --git a/packages/browser/qa/README.md b/packages/browser/qa/README.md
@@ -5,7 +5,7 @@ Analytics-Next contains a comprehensive QA test suite that verifies that E2E fun
 1. Compile Analytics-Next (browser)
 
 ```sh
-$ yarn build:dev
+$ yarn build
 ```
 
 2. Grab list of test sources