@kubb/plugin-msw 0.0.0-canary-20241104172400

package/src/plugin.ts

@@ -0,0 +1,104 @@
+import path from 'node:path'
+
+import { FileManager, type Group, PluginManager, createPlugin } from '@kubb/core'
+import { camelCase } from '@kubb/core/transformers'
+import { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'
+
+import { pluginFakerName } from '@kubb/plugin-faker'
+import { pluginTsName } from '@kubb/plugin-ts'
+
+import type { Plugin } from '@kubb/core'
+import type { PluginOas as SwaggerPluginOptions } from '@kubb/plugin-oas'
+import { handlersGenerator, mswGenerator } from './generators'
+import type { PluginMsw } from './types.ts'
+
+export const pluginMswName = 'plugin-msw' satisfies PluginMsw['name']
+
+export const pluginMsw = createPlugin<PluginMsw>((options) => {
+  const {
+    output = { path: 'handlers', barrelType: 'named' },
+    group,
+    exclude = [],
+    include,
+    override = [],
+    transformers = {},
+    handlers = false,
+    parser = 'data',
+    generators = [mswGenerator, handlers ? handlersGenerator : undefined].filter(Boolean),
+  } = options
+
+  return {
+    name: pluginMswName,
+    options: {
+      output,
+      parser,
+    },
+    pre: [pluginOasName, pluginTsName, parser === 'faker' ? pluginFakerName : undefined].filter(Boolean),
+    resolvePath(baseName, pathMode, options) {
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))
+
+      if (options?.tag && group?.type === 'tag') {
+        const groupName: Group['name'] = group?.name ? group.name : (ctx) => `${ctx.group}Controller`
+
+        return path.resolve(root, output.path, groupName({ group: camelCase(options.tag) }), baseName)
+      }
+
+      if (mode === 'single') {
+        /**
+         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
+         * Other plugins then need to call addOrAppend instead of just add from the fileManager class
+         */
+        return path.resolve(root, output.path)
+      }
+
+      return path.resolve(root, output.path, baseName)
+    },
+    resolveName(name, type) {
+      const resolvedName = camelCase(name, {
+        suffix: type ? 'handler' : undefined,
+        isFile: type === 'file',
+      })
+
+      if (type) {
+        return transformers?.name?.(resolvedName, type) || resolvedName
+      }
+
+      return resolvedName
+    },
+    async buildStart() {
+      const [swaggerPlugin]: [Plugin<SwaggerPluginOptions>] = PluginManager.getDependedPlugins<SwaggerPluginOptions>(this.plugins, [pluginOasName])
+
+      const oas = await swaggerPlugin.context.getOas()
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const mode = FileManager.getMode(path.resolve(root, output.path))
+
+      const operationGenerator = new OperationGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType: swaggerPlugin.context.contentType,
+        exclude,
+        include,
+        override,
+        mode,
+      })
+
+      const files = await operationGenerator.build(...generators)
+      await this.addFile(...files)
+
+      const barrelFiles = await this.fileManager.getBarrelFiles({
+        type: output.barrelType ?? 'named',
+        root,
+        output,
+        files: this.fileManager.files,
+        meta: {
+          pluginKey: this.plugin.key,
+        },
+        logger: this.logger,
+      })
+
+      await this.addFile(...barrelFiles)
+    },
+  }
+})

package/src/types.ts

@@ -0,0 +1,55 @@
+import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+
+import type { Exclude, Generator, Include, Override, ResolvePathOptions } from '@kubb/plugin-oas'
+
+export type Options = {
+  /**
+   * Specify the export location for the files and define the behavior of the output
+   * @default { path: 'mocks', barrelType: 'named' }
+   */
+  output?: Output
+  /**
+   * Group the MSW mocks based on the provided name.
+   */
+  group?: Group
+  /**
+   * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+   */
+  exclude?: Array<Exclude>
+  /**
+   * Array containing include parameters to include tags/operations/methods/paths.
+   */
+  include?: Array<Include>
+  /**
+   * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+   */
+  override?: Array<Override<ResolvedOptions>>
+  transformers?: {
+    /**
+     * Customize the names based on the type that is provided by the plugin.
+     */
+    name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
+  }
+  /**
+   * Create `handlers.ts` file with all handlers grouped by methods.
+   * @default false
+   */
+  handlers?: boolean
+  /**
+   * Which parser should be used before returning the data to the `Response` of MSW.
+   *  - `'faker'` will use `@kubb/plugin-faker` to generate the data for the response
+   *  - `'data'` will use your custom data to generate the data for the response
+   * @default 'data'
+   */
+  parser?: 'data' | 'faker'
+  /**
+   * Define some generators next to the msw generators
+   */
+  generators?: Array<Generator<PluginMsw>>
+}
+type ResolvedOptions = {
+  output: Output
+  parser: NonNullable<Options['parser']>
+}
+
+export type PluginMsw = PluginFactoryOptions<'plugin-msw', Options, ResolvedOptions, never, ResolvePathOptions>