@kubb/core 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/{FileManager-C9aZTwst.d.ts → FileManager-Cn8nSj1H.d.ts}

@@ -111,34 +111,34 @@ declare class PluginManager {
 }
 
 /**
- * Config used in `kubb.config.js`
+ * Config used in `kubb.config.ts`
  *
- * @example import { defineConfig } from '@kubb/core'
+ * @example
+ * import { defineConfig } from '@kubb/core'
  * export default defineConfig({
  * ...
  * })
  */
 type UserConfig = Omit<Config, 'root' | 'plugins'> & {
     /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root?: string;
     /**
-     * Plugin type should be a Kubb plugin
+     * An array of Kubb plugins used for generation. Each plugin may have additional configurable options (defined within the plugin itself). If a plugin relies on another plugin, an error will occur if the required dependency is missing. Refer to “pre” for more details.
      */
     plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
-     * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
+     * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
      */
     path: string;
 };
 type InputData = {
     /**
-     * `string` or `object` containing your Swagger/OpenAPI data.
+     * A `string` or `object` that contains your Swagger/OpenAPI data.
      */
     data: string | unknown;
 };
@@ -149,21 +149,22 @@ type BarrelType = 'all' | 'named';
  */
 type Config<TInput = Input> = {
     /**
-     * Optional config name to show in CLI output
+     * The name to display in the CLI output.
      */
     name?: string;
     /**
-     * Project root directory. This can be an absolute path or a path relative to the location of your `kubb.config.ts` file.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root: string;
     /**
-     * You can use `input.path` or `input.data` depending on the needs you have.
+     * You can use either `input.path` or `input.data`, depending on your specific needs.
      */
     input: TInput;
     output: {
         /**
-         * The path where all generated files will be exported. This can be an absolute path or a path relative to the specified root option.
+         * The path where all generated files will be exported.
+         * This can be an absolute path or a path relative to the specified root option.
          */
         path: string;
         /**
@@ -176,13 +177,13 @@ type Config<TInput = Input> = {
          */
         write?: boolean;
         /**
-         * Override the extension to the generated imports and exports, by default the plugin will add an extension
-         * @default `{ '.ts': '.ts'}`
+         * Override the extension to the generated imports and exports, by default each plugin will add an extension
+         * @default { '.ts': '.ts'}
          */
         extension?: Record<KubbFile.Extname, KubbFile.Extname>;
         /**
-         * Define what needs to exported, here you can also disable the export of barrel files.
-         * @default `'named'`
+         * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+         * @default 'named'
          */
         barrelType?: BarrelType | false;
     };
@@ -368,7 +369,7 @@ type Output = {
     path: string;
     /**
      * Define what needs to be exported, here you can also disable the export of barrel files
-     * @default `'named'`
+     * @default 'named'
      */
     barrelType?: BarrelType | false;
     /**

package/dist/{FileManager-ibNoWwHN.d.cts → FileManager-DKZ30qz_.d.cts}

@@ -111,34 +111,34 @@ declare class PluginManager {
 }
 
 /**
- * Config used in `kubb.config.js`
+ * Config used in `kubb.config.ts`
  *
- * @example import { defineConfig } from '@kubb/core'
+ * @example
+ * import { defineConfig } from '@kubb/core'
  * export default defineConfig({
  * ...
  * })
  */
 type UserConfig = Omit<Config, 'root' | 'plugins'> & {
     /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root?: string;
     /**
-     * Plugin type should be a Kubb plugin
+     * An array of Kubb plugins used for generation. Each plugin may have additional configurable options (defined within the plugin itself). If a plugin relies on another plugin, an error will occur if the required dependency is missing. Refer to “pre” for more details.
      */
     plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
-     * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
+     * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
      */
     path: string;
 };
 type InputData = {
     /**
-     * `string` or `object` containing your Swagger/OpenAPI data.
+     * A `string` or `object` that contains your Swagger/OpenAPI data.
      */
     data: string | unknown;
 };
@@ -149,21 +149,22 @@ type BarrelType = 'all' | 'named';
  */
 type Config<TInput = Input> = {
     /**
-     * Optional config name to show in CLI output
+     * The name to display in the CLI output.
      */
     name?: string;
     /**
-     * Project root directory. This can be an absolute path or a path relative to the location of your `kubb.config.ts` file.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root: string;
     /**
-     * You can use `input.path` or `input.data` depending on the needs you have.
+     * You can use either `input.path` or `input.data`, depending on your specific needs.
      */
     input: TInput;
     output: {
         /**
-         * The path where all generated files will be exported. This can be an absolute path or a path relative to the specified root option.
+         * The path where all generated files will be exported.
+         * This can be an absolute path or a path relative to the specified root option.
          */
         path: string;
         /**
@@ -176,13 +177,13 @@ type Config<TInput = Input> = {
          */
         write?: boolean;
         /**
-         * Override the extension to the generated imports and exports, by default the plugin will add an extension
-         * @default `{ '.ts': '.ts'}`
+         * Override the extension to the generated imports and exports, by default each plugin will add an extension
+         * @default { '.ts': '.ts'}
          */
         extension?: Record<KubbFile.Extname, KubbFile.Extname>;
         /**
-         * Define what needs to exported, here you can also disable the export of barrel files.
-         * @default `'named'`
+         * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
+         * @default 'named'
          */
         barrelType?: BarrelType | false;
     };
@@ -368,7 +369,7 @@ type Output = {
     path: string;
     /**
      * Define what needs to be exported, here you can also disable the export of barrel files
-     * @default `'named'`
+     * @default 'named'
      */
     barrelType?: BarrelType | false;
     /**

package/dist/{chunk-KXT7F2WS.cjs → chunk-2JGRDU6N.cjs}

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunk72BWXKV4_cjs = require('./chunk-72BWXKV4.cjs');
+var chunkYEWLGG6A_cjs = require('./chunk-YEWLGG6A.cjs');
 var util = require('util');
 var path = require('path');
 var tty = require('tty');
@@ -30,7 +30,7 @@ var tty__namespace = /*#__PURE__*/_interopNamespace(tty);
 var process$1__default = /*#__PURE__*/_interopDefault(process$1);
 
 // ../../node_modules/.pnpm/consola@3.2.3/node_modules/consola/dist/core.mjs
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 var LogLevels = {
   silent: Number.NEGATIVE_INFINITY,
   fatal: 0,
@@ -433,7 +433,7 @@ function createConsola(options = {}) {
 }
 
 // ../../node_modules/.pnpm/consola@3.2.3/node_modules/consola/dist/shared/consola.06ad8a64.mjs
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function parseStack(stack) {
   const cwd = process.cwd() + path.sep;
   const lines = stack.split("\n").splice(1).map((l) => l.trim().replace("file://", "").replace(cwd, ""));
@@ -491,7 +491,7 @@ var BasicReporter = class {
 };
 
 // ../../node_modules/.pnpm/consola@3.2.3/node_modules/consola/dist/utils.mjs
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 var {
   env = {},
   argv = [],
@@ -723,7 +723,7 @@ function box(text, _opts = {}) {
 }
 
 // ../../node_modules/.pnpm/consola@3.2.3/node_modules/consola/dist/shared/consola.36c0034f.mjs
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 var providers = [
   ["APPVEYOR"],
   ["AZURE_PIPELINES", "SYSTEM_TEAMFOUNDATIONCOLLECTIONURI"],
@@ -1061,7 +1061,7 @@ function createConsola2(options = {}) {
     defaults: { level },
     stdout: process.stdout,
     stderr: process.stderr,
-    prompt: (...args) => import('./prompt-FODZPXQF.cjs').then((m) => m.prompt(...args)),
+    prompt: (...args) => import('./prompt-NXAVVYGK.cjs').then((m) => m.prompt(...args)),
     reporters: options.reporters || [
       options.fancy ?? !(isCI2 || isTest) ? new FancyReporter() : new BasicReporter()
     ],
@@ -1084,5 +1084,5 @@ exports.colors = colors;
 exports.createConsola = createConsola2;
 exports.getDefaultExportFromCjs = getDefaultExportFromCjs;
 exports.isUnicodeSupported = isUnicodeSupported;
-//# sourceMappingURL=chunk-KXT7F2WS.cjs.map
-//# sourceMappingURL=chunk-KXT7F2WS.cjs.map
+//# sourceMappingURL=chunk-2JGRDU6N.cjs.map
+//# sourceMappingURL=chunk-2JGRDU6N.cjs.map