@kubb/core - npm Package Compare versions

Comparing version 3.0.0-alpha.20 to 3.0.0-alpha.21

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-DQtWE_rp.js';
-export { d as FileMetaBase, G as GetPluginFactoryOptions, e as InputData, O as Output, i as Plugin, n as PluginCache, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, o as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-DQtWE_rp.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-CdXrquQt.js';
+export { d as FileMetaBase, G as GetPluginFactoryOptions, e as InputData, O as Output, i as Plugin, n as PluginCache, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, o as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-CdXrquQt.js';
 import { L as Logger } from './logger-DvbHXjIO.js';
@@ -53,5 +53,3 @@ import { PossiblePromise } from '@kubb/types';
 /**
- * Type helper to make it easier to use kubb.config.js
- * accepts a direct {@link Config} object, or a function that returns it.
- * The function receives a {@link ConfigEnv} object that exposes two properties:
+ * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.
  */
@@ -58,0 +56,0 @@ declare function defineConfig(options: PossiblePromise<UserConfig | Array<UserConfig>> | ((

dist/mocks.d.ts

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

dist/transformers.js

@@ -35,2 +35,3 @@ import { transformReservedWord } from './chunk-2EU7DMPM.js';
         return `\\${character}`;
+      // Four possible LineTerminator characters need to be escaped:
       case "\n":
@@ -37,0 +38,0 @@ return "\\n";

package.json

 {
   "name": "@kubb/core",
-  "version": "3.0.0-alpha.20",
+  "version": "3.0.0-alpha.21",
   "description": "Generator core",
@@ -83,8 +83,8 @@ "keywords": [
     "p-queue": "^8.0.1",
-    "remeda": "^2.12.1",
+    "remeda": "^2.14.0",
     "seedrandom": "^3.0.5",
     "semver": "^7.6.3",
-    "@kubb/fs": "3.0.0-alpha.20",
-    "@kubb/parser-ts": "3.0.0-alpha.20",
-    "@kubb/types": "3.0.0-alpha.20"
+    "@kubb/fs": "3.0.0-alpha.21",
+    "@kubb/parser-ts": "3.0.0-alpha.21",
+    "@kubb/types": "3.0.0-alpha.21"
   },
@@ -98,6 +98,6 @@ "devDependencies": {
     "tinyrainbow": "^1.2.0",
-    "tsup": "^8.2.4",
+    "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@kubb/config-ts": "3.0.0-alpha.20",
-    "@kubb/config-tsup": "3.0.0-alpha.20"
+    "@kubb/config-ts": "3.0.0-alpha.21",
+    "@kubb/config-tsup": "3.0.0-alpha.21"
   },
@@ -104,0 +104,0 @@ "engines": {

src/config.ts

@@ -32,5 +32,3 @@ import type { PossiblePromise } from '@kubb/types'
 /**
- * Type helper to make it easier to use kubb.config.js
- * accepts a direct {@link Config} object, or a function that returns it.
- * The function receives a {@link ConfigEnv} object that exposes two properties:
+ * Type helper to make it easier to use vite.config.ts accepts a direct UserConfig object, or a function that returns it. The function receives a ConfigEnv object.
  */
@@ -37,0 +35,0 @@ export function defineConfig(

src/types.ts

@@ -32,3 +32,3 @@ import type * as KubbFile from '@kubb/fs/types'
   /**
-   * Path to be used as the input. This can be an absolute path or a path relative to the `root`.
+   * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
    */
@@ -40,3 +40,3 @@ path: string
   /**
-   * `string` or `object` containing the data.
+   * `string` or `object` containing your Swagger/OpenAPI data.
    */
@@ -57,21 +57,21 @@ data: string | unknown
   /**
-   * Project root directory. Can be an absolute path, or a path relative from
-   * the location of the config file itself.
+   * Project root directory. This can be 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.
+   */
   input: TInput
   output: {
     /**
-     * Path to be used to export all generated files.
-     * This can be an absolute path, or a path relative based of the defined `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
     /**
-     * Clean output directory before each build.
+     * Clean the output directory before each build.
      */
     clean?: boolean
     /**
-     * Write files to the fileSystem
-     * This is being used for the playground.
+     * Save files to the file system.
      * @default true
@@ -81,3 +81,3 @@ */
     /**
-     * Define what needs to exported, here you can also disable the export of barrel files
+     * Define what needs to exported, here you can also disable the export of barrel files.
      * @default `'barrelNamed'`
@@ -88,5 +88,5 @@ */
   /**
-   * Array of Kubb plugins to use.
-   * The plugin/package can forsee some options that you need to pass through.
-   * Sometimes a plugin is depended on another plugin, if that's the case you will get an error back from the plugin you installed.
+   * An array of Kubb plugins that will be used in the generation.
+   * Each plugin may include additional configurable options(defined in the plugin itself).
+   * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details.
    */
@@ -305,9 +305,9 @@ plugins?: Array<Plugin>
   /**
+   * Add a banner text in the beginning of every file
+   */
+  banner?: string
+  /**
    * Add a footer text in the beginning of every file
    */
   footer?: string
-  /**
-   * Add a banner text in the beginning of every file
-   */
-  banner?: string
 }

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

1473865

increased by0.02%

Worsened metrics

Lines of code

14501

decreased by-0.01%

Dependency changes

• + Added@kubb/fs@3.0.0-alpha.21(transitive)

• + Added@kubb/parser-ts@3.0.0-alpha.21(transitive)

• + Added@kubb/types@3.0.0-alpha.21(transitive)

• - Removed@kubb/fs@3.0.0-alpha.20(transitive)

• - Removed@kubb/parser-ts@3.0.0-alpha.20(transitive)

• - Removed@kubb/types@3.0.0-alpha.20(transitive)

• Updated@kubb/fs@3.0.0-alpha.21

• Updated@kubb/parser-ts@3.0.0-alpha.21

• Updated@kubb/types@3.0.0-alpha.21

• Updatedremeda@^2.14.0