feat: add minimal example with SDK generation #62

MickVanDuijn · 2024-12-20T09:21:18Z

No description provided.

MickVanDuijn · 2024-12-20T09:21:33Z

feat: add minimal example with SDK generation #62 👈 (View in Graphite)
refactor: upgrade packages #65
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

examples/minimal-sdk/sdk/src/foo/rest.client.ts

examples/minimal-sdk/package.json

src/lib/openapi.ts

bin/run.js

examples/minimal-sdk/package.json

graphite-app · 2025-03-05T15:05:04Z

.github/workflows/test-examples.yml

+      - name: Clean schemas
+        working-directory: examples/minimal-sdk
+        shell: bash
+        run: |
+          rm -rf {src,sdk}/**/schemas;
+          rm -rf {src,sdk}/**/*.type.ts;
+          rm -rf sdk/**/*.client.ts;
+          rm -rf foo.openapi.json;


While this workflow runs on both Windows and Ubuntu, the rm -rf commands will fail on Windows even when using PowerShell. Consider using the cross-platform rimraf package or implementing OS-specific cleanup commands. A simple approach would be:

- name: Clean schemas working-directory: examples/minimal-sdk run: | if [ "$RUNNER_OS" == "Windows" ]; then Remove-Item -Recurse -Force src/**/schemas -ErrorAction Ignore Remove-Item -Recurse -Force src/**/*.type.ts -ErrorAction Ignore Remove-Item -Recurse -Force sdk/**/*.client.ts -ErrorAction Ignore Remove-Item -Force foo.openapi.json -ErrorAction Ignore else rm -rf {src,sdk}/**/schemas rm -rf {src,sdk}/**/*.type.ts rm -rf sdk/**/*.client.ts rm -rf foo.openapi.json fi

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

graphite-app · 2025-03-05T15:05:06Z

examples/minimal-sdk/package.json

+    "generate:openapi": "node ../../bin/run.js openapi && npx biome format --write foo.openapi.json",
+    "generate:types": "npx therefore -f src --clean",
+    "generate:sdk": "npx therefore -f sdk --clean",
+    "generate": "npm run generate:types && npm run generate:sdk && npm run generate:openapi"


The script order creates a potential race condition. The generate:openapi command should run first since it generates the OpenAPI spec that the other commands depend on. Recommend reordering to:

npm run generate:openapi && npm run generate:types && npm run generate:sdk

This ensures the OpenAPI spec exists before type and SDK generation begins.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

github-actions · 2025-03-05T15:11:19Z

🎉 This PR is included in version 1.25.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

MickVanDuijn force-pushed the 12-20-feat_add_minimal_example_with_SDK_generation branch 9 times, most recently from acb94e9 to 54d623e Compare December 20, 2024 10:11

MickVanDuijn force-pushed the 12-20-feat_add_minimal_example_with_SDK_generation branch from 54d623e to 18cbe92 Compare January 6, 2025 11:51

MickVanDuijn marked this pull request as ready for review January 6, 2025 12:00

MickVanDuijn force-pushed the 12-20-feat_add_minimal_example_with_SDK_generation branch 2 times, most recently from 050edb4 to 5e775ae Compare January 6, 2025 12:12

MickVanDuijn force-pushed the 12-20-feat_add_minimal_example_with_SDK_generation branch 2 times, most recently from fae2765 to 5b0d0a9 Compare March 3, 2025 08:41

MickVanDuijn changed the base branch from main to 03-03-refactor_upgrade_packages March 3, 2025 08:41

MickVanDuijn mentioned this pull request Mar 3, 2025

refactor: upgrade packages #65

Merged