[development] Add turborepo convenience npm script using dot (#927)

segmentio · Aug 15, 2023 · 9ba0dc6 · 9ba0dc6
1 parent 4da8339
commit 9ba0dc6
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 14 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -80,7 +80,7 @@ steps:
       - echo "--- Install dependencies"
       - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 HUSKY=0 yarn install --immutable
       - echo "--- Build bundles"
-      - yarn run -T core+deps build
+      - yarn run -T core . build
       - echo "+++ Run tests"
       - yarn run -T core lint
       - yarn run -T core test

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,8 +1,30 @@
-## Development
+# Development
 
+This project uses [Turborepo](https://turbo.build/repo/docs), for dependency-aware builds and linting. Please read up!
+
+### Setup
 ```sh
  git clone git@github.com:segmentio/analytics-next.git && cd analytics-next
  nvm use  # install version of node defined in .nvmrc.
  yarn && yarn build
  yarn lint && yarn test
 ```
+
+### 
+
+### Build a specific package and all dependencies
+You have a couple options:
+1. you can _cd_ into a single package and run `yarn . build`  build a package and all its dependencies (most convenient!).
+
+2. You can use turborepo directly to build a package and all dependencies. See: Turborepo https://turbo.build/repo/docs/core-concepts/monorepos/filtering#filter-syntax.
+
+For example: 
+```
+yarn run -T turbo run build --filter=@segment/analytics-next
+```
+or
+```
+yarn run -T turbo run build --filter='./packages/node*'
+```
+
+^ Note, the following applies to not only `build`, but other tasks such as `test`, `lint`, etc.
diff --git a/examples/standalone-playground/package.json b/examples/standalone-playground/package.json
@@ -5,6 +5,7 @@
     "hoistingLimits": "workspaces"
   },
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@example/standalone-playground",
     "dev": "yarn concurrently 'yarn run -T watch --filter=standalone-playground' 'sleep 10 && yarn http-server .'",
     "concurrently": "yarn run -T concurrently"
   },

diff --git a/examples/with-next-js/package.json b/examples/with-next-js/package.json
@@ -3,6 +3,7 @@
   "version": "0.1.0",
   "private": true,
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@example/with-next-js",
     "concurrently": "yarn run -T concurrently",
     "dev": "yarn partytown && yarn concurrently 'yarn run -T watch --filter=with-next-js' 'sleep 10 && next dev'",
     "build": "yarn partytown && next build",

diff --git a/examples/with-vite/package.json b/examples/with-vite/package.json
@@ -2,6 +2,7 @@
   "name": "@example/with-vite",
   "private": true,
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@example/with-vite",
     "concurrently": "yarn run -T concurrently",
     "dev": "yarn concurrently 'yarn run -T watch --filter=with-vite' 'sleep 10 && vite'",
     "build": "tsc && vite build",

diff --git a/package.json b/package.json
@@ -25,11 +25,8 @@
     "release": "yarn clean && yarn build --force && changeset publish && git push origin HEAD:master --follow-tags --no-verify",
     "version-run-all": "yarn workspaces foreach -vpt --no-private run version",
     "core": "yarn workspace @segment/analytics-core",
-    "core+deps": "turbo run --filter=@segment/analytics-core",
     "browser": "yarn workspace @segment/analytics-next",
-    "browser+deps": "turbo run --filter=@segment/analytics-next",
     "node": "yarn workspace @segment/analytics-node",
-    "node+deps": "turbo run --filter=@segment/analytics-node",
     "clean": "bash scripts/clean.sh",
     "turbo": "turbo"
   },

diff --git a/packages/browser/Makefile b/packages/browser/Makefile
@@ -18,7 +18,7 @@ build-browser: build # build dependencies
 .PHONY: build-browser
 
 build: ## Builds libraries in prod mode, and all dependencies
-	yarn run -T browser+deps build
+	yarn run -T browser . build
 .PHONY: build
 
 clean: ## Clean the build directory

diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -24,6 +24,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@segment/analytics-next",
     "build-prep": "sh scripts/build-prep.sh",
     "version": "yarn run build-prep && git add src/generated/version.ts",
     "umd": "webpack",
