Add Turborepo (#2027)

drwpow · web-flow · commit 75399f8316cb · 2024-12-01T20:29:21.000-07:00
* Add Turborepo

* Increase timeout for Windows
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,6 +6,9 @@ on:
       - main
   pull_request:
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 concurrency:
   group: ci-${{ github.ref }}
   cancel-in-progress: true
@@ -20,7 +23,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - run: pnpm run lint
   test-node-versions:
@@ -35,9 +38,8 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test
   test-e2e:
     runs-on: ubuntu-latest
@@ -48,7 +50,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - run: pnpm exec playwright install --with-deps
       - run: pnpm run test-e2e
@@ -61,9 +63,8 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test
   test-windows:
     runs-on: windows-latest
@@ -74,7 +75,6 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - run: pnpm test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -5,6 +5,9 @@ on:
     branches:
       - main
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 jobs:
   changelog:
     runs-on: ubuntu-latest
@@ -19,15 +22,13 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
-      - run: pnpm run build
       - uses: changesets/action@v1
         with:
           version: pnpm run version
           publish: pnpm exec changeset publish
           commit: "[ci] release"
           title: "[ci] release"
         env:
-          GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/size-limit.yml b/.github/workflows/size-limit.yml
@@ -1,9 +1,13 @@
 name: "Size Limit"
+
 on:
   pull_request:
     branches: [main]
     types: [opened, synchronize]
 
+env:
+  GITHUB_TOKEN: ${{ secrets.OPENAPI_TS_BOT_GITHUB_TOKEN }}
+
 jobs:
   size-limit:
     permissions:
@@ -17,7 +21,7 @@ jobs:
           node-version: 22
       - uses: pnpm/action-setup@v4
         with:
-          version: latest
+          version: 9.14.4
           run_install: true
       - uses: andresz1/size-limit-action@v1.8.0
         with:
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .DS_Store
+.turbo
 dist
 node_modules
 coverage
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,25 +1,38 @@
 # Contributing
 
-Contributions are welcome! T
+Contributions are welcome!
 
 ## Setup
 
-This monorepo uses [pnpm workspaces](https://pnpm.io/) that lets packages pull from local versions rather than remote. After installing pnpm, running this command from the root will set everything up:
+This monorepo uses [pnpm workspaces](https://pnpm.io/) that lets packages pull from local versions rather than remote. It also uses [Turborepo](https://turbo.build/repo/docs) to run commands more easily. After installing pnpm, running the following commands from the root will set everything up:
 
 ```sh
 pnpm i
+pnpm run build
 ```
 
+## Workspace vs local commands
+
+The “workspace“ is the root `package.json`. Running commands here will run on all packages. For example, running `pnpm run build` in the workspace root will build all packages. But running `cd packages/openapi-typescript && pnpm run build` will only build that one package.
+
+It’s worth noting that some packages depend on others in the monorepo. For example, `openapi-fetch` depends on `openapi-typescript` building built. `openapi-react-query` relies on `openapi-fetch` which relies on `openapi-typescript`. If running commands per-package, you’d have to manually build each package before the test suite could run. But running `pnpm run build` in the workspace root once will build all packages for you, so that you can run any test suite.
+
+> ![NOTE]
+>
+> Note that if any package changes, be sure to rebuild before running tests! Of course, CI will always do this, but in case you see differences between local vs CI, this is usually the culprit—a stale build.
+
+Again, Turborepo is there so that you don’t have to think about all the packages as much, if you’re just contributing to one. But these tips may help you troubleshoot if something unexpected happens.
+
 ## Structure
 
 This monorepo has 2 main sections: the `docs/` that deploy to `openapi-ts.dev`, and `packages/` which are all the npm packages. Each npm package has its own `CONTRIBUTING.md` doc that describes setup needed for that package.
 
 ```
-┬── docs/                         # openapi-ts.dev
-│
+┬── docs/
 └── packages/
-    ├── openapi-fetch/            # openapi-fetch package
+    ├── openapi-fetch/
+    ├── openapi-react-query/
+    ├── openapi-typescript/
     ├── openapi-typescript-helpers/
-    │                             # openapi-typescript package
-    └── openapi-typescript/       # openapi-typescript package
+    └── swr-openapi/
 ```
diff --git a/docs/data/contributors.json b/docs/data/contributors.json
diff --git a/docs/package.json b/docs/package.json
@@ -6,10 +6,9 @@
   "scripts": {
     "build": "pnpm run update-contributors && vitepress build && cp _redirects .vitepress/dist",
     "dev": "pnpm run update-contributors && vitepress dev",
-    "tokens": "co build",
     "update-contributors": "node scripts/update-contributors.js"
   },
   "devDependencies": {
-    "vitepress": "1.3.2"
+    "vitepress": "1.5.0"
   }
 }
diff --git a/package.json b/package.json
@@ -7,14 +7,15 @@
     "name": "Drew Powers",
     "email": "drew@pow.rs"
   },
+  "packageManager": "pnpm@9.14.4",
   "scripts": {
-    "build": "pnpm run -r --filter \"!*docs\" --aggregate-output build",
-    "lint": "pnpm run -r --parallel --aggregate-output lint",
+    "build": "turbo run build",
+    "lint": "turbo run lint",
     "dev": "pnpm run -r --parallel --filter \"{packages/*}\" --aggregate-output dev",
-    "format": "pnpm run -r --parallel --aggregate-output format",
-    "test": "pnpm run -r --parallel --aggregate-output test",
-    "test-e2e": "pnpm run -r --parallel --aggregate-output test-e2e",
-    "size": "pnpm run build && size-limit",
+    "format": "turbo run format",
+    "test": "turbo run test",
+    "test-e2e": "turbo run test-e2e",
+    "size": "turbo run size-limit",
     "version": "pnpm run build && changeset version && pnpm i"
   },
   "devDependencies": {
@@ -27,6 +28,7 @@
     "del-cli": "^5.1.0",
     "prettier": "^3.4.1",
     "size-limit": "^11.1.6",
+    "turbo": "^2.3.3",
     "typescript": "^5.7.2",
     "vitest": "^2.1.6"
   },
diff --git a/packages/openapi-fetch/package.json b/packages/openapi-fetch/package.json
@@ -72,7 +72,7 @@
   "devDependencies": {
     "axios": "^1.7.8",
     "del-cli": "^5.1.0",
-    "esbuild": "^0.23.1",
+    "esbuild": "^0.24.0",
     "execa": "^8.0.1",
     "feature-fetch": "^0.0.15",
     "openapi-typescript": "workspace:^",
diff --git a/packages/openapi-metadata/package.json b/packages/openapi-metadata/package.json
@@ -70,7 +70,7 @@
     "@types/node": "^22.10.1",
     "@vitest/coverage-v8": "^2.1.6",
     "del-cli": "^5.1.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.24.0",
     "execa": "^8.0.1",
     "reflect-metadata": "^0.2.2",
     "tsup": "^8.3.5",
diff --git a/packages/openapi-react-query/package.json b/packages/openapi-react-query/package.json
@@ -70,7 +70,7 @@
     "@types/react": "18.3.1",
     "@vitejs/plugin-react": "^4.3.4",
     "del-cli": "^5.1.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.24.0",
     "execa": "^8.0.1",
     "msw": "^2.6.6",
     "openapi-fetch": "workspace:^",
diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json
@@ -72,7 +72,7 @@
     "@types/js-yaml": "^4.0.9",
     "degit": "^2.8.4",
     "del-cli": "^5.1.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.24.0",
     "execa": "^8.0.1",
     "strip-ansi": "^7.1.0",
     "typescript": "^5.7.2",
diff --git a/packages/openapi-typescript/test/cjs.test.js b/packages/openapi-typescript/test/cjs.test.js
@@ -2,14 +2,20 @@
 const { fileURLToPath } = require("node:url");
 const { astToString, default: openapiTS } = require("../dist/index.cjs");
 
+const TIMEOUT = 10_000;
+
 describe("CJS bundle", () => {
-  it("basic", async () => {
-    const output = `/**
+  test(
+    "basic",
+    async () => {
+      const output = `/**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
 
 ${astToString(await openapiTS(new URL("../examples/stripe-api.yaml", import.meta.url)))}`;
-    expect(output).toMatchFileSnapshot(fileURLToPath(new URL("../examples/stripe-api.ts", import.meta.url)));
-  });
+      expect(output).toMatchFileSnapshot(fileURLToPath(new URL("../examples/stripe-api.ts", import.meta.url)));
+    },
+    { timeout: TIMEOUT },
+  );
 });
diff --git a/packages/openapi-typescript/test/yaml.test.ts b/packages/openapi-typescript/test/yaml.test.ts
@@ -2,16 +2,20 @@ import { execa } from "execa";
 import os from "node:os";
 import { fileURLToPath } from "node:url";
 
+const TIMEOUT = 10_000;
+
 const root = new URL("../", import.meta.url);
 const cwd = os.platform() === "win32" ? fileURLToPath(root) : root; // execa bug: fileURLToPath required on Windows
 const cmd = "./bin/cli.js";
 
 describe("YAML features", () => {
-  test("merge", async () => {
-    const result = await execa(cmd, ["./test/fixtures/yaml-merge.yaml"], {
-      cwd,
-    });
-    expect(result.stdout).toBe(`/**
+  test(
+    "merge",
+    async () => {
+      const result = await execa(cmd, ["./test/fixtures/yaml-merge.yaml"], {
+        cwd,
+      });
+      expect(result.stdout).toBe(`/**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
@@ -84,13 +88,17 @@ export interface operations {
         };
     };
 }`);
-  });
+    },
+    { timeout: TIMEOUT },
+  );
 
-  test("not ignore path item components in paths", async () => {
-    const result = await execa(cmd, ["./test/fixtures/path-item-components.yaml"], {
-      cwd,
-    });
-    expect(result.stdout).toBe(`/**
+  test(
+    "not ignore path item components in paths",
+    async () => {
+      const result = await execa(cmd, ["./test/fixtures/path-item-components.yaml"], {
+        cwd,
+      });
+      expect(result.stdout).toBe(`/**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
@@ -165,5 +173,7 @@ export interface operations {
         };
     };
 }`);
-  });
+    },
+    { timeout: TIMEOUT },
+  );
 });
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/turbo.json b/turbo.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`.DS_Store`
	`2`	`+.turbo`
`2`	`3`	`dist`
`3`	`4`	`node_modules`
`4`	`5`	`coverage`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,9 @@`
`6`	`6`	`"scripts": {`
`7`	`7`	`"build": "pnpm run update-contributors && vitepress build && cp _redirects .vitepress/dist",`
`8`	`8`	`"dev": "pnpm run update-contributors && vitepress dev",`
`9`		`- "tokens": "co build",`
`10`	`9`	`"update-contributors": "node scripts/update-contributors.js"`
`11`	`10`	`},`
`12`	`11`	`"devDependencies": {`
`13`		`- "vitepress": "1.3.2"`
	`12`	`+ "vitepress": "1.5.0"`
`14`	`13`	`}`
`15`	`14`	`}`