@kubb/core - npm Package Compare versions

Comparing version 3.0.0-beta.3 to 3.0.0-beta.4

dist/index.d.ts

@@ -1,3 +0,3 @@
-import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-C9aZTwst.js';
-export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-C9aZTwst.js';
+import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-Cn8nSj1H.js';
+export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-Cn8nSj1H.js';
 import { L as Logger } from './logger-DvbHXjIO.js';
@@ -4,0 +4,0 @@ import { PossiblePromise } from '@kubb/types';

dist/mocks.d.ts

 import { ResolvedFile, File } from '@kubb/fs/types';
-import { a as PluginManager } from './FileManager-C9aZTwst.js';
+import { a as PluginManager } from './FileManager-Cn8nSj1H.js';
 import { L as Logger } from './logger-DvbHXjIO.js';
@@ -4,0 +4,0 @@ import '@kubb/fs';

package.json

 {
   "name": "@kubb/core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "Generator core",
@@ -86,5 +86,5 @@ "keywords": [
     "semver": "^7.6.3",
-    "@kubb/fs": "3.0.0-beta.3",
-    "@kubb/parser-ts": "3.0.0-beta.3",
-    "@kubb/types": "3.0.0-beta.3"
+    "@kubb/fs": "3.0.0-beta.4",
+    "@kubb/parser-ts": "3.0.0-beta.4",
+    "@kubb/types": "3.0.0-beta.4"
   },
@@ -100,4 +100,4 @@ "devDependencies": {
     "typescript": "^5.6.2",
-    "@kubb/config-ts": "3.0.0-beta.3",
-    "@kubb/config-tsup": "3.0.0-beta.3"
+    "@kubb/config-ts": "3.0.0-beta.4",
+    "@kubb/config-tsup": "3.0.0-beta.4"
   },
@@ -104,0 +104,0 @@ "engines": {

src/types.ts

@@ -7,8 +7,7 @@ import type * as KubbFile from '@kubb/fs/types'
 
-// config
-
 /**
- * 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({
@@ -20,4 +19,3 @@ * ...
   /**
-   * 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()
@@ -27,3 +25,3 @@ */
   /**
-   * 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.
    */
@@ -35,3 +33,3 @@ plugins?: Array<Omit<UnknownUserPlugin, 'context'>>
   /**
-   * 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.
    */
@@ -43,3 +41,3 @@ path: string
   /**
-   * `string` or `object` containing your Swagger/OpenAPI data.
+   * A `string` or `object` that contains your Swagger/OpenAPI data.
    */
@@ -58,7 +56,7 @@ data: string | unknown
   /**
-   * 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()
@@ -68,3 +66,3 @@ */
   /**
-   * 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.
    */
@@ -74,3 +72,4 @@ input: TInput
     /**
-     * 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.
      */
@@ -89,9 +88,9 @@ path: string
     /**
-     * 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'
      */
@@ -311,3 +310,3 @@ barrelType?: BarrelType | false
    * Define what needs to be exported, here you can also disable the export of barrel files
-   * @default `'named'`
+   * @default 'named'
    */
@@ -314,0 +313,0 @@ barrelType?: BarrelType | false

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1467506

increased by0.09%

Lines of code

14385

increased by0.01%

Dependency changes

• + Added@kubb/fs@3.0.0-beta.4(transitive)

• + Added@kubb/parser-ts@3.0.0-beta.4(transitive)

• + Added@kubb/types@3.0.0-beta.4(transitive)

• - Removed@kubb/fs@3.0.0-beta.3(transitive)

• - Removed@kubb/parser-ts@3.0.0-beta.3(transitive)

• - Removed@kubb/types@3.0.0-beta.3(transitive)

• Updated@kubb/fs@3.0.0-beta.4

• Updated@kubb/parser-ts@3.0.0-beta.4

• Updated@kubb/types@3.0.0-beta.4