@kubb/core 5.3.5 → 5.3.6

package/README.md

@@ -38,6 +38,12 @@ pnpm add @kubb/core
 npm install @kubb/core
 ```
 
+## Cancellation
+
+`createKubb` accepts an `AbortSignal`. The engine checks it before setup, while it parses input and
+normalizes plugins, and before each generated-file write. Plugin authors receive the same signal in
+their generator context when they need to stop their own asynchronous work.
+
 ## Supporting Kubb
 
 Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:

package/dist/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_usingCtx = require("./usingCtx-CBWq26N5.cjs");
+const require_usingCtx = require("./usingCtx-DOy3BJPz.cjs");
 let node_async_hooks = require("node:async_hooks");
 let node_util = require("node:util");
 let node_process = require("node:process");
@@ -127,7 +127,7 @@ function formatMs(ms) {
 /**
 * Docs major version, derived from the package version so the link tracks the published major.
 */
-const docsMajor = "5.3.5".split(".")[0] ?? "5";
+const docsMajor = "5.3.6".split(".")[0] ?? "5";
 /**
 * Builds a type guard that narrows a {@link Diagnostic} to the variant for `kind`. A diagnostic
 * with no `kind` is treated as a `problem`.
@@ -459,9 +459,15 @@ var Diagnostics = class Diagnostics {
 		let infos = 0;
 		for (const diagnostic of diagnostics) {
 			if (!isProblem(diagnostic)) continue;
-			if (diagnostic.severity === "error") errors += 1;
-			else if (diagnostic.severity === "warning") warnings += 1;
-			else infos += 1;
+			if (diagnostic.severity === "error") {
+				errors += 1;
+				continue;
+			}
+			if (diagnostic.severity === "warning") {
+				warnings += 1;
+				continue;
+			}
+			infos += 1;
 		}
 		return {
 			errors,
@@ -1025,9 +1031,7 @@ var Resolver = class Resolver {
 		];
 		if (config.output.defaultBanner !== "simple") {
 			const input = config.input;
-			let source = "";
-			if (typeof input === "string") source = getInputKind(input) === "inline" ? "text content" : node_path.default.basename(input);
-			else if (input) source = "text content";
+			const source = typeof input === "string" ? getInputKind(input) === "inline" ? "text content" : node_path.default.basename(input) : input ? "text content" : "";
 			if (source) lines.push(`* Source: ${source}`);
 			if (title) lines.push(`* Title: ${title}`);
 			if (version) lines.push(`* OpenAPI spec version: ${version}`);
@@ -1258,6 +1262,7 @@ var KubbDriver = class {
 	* so `run` can parse it later.
 	*/
 	async setup() {
+		this.options.signal?.throwIfAborted();
 		const normalized = this.#sortPlugins(this.config.plugins.map((rawPlugin) => {
 			return {
 				name: rawPlugin.name,
@@ -1312,7 +1317,8 @@ var KubbDriver = class {
 	*/
 	async #parseInput() {
 		if (this.inputNode || !this.adapter || !this.#adapterSource) return;
-		this.inputNode = await this.adapter.parse(this.#adapterSource);
+		this.options.signal?.throwIfAborted();
+		this.inputNode = await this.adapter.parse(this.#adapterSource, { signal: this.options.signal });
 	}
 	/**
 	* Registers a plugin's lifecycle hooks on the shared `Hookable` as pass-through listeners that
@@ -1433,10 +1439,14 @@ var KubbDriver = class {
 		});
 		return Diagnostics.scope((diagnostic) => diagnostics.push(diagnostic), async () => {
 			try {
+				this.options.signal?.throwIfAborted();
 				const outputRoot = (0, node_path.resolve)(config.root, config.output.path);
 				await this.#parseInput();
 				await this.setupHooks();
-				for (const plugin of this.plugins.values()) plugin.options = normalizePluginOptions(plugin.options, plugin.name);
+				for (const plugin of this.plugins.values()) {
+					this.options.signal?.throwIfAborted();
+					plugin.options = normalizePluginOptions(plugin.options, plugin.name);
+				}
 				if (this.adapter && this.inputNode) {
 					const buildStartContext = this.#withFiles({
 						config,
@@ -1494,7 +1504,8 @@ var KubbDriver = class {
 				await fileManager.write(fileManager.files, {
 					storage: config.storage,
 					parsers: parsersMap,
-					manifest: this.options.manifest
+					manifest: this.options.manifest,
+					signal: this.options.signal
 				});
 				await hooks.callHook("kubb:build:end", {
 					files: this.fileManager.files,
@@ -1784,6 +1795,7 @@ var KubbDriver = class {
 		};
 		return {
 			config: driver.config,
+			signal: driver.options.signal,
 			get root() {
 				return (0, node_path.resolve)(driver.config.root, driver.config.output.path);
 			},
@@ -2160,9 +2172,11 @@ var Kubb = class {
 	#driver = null;
 	#storage = null;
 	#manifest = null;
+	#signal;
 	constructor(userConfig, options = {}) {
 		this.config = resolveConfig(userConfig);
 		this.hooks = options.hooks ?? new require_usingCtx.Hookable();
+		this.#signal = options.signal;
 	}
 	get storage() {
 		if (!this.#storage) throw new Error("[kubb] setup() must be called before accessing storage");
@@ -2176,6 +2190,8 @@ var Kubb = class {
 	* Initializes the driver and storage. `build()` calls this automatically.
 	*/
 	async setup() {
+		const signal = this.#signal;
+		signal?.throwIfAborted();
 		const config = this.config;
 		const manifest = hasOutputPasses(config.output) ? await createOutputManifest({
 			storage: config.storage,
@@ -2183,7 +2199,8 @@ var Kubb = class {
 		}) : void 0;
 		const driver = new KubbDriver(config, {
 			hooks: this.hooks,
-			manifest
+			manifest,
+			signal
 		});
 		this.hooks.setMaxListeners(Math.max(10, config.plugins.length * 4));
 		if (config.output.clean) {
@@ -2222,6 +2239,7 @@ var Kubb = class {
 	async safeBuild() {
 		try {
 			var _usingCtx$1 = require_usingCtx._usingCtx();
+			this.#signal?.throwIfAborted();
 			if (!this.#driver) await this.setup();
 			const self = _usingCtx$1.u(this);
 			const driver = self.driver;
@@ -2252,6 +2270,8 @@ var Kubb = class {
 	* ```
 	*/
 	async generate(options = {}) {
+		const signal = this.#signal;
+		signal?.throwIfAborted();
 		const { hooks, config } = this;
 		const hrStart = process.hrtime();
 		await hooks.callHook("kubb:generation:start", { config });
@@ -2259,6 +2279,7 @@ var Kubb = class {
 		await this.setup();
 		await hooks.callHook("kubb:setup:end");
 		const { files, diagnostics, storage } = await this.safeBuild();
+		signal?.throwIfAborted();
 		for (const diagnostic of diagnostics) {
 			if (!Diagnostics.isProblem(diagnostic)) continue;
 			if (diagnostic.code === Diagnostics.code.unknown) {