Kubb v3 ideas

[stijnvanhulle]

I am already thinking about the next version of Kubb and what should be done to make it better:

• Create sponsorship page and readme
• Use the same naming for all plugins: @kubb/plugin-ts instead of @kubb/swagger-ts
• Drop support of Zodios
• Progressbar for the writing of files
• Progressbar for the hooks of a KubbPlugin(buildStart, buildEnd, ...)
• Enabled for react-query, vue-query, solid-query, svelte-query #1263
• Better debug logs(kubb-files.log and kubb.log) Feat/logging and debugging #1171
• Split up @kubb/swagger-tanstack-query and use separate packages per framework(react, vite, solid, svelte) #1152
• Refactor all plugin.ts files to be cleaner and easier to work with #1153
• Removing generic overrides like transform, resolveId and writeFile
• Introduction of global output.exportType to customize root barrel generation
• ouput options as part of every Kubb plugin
• Validate extName
• enumType asPascalConst marked as deprecated
• Support discriminators  #1121
• Refactor of FileManager and removal of directory-tree(in memory generation of barrel files) #1154
• Fix barrel named files(export * from)
• exportType barrelNamed as default instead of barrel
• Export files in group(use of tags) #1155
• Fixed order for exports and imports #1156
• Cleanup of the templates and provide an easier API #1157
• Documentation for internal plugins(FileManager, BarrelManager) #1158
• Connect @kubb/react to the react-devtools to easily debug changes when generating files(next to having logs) #1149
• Better docs examples with https://codehike.org/docs
• header/footer banner option to add extra text on every file #1186
• HttpMethod uppercase for @kubb/plugin-client #1189
• Generate mutationKeys for useMutation hooks #1102
• Expose queryKey and mutationKey for the SWR plugin #1248
• TypeScipt Strict
• Use of data object for mutations
• Cancel queries(signal) with https://tanstack.com/query/latest/docs/framework/react/guides/query-cancellation #1262
• Pass data to MSW handlers, like the create fake data functions. #1114
• Improve grouping by tag
• Allow specifying which types to coerce [plugin-zod] #1281
• Request an option: function object-style parameters. #1195
• Disable useQuery generation

https://rollupjs.org/plugin-development/#banner
https://unplugin.unjs.io/guide
https://coolify.io/docs/knowledge-base/faq

[dir]

On your note of

"Use of the same naming for all plugins: @kubb/plugin-ts instead of @kubb/swagger-ts, prefix plugin is important here."

In a similar vein, I strongly feel that the use of "swagger" anywhere should be vaulted and replaced with openapi.

I know it seems small, but seeing swagger used instead of openapi gives off a strong "stuck in the past" vibe, for an otherwise such modern and forward thinking library.

[1saifj]

react-form-hook?

[joakimstrandell]

@stijnvanhulle Will it be possible to set the basePath for the client dynamically in v3? Would be a dealbreaker if you could set the basePath at runtime, not at generation.

[stijnvanhulle]

@joakimstrandell Today(in v2 and v3) you can use serverIndex to set the baseUrl: https://www.kubb.dev/plugins/plugin-oas/#serverindex. Other plugins like the @kubb/plugin-client and @kubb/plugin-react-query will use that config to set the baseURL, would that be enough or what do you mean with dynamically?

[joakimstrandell]

@stijnvanhulle I mean that I would like to set the path in the client during runtime, for example using some type of custom config. If I would use the server index I need to select the path when generating the client, if I understand the documentation correctly.

For example in hey-api you can set the base url like this:

import { client } from 'api';
import { config } from  'data' // custom

client.setConfig({
  baseUrl: config.api.basePath,
  headers: {
    Authorization: '...',
    'X-Csrftoken': '...',
  },
});

[stijnvanhulle]

@joakimstrandell I updated the default client to also have getConfig and setConfig but in Kubb you can also override the default client. This means you can do whatever you want so long you are following the guideline where the parameters are having the same shape as RequestConfig.

type RequestConfig<TData = unknown> = {
  baseURL?: string
  url?: string
  method: 'GET' | 'PUT' | 'PATCH' | 'POST' | 'DELETE' | 'OPTIONS'
  params?: unknown
  data?: TData | FormData
  responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream'
  signal?: AbortSignal
  headers?: AxiosRequestConfig['headers']
}

[RabbitShare]

Transform snake_case to camelCase in generated code. Transform camelCase to snake_case before request

[stijnvanhulle]

@RabbitShare For that I suggest using https://github.com/thim81/openapi-format

[CHE1RON]

I cannot find any resource (issue, discussion) on why asPascalConst is being deprecated .. ? 🤔

[stijnvanhulle]

@CHE1RON
Imagine you have the following enums being generated:

export const AddPetRequestStatusEnum = {
  available: 'available',
  pending: 'pending',
  sold: 'sold',
} as const
export type AddPetRequestStatusEnum = (typeof AddPetRequestStatusEnum)[keyof typeof AddPetRequestStatusEnum]

And having the following barrel file:

export type { AddPetRequestStatusEnum } from './AddPetRequest.js'
export { AddPetRequestStatusEnum } from './AddPetRequest.js'

This will throw some errors in TypeScript(Duplicate identifier) which also makes it not usable anymore, that was the reason behind making it deprecated and now with v3 removing it.

[stijnvanhulle]

Completing the migration guide before the v3 release: https://v3.kubb.dev/migration-guide. No additional features planned, only bug fixes until the release of v3.