chore: readme update

kubb-labs · Apr 1, 2024 · 89d865a · 89d865a
1 parent ae6dfe0
commit 89d865a
Show file tree

Hide file tree

Showing 25 changed files with 108 additions and 364 deletions.
diff --git a/assets/features.png b/assets/features.png
diff --git a/configs/setup.ts b/configs/setup.ts
@@ -6,7 +6,7 @@ beforeAll(() => {
   if (globalThis.Bun) {
     /** @type {import('bun:jsc')} */
     const jsc = require('bun:jsc')
-    const http = require('http')
+    const http = require('node:http')
     const source = globalThis.Bun.fileURLToPath(jsc.callerSourceOrigin())
     const bunTest = globalThis.Bun.jest(source)
 

diff --git a/docs/plugins/unplugin/index.md b/docs/plugins/unplugin/index.md
@@ -105,11 +105,11 @@ export default defineConfig({
 
 ```ts
 // vite.config.ts
-import Plugin from 'unplugin-kubb/vite'
+import kubb from 'unplugin-kubb/vite'
 
 export default defineConfig({
   plugins: [
-    Plugin({/* options */}),
+    kubb({/* options */}),
   ],
 })
 ```
@@ -118,11 +118,11 @@ export default defineConfig({
 
 ```ts
 // rollup.config.js
-import Plugin from 'unplugin-kubb/rollup'
+import kubb from 'unplugin-kubb/rollup'
 
 export default {
   plugins: [
-    Plugin({/* options */}),
+    kubb({/* options */}),
   ],
 }
 ```
@@ -170,10 +170,10 @@ module.exports = {
 ```ts
 // esbuild.config.js
 import { build } from 'esbuild'
-import Plugin from 'unplugin-kubb/esbuild'
+import kubb from 'unplugin-kubb/esbuild'
 
 build({
-  plugins: [Plugin()],
+  plugins: [kubb()],
 })
 ```
 

diff --git a/examples/vue-query-v5/kubb.config.js b/examples/vue-query-v5/kubb.config.js
diff --git a/examples/vue-query-v5/package.json b/examples/vue-query-v5/package.json
@@ -16,7 +16,7 @@
     "build": "vite build",
     "clean": "npx rimraf ./dist",
     "dev": "vite",
-    "generate": "kubb generate",
+    "generate": "vite build",
     "start": "tsup --watch",
     "test": "vitest",
     "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
@@ -31,6 +31,7 @@
     "@kubb/swagger-zod": "workspace:*",
     "@tanstack/vue-query": "^5.28.9",
     "axios": "^1.6.8",
+    "unplugin-kubb": "workspace:*",
     "vue": "^3.4.21"
   },
   "devDependencies": {

diff --git a/examples/vue-query-v5/vite.config.ts b/examples/vue-query-v5/vite.config.ts
@@ -1,9 +1,43 @@
+import { definePlugin as createSwagger } from '@kubb/swagger'
+import { definePlugin as createSwaggerTanstackQuery } from '@kubb/swagger-tanstack-query'
+import { definePlugin as createSwaggerTS } from '@kubb/swagger-ts'
 import vue from '@vitejs/plugin-vue'
+import kubb from 'unplugin-kubb/vite'
 import { defineConfig } from 'vite'
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue()],
+  plugins: [
+    vue(),
+    kubb({
+      config: {
+        root: '.',
+        input: {
+          path: './petStore.yaml',
+        },
+        output: {
+          path: './src/gen',
+          clean: true,
+        },
+        plugins: [
+          createSwagger({
+            output: false,
+          }),
+          createSwaggerTS({
+            output: {
+              path: 'models',
+            },
+          }),
+          createSwaggerTanstackQuery({
+            output: {
+              path: './hooks',
+            },
+            framework: 'vue',
+          }),
+        ],
+      },
+    }),
+  ],
   optimizeDeps: {
     include: ['axios'],
   },

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -2,13 +2,7 @@
   "name": "@kubb/cli",
   "version": "2.12.2",
   "description": "Generator cli",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen",
-    "cli"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen", "cli"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -31,13 +25,7 @@
   "bin": {
     "kubb": "bin/kubb.cjs"
   },
-  "files": [
-    "src",
-    "dist",
-    "bin",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "bin", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -2,12 +2,7 @@
   "name": "@kubb/core",
   "version": "2.12.2",
   "description": "Generator core",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -59,32 +54,14 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "utils": [
-        "./dist/utils.d.ts"
-      ],
-      "transformers": [
-        "./dist/transformers.d.ts"
-      ],
-      "logger": [
-        "./dist/logger.d.ts"
-      ],
-      "fs": [
-        "./dist/fs.d.ts"
-      ],
-      "mocks": [
-        "./dist/mocks.d.ts"
-      ]
+      "utils": ["./dist/utils.d.ts"],
+      "transformers": ["./dist/transformers.d.ts"],
+      "logger": ["./dist/logger.d.ts"],
+      "fs": ["./dist/fs.d.ts"],
+      "mocks": ["./dist/mocks.d.ts"]
     }
   },
-  "files": [
-    "src",
-    "dist",
-    "*.d.ts",
-    "*.d.cts",
-    "schema.json",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "*.d.ts", "*.d.cts", "schema.json", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",

diff --git a/packages/kubb/package.json b/packages/kubb/package.json
@@ -2,13 +2,7 @@
   "name": "kubb",
   "version": "2.0.0-beta.2",
   "description": "OpenAPI to TypeScript, React-Query, Zod, Zodios, Faker.js, MSW and Axios.",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen",
-    "cli"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen", "cli"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -24,13 +18,7 @@
   "bin": {
     "kubb": "bin/kubb.js"
   },
-  "files": [
-    "src",
-    "dist",
-    "bin",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "bin", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",

diff --git a/packages/parser/package.json b/packages/parser/package.json
@@ -2,12 +2,7 @@
   "name": "@kubb/parser",
   "version": "2.12.2",
   "description": "Generator parser",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -36,17 +31,10 @@
   "types": "./dist/index.d.cts",
   "typesVersions": {
     "*": {
-      "factory": [
-        "./dist/factory.d.ts"
-      ]
+      "factory": ["./dist/factory.d.ts"]
     }
   },
-  "files": [
-    "src",
-    "dist",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -2,12 +2,7 @@
   "name": "@kubb/react",
   "version": "2.12.2",
   "description": "Generator react",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -51,22 +46,11 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "client": [
-        "./dist/client.d.ts"
-      ],
-      "server": [
-        "./dist/server.d.ts"
-      ]
+      "client": ["./dist/client.d.ts"],
+      "server": ["./dist/server.d.ts"]
     }
   },
-  "files": [
-    "src",
-    "dist",
-    "*.d.ts",
-    "*.d.cts",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "*.d.ts", "*.d.cts", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",

diff --git a/packages/swagger-client/package.json b/packages/swagger-client/package.json
@@ -2,15 +2,7 @@
   "name": "@kubb/swagger-client",
   "version": "2.12.2",
   "description": "Generator swagger-client",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen",
-    "swagger",
-    "openapi",
-    "axios"
-  ],
+  "keywords": ["typescript", "plugins", "kubb", "codegen", "swagger", "openapi", "axios"],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -49,20 +41,10 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "components": [
-        "./dist/components.d.ts"
-      ]
+      "components": ["./dist/components.d.ts"]
     }
   },
-  "files": [
-    "src",
-    "dist",
-    "client.ts",
-    "*.d.ts",
-    "*.d.cts",
-    "!/**/**.test.**",
-    "!/**/__tests__/**"
-  ],
+  "files": ["src", "dist", "client.ts", "*.d.ts", "*.d.cts", "!/**/**.test.**", "!/**/__tests__/**"],
   "scripts": {
     "build": "tsup",
     "clean": "npx rimraf ./dist",