kubb 5.0.0-beta.33 → 5.0.0-beta.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -20
- package/package.json +11 -10
package/README.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<h1>kubb</h1>
|
|
3
2
|
<a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
|
|
4
|
-
<img
|
|
3
|
+
<img src="https://kubb.dev/og.png" alt="Kubb banner">
|
|
5
4
|
</a>
|
|
6
5
|
|
|
7
6
|
[![npm version][npm-version-src]][npm-version-href]
|
|
@@ -10,10 +9,6 @@
|
|
|
10
9
|
[![License][license-src]][license-href]
|
|
11
10
|
[![Sponsors][sponsors-src]][sponsors-href]
|
|
12
11
|
|
|
13
|
-
### The meta framework for code generation
|
|
14
|
-
|
|
15
|
-
Point Kubb at an OpenAPI spec and it generates types, clients, hooks, validators, mocks, and more.
|
|
16
|
-
|
|
17
12
|
<h4>
|
|
18
13
|
<a href="https://kubb.dev" target="_blank">Documentation</a>
|
|
19
14
|
<span> · </span>
|
|
@@ -25,6 +20,12 @@ Point Kubb at an OpenAPI spec and it generates types, clients, hooks, validators
|
|
|
25
20
|
|
|
26
21
|
<br />
|
|
27
22
|
|
|
23
|
+
# Kubb
|
|
24
|
+
|
|
25
|
+
### The meta framework for code generation
|
|
26
|
+
|
|
27
|
+
Point Kubb at an OpenAPI spec and it generates types, clients, hooks, validators, mocks, and more.
|
|
28
|
+
|
|
28
29
|
## Installation
|
|
29
30
|
|
|
30
31
|
```bash
|
|
@@ -53,19 +54,22 @@ See the [documentation](https://kubb.dev) for detailed usage and advanced featur
|
|
|
53
54
|
|
|
54
55
|
## Features
|
|
55
56
|
|
|
56
|
-
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
-
|
|
61
|
-
- JSX-based renderer (`@kubb/renderer-jsx`) for
|
|
62
|
-
-
|
|
57
|
+
- Generate from a spec: point Kubb at an OpenAPI document and it produces TypeScript types, type-safe API clients, [TanStack Query](https://github.com/TanStack/query) hooks for React and Vue, [SWR](https://github.com/vercel/swr) hooks, [Zod](https://github.com/colinhacks/zod) validators, [Faker](https://github.com/faker-js/faker) mocks, and [MSW](https://github.com/mswjs/msw) handlers.
|
|
58
|
+
- Read Swagger 2.0, OpenAPI 3.0, and 3.1, with TypeScript-first output that runs on Node.js and Bun.
|
|
59
|
+
- Pick what you generate from the [plugin ecosystem](https://github.com/kubb-labs/kubb-plugins): `plugin-ts`, `plugin-client`, `plugin-react-query`, `plugin-vue-query`, `plugin-swr`, `plugin-zod`, `plugin-faker`, `plugin-msw`, `plugin-cypress`, `plugin-redoc`, and `plugin-mcp`. Enable only the ones a project needs.
|
|
60
|
+
- Choose your HTTP client: use the axios or fetch presets, or point at a custom client module so generated requests run through your own wrapper.
|
|
61
|
+
- Control the generated tree: group files by tag, emit barrel exports, and include or exclude operations to keep the output focused.
|
|
62
|
+
- Build your own output with custom plugins, composable middleware, and the JSX-based renderer (`@kubb/renderer-jsx`) for full control over what lands on disk.
|
|
63
|
+
- Hook into your bundler with `unplugin-kubb`, which runs generation inside [Vite](https://github.com/vitejs/vite), [Nuxt](https://github.com/nuxt/nuxt), [Astro](https://github.com/withastro/astro), [webpack](https://github.com/webpack/webpack), and other build tools.
|
|
64
|
+
- Drive generation from AI tools through the built-in Model Context Protocol (MCP) server, which works with [Claude](https://claude.ai), [Cursor](https://cursor.sh), and other MCP-compatible assistants.
|
|
65
|
+
- Generate from inside [Claude Code](https://kubb.dev/docs/5.x/ai/claude) with the Kubb plugin, which adds slash commands, a config skill, and an agent that run the Kubb CLI.
|
|
63
66
|
|
|
64
67
|
## Supporting Kubb
|
|
65
68
|
|
|
66
|
-
Kubb is an open source project
|
|
69
|
+
Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:
|
|
67
70
|
|
|
68
71
|
- [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
|
|
72
|
+
- [See sponsorship tiers and our sponsors](https://kubb.dev/sponsors)
|
|
69
73
|
|
|
70
74
|
<p align="center">
|
|
71
75
|
<a href="https://github.com/sponsors/stijnvanhulle">
|
|
@@ -73,6 +77,16 @@ Kubb is an open source project with its ongoing development made possible entire
|
|
|
73
77
|
</a>
|
|
74
78
|
</p>
|
|
75
79
|
|
|
80
|
+
## Contributing
|
|
81
|
+
|
|
82
|
+
We welcome contributions that help improve Kubb. A few ways to get involved:
|
|
83
|
+
|
|
84
|
+
- Found a bug? File it in the [issue tracker](https://github.com/kubb-labs/kubb/issues).
|
|
85
|
+
- Have an idea to improve Kubb? [Open an issue](https://github.com/kubb-labs/kubb/issues/new) to share it.
|
|
86
|
+
- Need help? Ask the community on [Discord](https://discord.gg/4dQjA6vrWX).
|
|
87
|
+
|
|
88
|
+
See [CONTRIBUTING.md](https://github.com/kubb-labs/kubb/blob/main/CONTRIBUTING.md) for the project structure, local setup, and commands.
|
|
89
|
+
|
|
76
90
|
## Contributors [![Contributors][contributors-src]][contributors-href]
|
|
77
91
|
|
|
78
92
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
@@ -160,15 +174,11 @@ Kubb is an open source project with its ongoing development made possible entire
|
|
|
160
174
|
|
|
161
175
|
## License
|
|
162
176
|
|
|
163
|
-
Most of this repository is licensed under the [MIT License](./licenses/LICENSE-MIT), Copyright © 2025 [Stijn Van Hulle](https://stijnvanhulle.be).
|
|
164
|
-
under AGPL-3.0-or-later.
|
|
165
|
-
|
|
166
|
-
- **Most packages** — [MIT](./licenses/LICENSE-MIT)
|
|
167
|
-
- **`@kubb/agent`** — [AGPL-3.0-or-later](./licenses/LICENSE-AGPL-3.0)
|
|
177
|
+
Most of this repository is licensed under the [MIT License](./licenses/LICENSE-MIT), Copyright © 2025 [Stijn Van Hulle](https://stijnvanhulle.be). Most packages use [MIT](./licenses/LICENSE-MIT), and `@kubb/agent` uses [AGPL-3.0-or-later](./licenses/LICENSE-AGPL-3.0).
|
|
168
178
|
|
|
169
179
|
See [LICENSE](./LICENSE) for details.
|
|
170
180
|
|
|
171
|
-
## Star
|
|
181
|
+
## Star history
|
|
172
182
|
|
|
173
183
|
<a href="https://star-history.com/#kubb-labs/kubb&Date">
|
|
174
184
|
<picture>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kubb",
|
|
3
|
-
"version": "5.0.0-beta.
|
|
3
|
+
"version": "5.0.0-beta.35",
|
|
4
4
|
"description": "Meta-package and entry point for Kubb — a plugin-based code generation framework for OpenAPI. Includes defineConfig, all public APIs, and serves as the gateway to the entire Kubb ecosystem.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"api-client",
|
|
@@ -54,21 +54,21 @@
|
|
|
54
54
|
"registry": "https://registry.npmjs.org/"
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"@kubb/adapter-oas": "5.0.0-beta.
|
|
58
|
-
"@kubb/cli": "5.0.0-beta.
|
|
59
|
-
"@kubb/
|
|
60
|
-
"@kubb/mcp": "5.0.0-beta.
|
|
61
|
-
"@kubb/
|
|
62
|
-
"@kubb/parser-md": "5.0.0-beta.
|
|
63
|
-
"@kubb/parser-ts": "5.0.0-beta.
|
|
64
|
-
"@kubb/renderer-jsx": "5.0.0-beta.
|
|
57
|
+
"@kubb/adapter-oas": "5.0.0-beta.35",
|
|
58
|
+
"@kubb/cli": "5.0.0-beta.35",
|
|
59
|
+
"@kubb/middleware-barrel": "5.0.0-beta.35",
|
|
60
|
+
"@kubb/mcp": "5.0.0-beta.35",
|
|
61
|
+
"@kubb/core": "5.0.0-beta.35",
|
|
62
|
+
"@kubb/parser-md": "5.0.0-beta.35",
|
|
63
|
+
"@kubb/parser-ts": "5.0.0-beta.35",
|
|
64
|
+
"@kubb/renderer-jsx": "5.0.0-beta.35"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
67
|
"typescript": "^6.0.3",
|
|
68
68
|
"@internals/utils": "0.0.0"
|
|
69
69
|
},
|
|
70
70
|
"peerDependencies": {
|
|
71
|
-
"@kubb/agent": "5.0.0-beta.
|
|
71
|
+
"@kubb/agent": "5.0.0-beta.35"
|
|
72
72
|
},
|
|
73
73
|
"peerDependenciesMeta": {
|
|
74
74
|
"@kubb/agent": {
|
|
@@ -93,6 +93,7 @@
|
|
|
93
93
|
"lint:fix": "oxlint --fix .",
|
|
94
94
|
"release": "pnpm publish --no-git-check",
|
|
95
95
|
"release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
|
|
96
|
+
"release:stage": "pnpm stage publish --no-git-check",
|
|
96
97
|
"start": "tsdown --watch",
|
|
97
98
|
"test": "vitest --passWithNoTests",
|
|
98
99
|
"typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
|