feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor #1947

seriouslag · 2025-04-14T01:10:08Z

This NX plugin will generate an NX package from an OpenAPI spec file and run the openapi-ts on the spec.

This is useful for NX projects.
Also very useful to let AI agents know how to use the plugin to automate setting up client code to fit into an NX project.

TODO:

Stretch in this PR:

Support different test frameworks (missing jest)
Generate linting support (eslint, etc)

Questions:
Q: How to handle updates to the OpenAPI spec file?
A: We have added an executor and a call to each generated project. Each project can run the executor to update the spec file and regenerate the client code.

Q: How do we list the plugin in the NX plugin repository
A: https://nx.dev/extending-nx/recipes/publish-plugin#list-your-nx-plugin

Fixes: #1910

Related PRs:

bolt-new-by-stackblitz · 2025-04-14T01:10:11Z

Run & review this pull request in StackBlitz Codeflow.

vercel · 2025-04-14T01:10:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 29, 2025 2:56am

packages/nx-plugin/src/executors/update-api/index.ts

changeset-bot · 2025-04-14T01:13:45Z

⚠️ No Changeset found

Latest commit: cbd9614

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codecov · 2025-04-14T01:26:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 22.17%. Comparing base (5645157) to head (cbd9614).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1947   +/-   ##
=======================================
  Coverage   22.17%   22.17%           
=======================================
  Files         251      251           
  Lines       21314    21314           
  Branches      785      784    -1     
=======================================
  Hits         4727     4727           
  Misses      16581    16581           
  Partials        6        6