@@ -33,7 +34,7 @@
     "concurrently": "yarn run -T concurrently",
     "watch": "yarn concurrently 'NODE_ENV=production WATCH=true yarn umd --watch' 'yarn pkg --watch'",
     "build": "yarn clean && yarn build-prep && yarn concurrently 'NODE_ENV=production yarn umd' 'yarn pkg' 'yarn cjs'",
-    "release:cdn": "yarn run -T browser+deps build && NODE_ENV=production bash scripts/release.sh && NODE_ENV=stage bash scripts/release.sh",
+    "release:cdn": "yarn . build && NODE_ENV=production bash scripts/release.sh && NODE_ENV=stage bash scripts/release.sh",
     "pkg": "yarn tsc -p tsconfig.build.json",
     "cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",
     "clean": "rm -rf dist",

diff --git a/packages/consent/consent-tools-integration-tests/README.md b/packages/consent/consent-tools-integration-tests/README.md
@@ -17,8 +17,7 @@ Why is this using wd.io instead of playwright?
 ## Development
 ### 1. Build this package + deps
 ```sh
-# include the "..."
-yarn build... 
+yarn . build
 ```
 ### 2. Start server + run tests (and exit gracefully)
 ```

diff --git a/packages/consent/consent-tools-integration-tests/package.json b/packages/consent/consent-tools-integration-tests/package.json
@@ -2,10 +2,10 @@
   "name": "@internal/consent-tools-integration-tests",
   "private": true,
   "scripts": {
+    ".": "yarn -T turbo run --filter=@internal/consent-tools-integration-tests",
     "dev": "yarn concurrently 'yarn watch' 'yarn build serve --open'",
     "build": "webpack",
     "watch": "yarn build --watch",
-    "build...": "yarn run -T turbo run build --filter=@internal/consent-tools-integration-tests",
     "test:local": "wdio wdio.conf.local.ts",
     "start-server-and-test": "yarn concurrently -k 'yarn build serve' 'sleep 5 && yarn test:local'",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",

diff --git a/packages/consent/consent-tools/README.md b/packages/consent/consent-tools/README.md
@@ -67,8 +67,7 @@ See the complete list of settings in the **[Settings interface](src/types/settin
 ## Development
 1. Build this package + all dependencies
 ```sh
-# include the "..."
-yarn build... 
+yarn . build
 ```
 
 2. Run tests

diff --git a/packages/consent/consent-tools/package.json b/packages/consent/consent-tools/package.json
@@ -12,10 +12,10 @@
     "!*.tsbuildinfo"
   ],
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@segment/analytics-consent-tools",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "rm -rf dist && yarn concurrently 'yarn:build:*'",
-    "build...": "yarn run -T turbo run build --filter=@segment/analytics-consent-wrapper-onetrust",
     "build:esm": "yarn tsc -p tsconfig.build.json",
     "build:cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",
     "watch": "yarn build:esm --watch",

diff --git a/packages/consent/consent-wrapper-onetrust/package.json b/packages/consent/consent-wrapper-onetrust/package.json
@@ -12,10 +12,10 @@
     "!*.tsbuildinfo"
   ],
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@segment/analytics-consent-wrapper-onetrust",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "rm -rf dist && yarn concurrently 'yarn:build:*'",
-    "build...": "yarn run -T turbo run build --filter=@segment/analytics-consent-wrapper-onetrust",
     "build:esm": "yarn tsc -p tsconfig.build.json",
     "build:cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",
     "watch": "yarn build:esm --watch",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -18,6 +18,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@segment/analytics-core",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "yarn concurrently 'yarn:build:*'",

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -20,6 +20,7 @@
     "node": ">=14"
   },
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@segment/analytics-node",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "rm -rf dist && yarn concurrently 'yarn:build:*'",

diff --git a/packages/test-helpers/package.json b/packages/test-helpers/package.json
@@ -6,6 +6,7 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "scripts": {
+    ".": "yarn run -T turbo run --filter=@internal/test-helpers",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "yarn concurrently 'yarn:build:*'",
     "build:cjs": "yarn tsc -p tsconfig.build.json --outDir ./dist/cjs --module commonjs",