docs: more documentation for client and ts plugin

docs/.vitepress/config.ts

@@ -5,7 +5,6 @@ import { groupIconMdPlugin, groupIconVitePlugin, localIconLoader } from 'vitepre
 import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
 import { SitemapStream } from 'sitemap'
 import { defineConfig } from 'vitepress'
-import { withMermaid } from "vitepress-plugin-mermaid";
 
 import { renderMermaidGraphsPlugin } from './mermaid';
 import { transposeTables } from "./transposeTables.ts"

docs/blog/v3.md

@@ -71,6 +71,9 @@ output: {
 ```
 - Refactor of grouping(use of name instead of output) and output based on `output` of the current plugin
 
+[//]: # (- [`@kubb/plugin-ts`] Removal of `enumType` in favor of `enum.type`)
+
+[//]: # (- [`@kubb/plugin-ts`] Removal of `enumSuffix` in favor of `enum.suffix`)
 
 ## Thanks
 

docs/changelog.md

@@ -29,7 +29,7 @@ export default defineConfig({
       output: {
         path: './clients/axios',
       },
-      group: { type: 'tag', output: './clients/axios/{{tag}}Service' }, // [!code --]
+      // group: { type: 'tag', output: './clients/axios/{{tag}}Service' }, // [!code --]
       group: { type: 'tag', name: ({ group }) => `${group}Service` }, // [!code ++]
     }),
   ],

docs/getting-started/configure.md

@@ -242,14 +242,40 @@ export default defineConfig({
 })
 ```
 
-#### output.exportType
+#### output.extension
+Override the extension to the generated imports and exports, by default the plugin will add an extension.
+
+|           |                          |
+|----------:|:-------------------------|
+|     Type: | `Record<KubbFile.Extname, KubbFile.Extname>`                |
+| Required: | `false`                  |
+|  Default: | `{ '.ts': '.ts'}` |
+
+
+```typescript [kubb.config.ts]
+import { defineConfig } from '@kubb/core'
+
+export default defineConfig({
+  input: {
+    path: './petStore.yaml',
+  },
+  output: {
+    path: './src/gen',
+    extension: {
+      '.ts': '.js',
+    },
+  },
+})
+```
+
+#### output.barrelType
 Define what needs to exported, here you can also disable the export of barrel files.
 
-|           |                                      |
-|----------:|:-------------------------------------|
-|     Type: | `'barrel' \| 'barrelNamed' \| false` |
-| Required: | `false`                              |
-|  Default: | `'barrelNamed'`                      |
+|           |                             |
+|----------:|:----------------------------|
+|     Type: | `'all' \| 'named' \| false` |
+| Required: | `false`                     |
+|  Default: | `'named'`                   |
 
 
 ```typescript [kubb.config.ts]
@@ -262,7 +288,7 @@ export default defineConfig({
   output: {
     path: './src/gen',
     clean: true,
-    exportType: 'barrel',
+    barrelType: 'all',
   },
 })
 ```

docs/package.json

@@ -44,9 +44,9 @@
     "@kubb/plugin-vue-query": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
+    "@mermaid-js/mermaid-cli": "^11.2.0",
     "@types/node": "^20.16.10",
     "@types/react": "^18.3.10",
-    "@mermaid-js/mermaid-cli": "^11.2.0",
     "cross-env": "^7.0.3",
     "react": "^18.3.1",
     "unplugin-kubb": "workspace:^",

docs/plugins/core/barrelTypes.md

@@ -0,0 +1,10 @@
+::: code-group
+```typescript [all]
+export * from "./gen/petService.ts"
+```
+```typescript [named]
+export { PetService } from "./gen/petService.ts"
+```
+```typescript [false]
+```
+:::

docs/plugins/core/exclude.md

@@ -0,0 +1,15 @@
+Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+
+|           |                  |
+|----------:|:-----------------|
+|     Type: | `Array<Exclude>` |
+| Required: | `false`          |
+
+
+```typescript [Exclude]
+export type Exclude = {
+  type: 'tag' | 'operationId' | 'path' | 'method'
+  pattern: string | RegExp
+}
+```
+

docs/plugins/core/group.md

@@ -0,0 +1,26 @@
+Grouping makes it possible to combine files in a folder based on specific `type`.
+
+Imagine you have the following setup:
+
+```typescript
+group: {
+  type: 'tag',
+  name({ group }){
+    return `${group}Controller`
+  }
+}
+```
+That will create a structure like this:
+```
+.
+├── src/
+│   └── petController/
+│   │   ├── addPet.ts
+│   │   └── getPet.ts
+│   └── storeController/
+│       ├── createStore.ts
+│       └── getStoreById.ts
+├── petStore.yaml
+├── kubb.config.ts
+└── package.json
+```

docs/plugins/core/groupTypes.md

@@ -0,0 +1 @@
+- `'tag'`: Use of operation.getTags().at(0)?.name

docs/plugins/core/include.md

@@ -0,0 +1,15 @@
+Array containing include parameters to include tags/operations/methods/paths.
+
+|           |                  |
+|----------:|:-----------------|
+|     Type: | `Array<Include>` |
+| Required: | `false`          |
+
+```typescript [Include]
+export type Include = {
+  type: 'tag' | 'operationId' | 'path' | 'method'
+  pattern: string | RegExp
+}
+```
+
+

docs/plugins/core/override.md

@@ -0,0 +1,15 @@
+Array containing override parameters to override `options` based on tags/operations/methods/paths.
+
+|           |                   |
+|----------:|:------------------|
+|     Type: | `Array<Override>` |
+| Required: | `false`           |
+
+
+```typescript [Override]
+export type Override = {
+  type: 'tag' | 'operationId' | 'path' | 'method'
+  pattern: string | RegExp
+  options: PluginOptions
+}
+```