Flag	Coverage Δ
unittests	`22.17% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pkg-pr-new · 2025-04-14T01:37:06Z

Open in StackBlitz

@hey-api/client-axios

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/client-axios@1947

@hey-api/client-fetch

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/client-fetch@1947

@hey-api/client-next

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/client-next@1947

@hey-api/client-nuxt

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/client-nuxt@1947

@hey-api/nuxt

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@1947

@hey-api/nx-plugin

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nx-plugin@1947

@hey-api/openapi-ts

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@1947

@hey-api/vite-plugin

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@1947

commit: cbd9614

seriouslag · 2025-04-14T22:42:49Z

examples/openapi-ts-nuxt/turbo.json

@@ -0,0 +1,11 @@
+{


Added this file to cache builds

seriouslag · 2025-04-14T22:43:18Z

examples/openapi-ts-sample/src/App.tsx


 function App() {
  const onClick = async () => {
-    postFoo({
+    addPet({


Changed this file to use actual generated code, I was getting type errors how it was

Sample is meant to be a playground for local development and testing. I thought I ignored it in ESLint?

Maybe was an issue with my IDE, why not use actual code instead of adding broken imports and ignoring it with comments?

I don't remember, I was probably testing something and didn't clean it up. It's similar to the sample snapshot script except it contains a whole app with UI. The idea is to be able to test drive the output since snapshots are never actually executed. Obviously should be way more polished!

seriouslag · 2025-04-14T22:43:33Z

examples/openapi-ts-sample/src/client/client.gen.ts

@@ -1,7 +1,32 @@
 // This file is auto-generated by @hey-api/openapi-ts


Ran the code gen

seriouslag · 2025-04-14T22:44:19Z

packages/config-vite-base/package.json

@@ -10,6 +10,19 @@
  "scripts": {
    "build": "tsup"
  },
+  "exports": {


Was facing issues with our new configs, adding the exports and adding cjs fixed the issues,

seriouslag · 2025-04-14T22:44:44Z

packages/config-vite-base/package.json

+        "default": "./dist/index.cjs"
+      }
+    },
+    "./setup": "./src/setup.ts"


Exporting the setup file as a direct source file for other vitests to use as a setup file.

seriouslag · 2025-04-14T22:45:22Z

packages/config-vite-base/src/setup.ts

@@ -0,0 +1,5 @@
+// FAIL LOUDLY on unhandled promise rejections / errors


Adding this file because vitest fails if an error is uncaught but no trace is given this will add that. This will help future debugging.

seriouslag · 2025-04-14T22:45:45Z

packages/config-vite-base/src/vitest.base.config.ts

@@ -25,6 +25,7 @@ export function createVitestConfig(
        },
      },
      root,
+      setupFiles: ['@config/vite-base/setup'],


Adding our new vitest setup file with the new export path

seriouslag · 2025-04-14T22:46:16Z

turbo.json

@@ -2,7 +2,7 @@
  "$schema": "./node_modules/turbo/schema.json",
  "tasks": {
    "build": {
-      "cache": false,
+      "cache": true,


Enabled caching for quicker local dev

packages/nx-plugin/src/executors/update-api/updateApi.spec.ts

+    });
+    if (existsSync(v2SpecPath)) {
+      logger.debug(`Spec file already exists: ${v2SpecPath}`);
+      await writeFile(v2SpecPath, v2Spec);


packages/nx-plugin/src/executors/update-api/updateApi.ts

…te base config

…ty in update-api and openapi-client

…ing script to js from ts

…d type error

…e module path

- fix typo in vitest.config output - change vitest.config to mts for better type support - list vite and vitest as a dep if enabled - change vitest to single fork runner - change build to only output cjs to support nx plugins - add caching and nx linking if spec file is in another project

- Replace direct mkdir calls with makeDir utility for consistent directory creation. - Update plugin handling in client generation to support additional plugins. - Modify tests and schemas to reflect changes in plugin structure and options. - Improve error handling and logging in updateApi executor. - Add formatting functionality for generated files and update README for clarity.

- Replace the existing openapi-diff dependency with api-smart-diff for improved comparison accuracy. - Add comprehensive test cases to validate spec comparison logic across various scenarios.

…verrides in package.json files to support node 18

… management - Introduce `baseTsConfigName` and `baseTsConfigPath` options in the OpenAPI client generator and update executor schemas. - Enhance README documentation to reflect new options and their usage. - Implement `getBaseTsConfigPath` utility to resolve tsconfig paths based on provided options. - Update tests to cover new tsconfig path handling logic.

- Introduce functions to standardize OpenAPI and Swagger specs, including version detection and conversion. - Implement `removeExamples` function to clean up specs before comparison, ensuring accurate diff results. - Add comprehensive tests for new functionality, covering various scenarios for OpenAPI 3.1 and Swagger 2.0 specs. - Update existing comparison logic to utilize standardized specs for improved accuracy.

vercel bot deployed to Preview April 14, 2025 01:11 View deployment

github-advanced-security bot found potential problems Apr 14, 2025

View reviewed changes

packages/nx-plugin/src/executors/update-api/index.ts Fixed Show fixed Hide fixed

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 37ec549 to d84ba4c Compare April 14, 2025 01:13

vercel bot deployed to Preview April 14, 2025 01:14 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from d84ba4c to fb901bc Compare April 14, 2025 01:20

vercel bot deployed to Preview April 14, 2025 01:21 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from fb901bc to 438dac9 Compare April 14, 2025 01:21

seriouslag changed the title ~~feat(nx-plugin): add nx plugin to generate and update client code~~ feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor Apr 14, 2025

vercel bot deployed to Preview April 14, 2025 01:22 View deployment

vercel bot deployed to Preview April 14, 2025 01:29 View deployment

vercel bot deployed to Preview April 14, 2025 01:34 View deployment

vercel bot deployed to Preview April 14, 2025 21:07 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 0a60e87 to d4711ce Compare April 14, 2025 21:11

vercel bot deployed to Preview April 14, 2025 21:12 View deployment

vercel bot deployed to Preview April 14, 2025 21:35 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from acb3de8 to c889844 Compare April 14, 2025 21:35

vercel bot deployed to Preview April 14, 2025 21:36 View deployment

vercel bot deployed to Preview April 14, 2025 21:52 View deployment

vercel bot deployed to Preview April 14, 2025 22:26 View deployment

vercel bot deployed to Preview April 14, 2025 22:36 View deployment

seriouslag commented Apr 14, 2025

View reviewed changes

vercel bot deployed to Preview April 17, 2025 00:18 View deployment

github-advanced-security bot found potential problems Apr 17, 2025

View reviewed changes

vercel bot deployed to Preview April 17, 2025 00:39 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from df83798 to c527716 Compare April 17, 2025 00:42

seriouslag force-pushed the feat/add-nx-plugin-2 branch from d528380 to f5bc692 Compare April 25, 2025 01:01

vercel bot deployed to Preview April 25, 2025 01:02 View deployment

vercel bot deployed to Preview April 27, 2025 05:08 View deployment

vercel bot deployed to Preview April 27, 2025 14:00 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 5beae2a to 0ee3780 Compare April 27, 2025 22:14

vercel bot deployed to Preview April 27, 2025 22:16 View deployment

seriouslag added 15 commits April 28, 2025 19:22

feat(nx-plugin): add nx plugin to generate and update client code

ae86e44

feat(config): add exports field and support for CommonJS format in Vi…

e0eaaee

…te base config

fix(turbo.json): enable caching for build task

b968ea0

fix(nx-plugin): update build output

d5b4b98

refactor(nx-plugin): update schema prompts and descriptions for clari…

9e5a8b9

…ty in update-api and openapi-client

chore(nx-plugin): remove ts-node dependency and update JSON file copy…

7f939ed

…ing script to js from ts

feat(vitest): add setup files configuration to Vitest base config

1f1f220

feat(turbo.json): add inputs configuration for improved build process

0a90302

feat(client): update example to use actual code from the spec to avoi…

c1fbe4e

…d type error

feat(config): update setup file reference in Vitest base config to us…

a4760b1

…e module path

feat(turbo.json): add build task configuration for Nuxt project

faec8da

feat(nx-plugin): enhance OpenAPI spec comparison functionality

724f10e

- Replace the existing openapi-diff dependency with api-smart-diff for improved comparison accuracy. - Add comprehensive test cases to validate spec comparison logic across various scenarios.

chore(dependencies): downgrade find-my-way to version 9.2.0 and add o…

9b2abc4

…verrides in package.json files to support node 18

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 0ee3780 to 05a675d Compare April 28, 2025 23:28

vercel bot deployed to Preview April 28, 2025 23:29 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 05a675d to 0e3a63f Compare April 28, 2025 23:47

vercel bot deployed to Preview April 28, 2025 23:48 View deployment

seriouslag force-pushed the feat/add-nx-plugin-2 branch from 0e3a63f to 223f8f2 Compare April 28, 2025 23:55

vercel bot deployed to Preview April 28, 2025 23:56 View deployment

vercel bot deployed to Preview April 29, 2025 02:56 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor #1947

feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor #1947

seriouslag commented Apr 14, 2025 •

edited

Loading

bolt-new-by-stackblitz bot commented Apr 14, 2025

vercel bot commented Apr 14, 2025 •

edited

Loading

changeset-bot bot commented Apr 14, 2025 •

edited

Loading

codecov bot commented Apr 14, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 14, 2025 •

edited

Loading

seriouslag Apr 14, 2025

seriouslag Apr 14, 2025

mrlubos Apr 14, 2025

seriouslag Apr 15, 2025

mrlubos Apr 15, 2025

seriouslag Apr 14, 2025

seriouslag Apr 14, 2025

seriouslag Apr 14, 2025

seriouslag Apr 14, 2025 •

edited

Loading

seriouslag Apr 14, 2025

seriouslag Apr 14, 2025

Check failure

		@@ -1,7 +1,32 @@
		// This file is auto-generated by @hey-api/openapi-ts

		@@ -0,0 +1,5 @@
		// FAIL LOUDLY on unhandled promise rejections / errors

feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor #1947

Are you sure you want to change the base?

feat(nx-plugin): add NX Plugin with OpenAPI client generator and executor #1947

Conversation

seriouslag commented Apr 14, 2025 • edited Loading

bolt-new-by-stackblitz bot commented Apr 14, 2025

vercel bot commented Apr 14, 2025 • edited Loading

changeset-bot bot commented Apr 14, 2025 • edited Loading

⚠️ No Changeset found

codecov bot commented Apr 14, 2025 • edited Loading

Codecov Report

pkg-pr-new bot commented Apr 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seriouslag Apr 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Check failure

seriouslag commented Apr 14, 2025 •

edited

Loading

vercel bot commented Apr 14, 2025 •

edited

Loading

changeset-bot bot commented Apr 14, 2025 •

edited

Loading

codecov bot commented Apr 14, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 14, 2025 •

edited

Loading

seriouslag Apr 14, 2025 •

edited

Loading