@kubb/core 5.2.7 → 5.3.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { $ as PluginFactoryOptions, A as Kubb, At as DiagnosticDoc, B as Exclude, Bt as Hookable, C as KubbWarnContext, Ct as Reporter, D as CreateKubbOptions, Dt as createReporter, E as UserConfig, Et as UserReporter, F as NodeCache, Ft as PerformanceDiagnostic, G as KubbPluginSetupContext, H as Group, Ht as AdapterFactoryOptions, I as KubbDriver, It as ProblemCode, J as Output, K as KubbPluginStartContext, L as FileManagerHooks, Lt as ProblemDiagnostic, M as Generator, Mt as DiagnosticLocation, N as GeneratorContext, Nt as DiagnosticSeverity, O as GenerateOptions, Ot as logLevel, P as defineGenerator, Pt as Diagnostics, Q as Plugin, R as Parser, Rt as SerializedDiagnostic, S as KubbSuccessContext, St as GenerationResult, T as PostGenerateCommand, Tt as ReporterName, U as Include, Ut as AdapterSource, V as Filter, Vt as Adapter, W as KubbPluginEndContext, Wt as createAdapter, X as OutputOptions, Y as OutputMode, Z as Override, _ as KubbHookStartContext, _t as Renderer, a as KubbBuildEndContext, at as ResolveBannerFile, b as KubbLifecycleStartContext, bt as Storage, c as KubbErrorContext, ct as ResolveOptionsContext, d as KubbFilesProcessingStartContext, dt as ResolverDefault, et as PluginName, f as KubbFilesProcessingUpdateContext, ft as ResolverFile, g as KubbHookLineContext, gt as ResolverPathParams, h as KubbHookEndContext, ht as ResolverPatch, i as Input, it as ResolveBannerContext, j as createKubb, jt as DiagnosticKind, k as GenerateResult, kt as Diagnostic, l as KubbFileProcessingUpdate, lt as ResolvePathOptions, m as KubbGenerationStartContext, mt as ResolverFilePathParams, n as CLIOptions, nt as definePlugin, o as KubbBuildStartContext, ot as ResolveFileOptions, p as KubbGenerationEndContext, pt as ResolverFileParams, q as NormalizedPlugin, r as Config, rt as BannerMeta, s as KubbDiagnosticContext, st as ResolveImportsOptions, t as BuildOutput, tt as ResolvePluginOptions, u as KubbFilesProcessingEndContext, ut as Resolver, v as KubbHooks, vt as RendererFactory, w as PossibleConfig, wt as ReporterContext, x as KubbPluginsEndContext, xt as createStorage, y as KubbInfoContext, yt as createRenderer, z as defineParser, zt as UpdateDiagnostic } from "./types-D6fWCd9O.js";
+import { $ as PluginFactoryOptions, A as Kubb, At as Diagnostic, B as Exclude, Bt as UpdateDiagnostic, C as KubbWarnContext, Ct as Reporter, D as CreateKubbOptions, Dt as UserReporter, E as UserConfig, Et as ReporterPluginFiles, F as NodeCache, Ft as Diagnostics, G as KubbPluginSetupContext, Gt as createAdapter, H as Group, Ht as Adapter, I as KubbDriver, It as PerformanceDiagnostic, J as Output, K as KubbPluginStartContext, L as FileManagerHooks, Lt as ProblemCode, M as Generator, Mt as DiagnosticKind, N as GeneratorContext, Nt as DiagnosticLocation, O as GenerateOptions, Ot as createReporter, P as defineGenerator, Pt as DiagnosticSeverity, Q as Plugin, R as Parser, Rt as ProblemDiagnostic, S as KubbSuccessContext, St as GenerationResult, T as PostGenerateCommand, Tt as ReporterName, U as Include, Ut as AdapterFactoryOptions, V as Filter, Vt as Hookable, W as KubbPluginEndContext, Wt as AdapterSource, X as OutputOptions, Y as OutputMode, Z as Override, _ as KubbHookStartContext, _t as Renderer, a as KubbBuildEndContext, at as ResolveBannerFile, b as KubbLifecycleStartContext, bt as Storage, c as KubbErrorContext, ct as ResolveOptionsContext, d as KubbFilesProcessingStartContext, dt as ResolverDefault, et as PluginName, f as KubbFilesProcessingUpdateContext, ft as ResolverFile, g as KubbHookLineContext, gt as ResolverPathParams, h as KubbHookEndContext, ht as ResolverPatch, i as Input, it as ResolveBannerContext, j as createKubb, jt as DiagnosticDoc, k as GenerateResult, kt as logLevel, l as KubbFileProcessingUpdate, lt as ResolvePathOptions, m as KubbGenerationStartContext, mt as ResolverFilePathParams, n as CLIOptions, nt as definePlugin, o as KubbBuildStartContext, ot as ResolveFileOptions, p as KubbGenerationEndContext, pt as ResolverFileParams, q as NormalizedPlugin, r as Config, rt as BannerMeta, s as KubbDiagnosticContext, st as ResolveImportsOptions, t as BuildOutput, tt as ResolvePluginOptions, u as KubbFilesProcessingEndContext, ut as Resolver, v as KubbHooks, vt as RendererFactory, w as PossibleConfig, wt as ReporterContext, x as KubbPluginsEndContext, xt as createStorage, y as KubbInfoContext, yt as createRenderer, z as defineParser, zt as SerializedDiagnostic } from "./types-D6I-1WdH.js";
 //#region src/applyConfigDefaults.d.ts
 type ApplyConfigDefaultsOptions<TOutput> = {
   defaultAdapter: Adapter;
@@ -55,6 +55,12 @@ export declare const fileReporter: Reporter;
  */
 export declare const jsonReporter: Reporter;
 //#endregion
+//#region src/reporters/htmlReporter.d.ts
+/**
+ * Writes a static HTML report directory selected with `--reporter html`.
+ */
+export declare const htmlReporter: Reporter;
+//#endregion
 //#region src/createResolver.d.ts
 /**
  * The plugin-specific resolver fields handed to `createResolver`. `name` and `file` fall
@@ -184,5 +190,5 @@ export declare const fsStorage: (options?: Record<string, never> | undefined) =>
  */
 export declare const memoryStorage: (options?: Record<string, never> | undefined) => Storage;
 //#endregion
-export { type Adapter, type AdapterFactoryOptions, type AdapterSource, type BannerMeta, BuildOutput, CLIOptions, Config, type CreateKubbOptions, type Diagnostic, type DiagnosticDoc, type DiagnosticKind, type DiagnosticLocation, type DiagnosticSeverity, Diagnostics, type Exclude, type FileManagerHooks, type Filter, type GenerateOptions, type GenerateResult, type GenerationResult, type Generator, type GeneratorContext, type Group, Hookable, type Include, Input, type InputKind, type Kubb, KubbBuildEndContext, KubbBuildStartContext, KubbDiagnosticContext, KubbDriver, KubbErrorContext, KubbFileProcessingUpdate, KubbFilesProcessingEndContext, KubbFilesProcessingStartContext, KubbFilesProcessingUpdateContext, KubbGenerationEndContext, KubbGenerationStartContext, KubbHookEndContext, KubbHookLineContext, KubbHookStartContext, KubbHooks, KubbInfoContext, KubbLifecycleStartContext, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, KubbPluginsEndContext, KubbSuccessContext, KubbWarnContext, type NodeCache, type NormalizedPlugin, type Output, type OutputMode, type OutputOptions, type Override, type Parser, type PerformanceDiagnostic, type Plugin, type PluginFactoryOptions, type PluginName, PossibleConfig, PostGenerateCommand, type ProblemCode, type ProblemDiagnostic, type Renderer, type RendererFactory, type Reporter, type ReporterContext, type ReporterName, type ResolveBannerContext, type ResolveBannerFile, type ResolveFileOptions, type ResolveImportsOptions, type ResolveOptionsContext, type ResolvePathOptions, type ResolvePluginOptions, Resolver, type ResolverDefault, type ResolverFile, type ResolverFileParams, type ResolverFilePathParams, type ResolverPatch, type ResolverPathParams, type SerializedDiagnostic, type Storage, type UpdateDiagnostic, UserConfig, type UserReporter, createAdapter, createKubb, createRenderer, createReporter, createStorage, defineGenerator, defineParser, definePlugin, logLevel };
+export { type Adapter, type AdapterFactoryOptions, type AdapterSource, type BannerMeta, BuildOutput, CLIOptions, Config, type CreateKubbOptions, type Diagnostic, type DiagnosticDoc, type DiagnosticKind, type DiagnosticLocation, type DiagnosticSeverity, Diagnostics, type Exclude, type FileManagerHooks, type Filter, type GenerateOptions, type GenerateResult, type GenerationResult, type Generator, type GeneratorContext, type Group, Hookable, type Include, Input, type InputKind, type Kubb, KubbBuildEndContext, KubbBuildStartContext, KubbDiagnosticContext, KubbDriver, KubbErrorContext, KubbFileProcessingUpdate, KubbFilesProcessingEndContext, KubbFilesProcessingStartContext, KubbFilesProcessingUpdateContext, KubbGenerationEndContext, KubbGenerationStartContext, KubbHookEndContext, KubbHookLineContext, KubbHookStartContext, KubbHooks, KubbInfoContext, KubbLifecycleStartContext, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, KubbPluginsEndContext, KubbSuccessContext, KubbWarnContext, type NodeCache, type NormalizedPlugin, type Output, type OutputMode, type OutputOptions, type Override, type Parser, type PerformanceDiagnostic, type Plugin, type PluginFactoryOptions, type PluginName, PossibleConfig, PostGenerateCommand, type ProblemCode, type ProblemDiagnostic, type Renderer, type RendererFactory, type Reporter, type ReporterContext, type ReporterName, type ReporterPluginFiles, type ResolveBannerContext, type ResolveBannerFile, type ResolveFileOptions, type ResolveImportsOptions, type ResolveOptionsContext, type ResolvePathOptions, type ResolvePluginOptions, Resolver, type ResolverDefault, type ResolverFile, type ResolverFileParams, type ResolverFilePathParams, type ResolverPatch, type ResolverPathParams, type SerializedDiagnostic, type Storage, type UpdateDiagnostic, UserConfig, type UserReporter, createAdapter, createKubb, createRenderer, createReporter, createStorage, defineGenerator, defineParser, definePlugin, logLevel };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,14 +1,16 @@
 import "./rolldown-runtime-C0LytTxp.js";
-import { a as OPERATION_FILTER_TYPES, c as clean, d as write, f as getErrorMessage, i as Hookable, l as isPathInside, m as camelCase, n as createNodeCache, o as diagnosticCode, p as toError, r as FileManager, s as inParallel, t as _usingCtx, u as toPosixPath } from "./usingCtx-xMZZh-09.js";
+import { a as OPERATION_FILTER_TYPES, c as clean, d as toPosixPath, f as write, h as camelCase, i as Hookable, l as isPathInside, m as toError, n as createNodeCache, o as diagnosticCode, p as getErrorMessage, r as FileManager, s as inParallel, t as _usingCtx, u as read } from "./usingCtx-y6z42CxR.js";
 import { AsyncLocalStorage } from "node:async_hooks";
 import { stripVTControlCharacters, styleText } from "node:util";
+import process$1 from "node:process";
+import { execFile } from "node:child_process";
 import { access, glob, readFile, rm } from "node:fs/promises";
 import path, { join, relative, resolve } from "node:path";
 import { ast, collectImportedRefNames, collectUsedSchemaNames, composeMacros, operationDef, schemaDef, transform } from "@kubb/ast";
 import { hash } from "node:crypto";
 import { existsSync } from "node:fs";
 import { tmpdir } from "node:os";
-import process$1 from "node:process";
+import { fileURLToPath } from "node:url";
 //#region src/createAdapter.ts
 /**
 * Defines a custom adapter that translates a spec format into Kubb's universal
@@ -63,6 +65,29 @@ function applyConfigDefaults(config, { defaultAdapter, barrelPlugin, barrelPlugi
 	};
 }
 //#endregion
+//#region ../../internals/utils/src/isCIEnvironment.ts
+/**
+* Returns `true` when a known CI provider has set its environment variable.
+*/
+function isCIEnvironment() {
+	return !!(process$1.env.CI || process$1.env.GITHUB_ACTIONS || process$1.env.GITLAB_CI || process$1.env.BITBUCKET_BUILD_NUMBER || process$1.env.JENKINS_URL || process$1.env.CIRCLECI || process$1.env.TRAVIS || process$1.env.TEAMCITY_VERSION || process$1.env.BUILDKITE || process$1.env.TF_BUILD);
+}
+//#endregion
+//#region ../../internals/utils/src/openInBrowser.ts
+/**
+* Opens a URL or local file in the default browser, unless running in CI.
+*/
+function openInBrowser(target) {
+	if (isCIEnvironment()) return;
+	if (process$1.platform === "win32") execFile("cmd", [
+		"/c",
+		"start",
+		"",
+		target
+	], () => {});
+	else execFile(process$1.platform === "darwin" ? "open" : "xdg-open", [target], () => {});
+}
+//#endregion
 //#region ../../internals/utils/src/time.ts
 /**
 * Calculates elapsed time in milliseconds from a high-resolution `process.hrtime` start time.
@@ -100,7 +125,7 @@ function formatMs(ms) {
 /**
 * Docs major version, derived from the package version so the link tracks the published major.
 */
-const docsMajor = "5.2.7".split(".")[0] ?? "5";
+const docsMajor = "5.3.0".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`.
@@ -2340,6 +2365,7 @@ function createReporter(reporter) {
 	const reports = [];
 	return {
 		name: reporter.name,
+		needsPluginFiles: reporter.needsPluginFiles,
 		async report(result, context) {
 			const report = await reporter.report(result, context);
 			if (reporter.drain) reports.push(report);
@@ -2577,6 +2603,40 @@ const jsonReporter = createReporter({
 	}
 });
 //#endregion
+//#region src/reporters/htmlReporter.ts
+function serializeReport(result) {
+	return `globalThis.__KUBB_REPORT__ = ${JSON.stringify({
+		generatedAt: (/* @__PURE__ */ new Date()).toISOString(),
+		report: buildReport(result),
+		pluginFiles: result.pluginFiles ?? []
+	}).replace(/</g, "\\u003c").replace(/>/g, "\\u003e").replace(/&/g, "\\u0026")}\n`;
+}
+/**
+* Writes a static HTML report directory selected with `--reporter html`.
+*/
+const htmlReporter = createReporter({
+	name: "html",
+	needsPluginFiles: true,
+	async report(result) {
+		const baseName = [
+			"kubb",
+			result.config.name?.replace(/[^a-zA-Z0-9_-]+/g, "-").replace(/^-+|-+$/g, ""),
+			Date.now()
+		].filter(Boolean).join("-");
+		const pathName = resolve(process.cwd(), ".kubb", baseName);
+		const assets = new URL("./html/", import.meta.url);
+		const [html, ui] = await Promise.all([read(fileURLToPath(new URL("index.html", assets))), read(fileURLToPath(new URL("ui.iife.js", assets)))]);
+		await Promise.all([
+			write(resolve(pathName, "index.html"), html),
+			write(resolve(pathName, "ui.iife.js"), ui),
+			write(resolve(pathName, "data.js"), serializeReport(result))
+		]);
+		const reportPath = resolve(pathName, "index.html");
+		console.error(`HTML report written to ${relative(process.cwd(), reportPath)}`);
+		openInBrowser(reportPath);
+	}
+});
+//#endregion
 //#region src/createRenderer.ts
 /**
 * Defines a renderer factory. Renderers turn the generator's return value
@@ -2726,6 +2786,6 @@ const memoryStorage = createStorage(() => {
 	};
 });
 //#endregion
-export { Diagnostics, Hookable, KubbDriver, Resolver, applyConfigDefaults, cliReporter, createAdapter, createKubb, createRenderer, createReporter, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fileReporter, fsStorage, getInputKind, jsonReporter, logLevel, memoryStorage };
+export { Diagnostics, Hookable, KubbDriver, Resolver, applyConfigDefaults, cliReporter, createAdapter, createKubb, createRenderer, createReporter, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fileReporter, fsStorage, getInputKind, htmlReporter, jsonReporter, logLevel, memoryStorage };
 
 //# sourceMappingURL=index.js.map