@gtkx/config 1.6.0 → 2.0.0-beta.1

package/src/config.ts

@@ -2,23 +2,17 @@ import { createDefineConfig, type DefineConfig } from "c12";
 import { defu } from "defu";
 import { resolve } from "node:path";
 import { z } from "zod";
-import { configError, isRecord, rawIssue } from "./config-error.ts";
+import { configError, isRecord } from "./config-error.ts";
 import { deploySchema } from "./deploy.ts";
-import { DEPRECATION_IDS } from "./deprecations.ts";
-import { isGirLibrary, text } from "./schema-text.ts";
+import { girLibrary, text } from "./schema-text.ts";
 import { resolveUserEventSignals } from "./user-event-signals.ts";
 
-/** Accepted `reactCompiler.compilationMode` values, choosing which functions the compiler processes. */
-type ReactCompilerCompilationMode = (typeof COMPILATION_MODES)[number];
-/** Accepted `reactCompiler.panicThreshold` values, choosing which compiler diagnostics fail the build. */
-type ReactCompilerPanicThreshold = (typeof PANIC_THRESHOLDS)[number];
-
-/** Object form of the `reactCompiler` config key, forwarded as-is to `babel-plugin-react-compiler`. */
+/** Object form of the `reactCompiler` config key, forwarded to `babel-plugin-react-compiler`. */
 type ReactCompilerOptions = {
-    /** Which functions the compiler processes; left to the compiler's own default when omitted. */
-    compilationMode?: ReactCompilerCompilationMode;
-    /** Which compiler diagnostics fail the build; left to the compiler's own default when omitted. */
-    panicThreshold?: ReactCompilerPanicThreshold;
+    /** Which functions the compiler processes. */
+    compilationMode?: (typeof COMPILATION_MODES)[number];
+    /** Which compiler diagnostics fail the build. */
+    panicThreshold?: (typeof PANIC_THRESHOLDS)[number];
 };
 
 /**
@@ -33,9 +27,8 @@ type ResolvedReactCompilerOptions = ReactCompilerOptions & {
 /**
  * User-facing configuration for a GTKX project, as authored in `gtkx.config.ts`: the GIR libraries
  * to bind and where to find them, the GApplication id, per-element configuration, the React
- * Compiler, codegen, and user event signal settings, the `agents` and `mcp` blocks controlling what
- * coding agents are given, the `future` block opting into behavior that becomes the default in the
- * next major version, and the `deprecations` block silencing the warnings about flags left unset.
+ * Compiler, codegen, and user event signal settings, and the `agents` and `mcp` blocks controlling
+ * what coding agents are given.
  */
 type Config = z.infer<typeof configSchema>;
 type ModuleExport = z.infer<typeof moduleExportSchema>;
@@ -46,16 +39,6 @@ type McpSettings = {
     isReadOnly: boolean;
 };
 
-type ResolvedFuture = {
-    isByteArrayTyped: boolean;
-    isValueUnwrapped: boolean;
-    isFinishTrimmed: boolean;
-    isInoutInPlace: boolean;
-    isResourceImported: boolean;
-    isAdwaitaDefault: boolean;
-    isTreeShaken: boolean;
-};
-
 /** Configuration reduced to the values the app runtime and the build need, with paths already resolved. */
 type ResolvedConfig = {
     /** The GApplication identifier the app registers under. */
@@ -73,92 +56,35 @@ type ResolvedConfig = {
     lazyElements: string[];
 };
 
-const LIBRARIES_WILDCARD = "*";
 const APPLICATION_ID_PATTERN = /^[A-Za-z_][A-Za-z0-9_-]*(\.[A-Za-z_][A-Za-z0-9_-]*)+$/;
 const APPLICATION_ID_MAX_LENGTH = 255;
+const DEFAULT_LIBRARIES: Set<string> = new Set(["Gtk-4.0", "Adw-1"]);
 /** Compilation modes `babel-plugin-react-compiler` accepts. */
 const COMPILATION_MODES = ["infer", "syntax", "annotation", "all"] as const;
 /** Panic thresholds `babel-plugin-react-compiler` accepts. */
 const PANIC_THRESHOLDS = ["none", "critical_errors", "all_errors"] as const;
 const REACT_COMPILER_TARGET = "19";
-const COMPILATION_MODE_SET: Set<string> = new Set(COMPILATION_MODES);
-const PANIC_THRESHOLD_SET: Set<string> = new Set(PANIC_THRESHOLDS);
-
-const librariesSchema = z.custom<typeof LIBRARIES_WILDCARD | string[]>().check((ctx) => {
-    const value = ctx.value;
-
-    if (value === LIBRARIES_WILDCARD) {
-        return;
-    }
 
-    if (!Array.isArray(value) || value.length === 0) {
-        ctx.issues.push(rawIssue(value, [], `must be "${LIBRARIES_WILDCARD}", a non-empty string array, or omitted`));
+const librarySchema = girLibrary('must be of the form "Name-Version", such as "Gtk-4.0"')
+    .refine((library) => !DEFAULT_LIBRARIES.has(library), { error: "is bound by default; remove it" });
 
-        return;
-    }
-
-    for (const [index, entry] of value.entries()) {
-        ctx.issues.push(...libraryEntryIssues(value, index, entry));
-    }
-});
+const librariesSchema = z
+    .array(librarySchema, { error: "must be a non-empty string array or omitted" })
+    .min(1, { error: "must be a non-empty string array or omitted" });
 
-const applicationIdSchema = z.custom<string>().check((ctx) => {
-    const value = ctx.value;
-
-    if (typeof value !== "string" || !isValidApplicationId(value)) {
-        ctx.issues.push(
-            rawIssue(
-                value,
-                [],
-                `invalid \`applicationId\` "${value}", must satisfy g_application_id_is_valid ` +
-                '(e.g. "org.example.MyApp")',
-                true,
-            ),
-        );
-    }
-});
+const applicationIdSchema = z
+    .string({ error: "must satisfy g_application_id_is_valid" })
+    .refine((value) => isValidApplicationId(value), {
+        error: 'must satisfy g_application_id_is_valid, such as "org.example.MyApp"',
+    });
 
-const reactCompilerSchema = z.custom<boolean | ReactCompilerOptions>().check((ctx) => {
-    const value = ctx.value;
-
-    if (typeof value === "boolean") {
-        return;
-    }
-
-    if (!isRecord(value)) {
-        ctx.issues.push(rawIssue(value, [], "must be a boolean or an options object"));
-
-        return;
-    }
-
-    const compilationMode = value.compilationMode;
-
-    if (!isValidReactCompilerOption(compilationMode, COMPILATION_MODE_SET)) {
-        ctx.issues.push(
-            rawIssue(
-                value,
-                [],
-                `invalid \`reactCompiler.compilationMode\` "${String(compilationMode)}", ` +
-                `must be one of ${COMPILATION_MODES.join(", ")}`,
-                true,
-            ),
-        );
-    }
-
-    const panicThreshold = value.panicThreshold;
-
-    if (!isValidReactCompilerOption(panicThreshold, PANIC_THRESHOLD_SET)) {
-        ctx.issues.push(
-            rawIssue(
-                value,
-                [],
-                `invalid \`reactCompiler.panicThreshold\` "${String(panicThreshold)}", ` +
-                `must be one of ${PANIC_THRESHOLDS.join(", ")}`,
-                true,
-            ),
-        );
-    }
-});
+const reactCompilerSchema = z.union([
+    z.boolean(),
+    z.object({
+        compilationMode: z.enum(COMPILATION_MODES).optional(),
+        panicThreshold: z.enum(PANIC_THRESHOLDS).optional(),
+    }),
+]);
 
 const userEventSignalsSchema = z.record(
     z.string(),
@@ -215,30 +141,28 @@ const mcpSchema = z.object({
     readOnly: z.boolean({ error: "must be a boolean" }).optional(),
 });
 
-const futureSchema = z.object({
-    v2ByteArrays: z.boolean({ error: "must be a boolean" }).optional(),
-    v2ValueReturns: z.boolean({ error: "must be a boolean" }).optional(),
-    v2FinishResults: z.boolean({ error: "must be a boolean" }).optional(),
-    v2InoutReturns: z.boolean({ error: "must be a boolean" }).optional(),
-    v2ResourceImports: z.boolean({ error: "must be a boolean" }).optional(),
-    v2DefaultLibraries: z.boolean({ error: "must be a boolean" }).optional(),
-    v2TreeShaking: z.boolean({ error: "must be a boolean" }).optional(),
-});
-
-const FUTURE_KEYS: Set<string> = new Set(Object.keys(futureSchema.shape));
-const DEPRECATION_ID_ERROR = `must be one of ${DEPRECATION_IDS.join(", ")}`;
+const graduatedFutureSchema = z
+    .object({
+        v2ByteArrays: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2ValueReturns: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2FinishResults: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2InoutReturns: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2ResourceImports: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2DefaultLibraries: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+        v2TreeShaking: z.literal(true, { error: "can only be true; remove the flag" }).optional(),
+    })
+    .strict();
 
 const deprecationsSchema = z.object({
     silence: z
-        .array(z.enum(DEPRECATION_IDS, { error: DEPRECATION_ID_ERROR }), {
-            error: "must be an array of deprecation ids",
+        .array(z.never({ error: "does not name a current deprecation" }), {
+            error: "must be an array of current deprecation ids",
         })
         .optional(),
 });
 
 /** Schema every `gtkx.config.ts` is validated against, and the source of the {@link Config} type. */
 const configSchema = z.object({
-    future: futureSchema.optional(),
     libraries: librariesSchema.optional(),
     girPath: z.array(z.string(), { error: "must be an array of strings if provided" }).optional(),
     applicationId: applicationIdSchema,
@@ -258,34 +182,10 @@ const configSchema = z.object({
  * autocompletion and type checking.
  */
 const defineConfig: DefineConfig<Config> = createDefineConfig<Config>();
+const validationSchema = configSchema.extend({ future: graduatedFutureSchema.optional() });
 
-const libraryEntryIssues = (value: unknown[], index: number, entry: unknown): ReturnType<typeof rawIssue>[] => {
-    if (typeof entry === "string" && isGirLibrary(entry)) {
-        return [];
-    }
-
-    if (entry === LIBRARIES_WILDCARD) {
-        const message =
-            `to generate every library, set \`libraries: "${LIBRARIES_WILDCARD}"\` as a bare string, ` +
-            "not an array entry";
-
-        return [rawIssue(value, [index], message, true)];
-    }
-
-    const message =
-        `invalid library identifier "${String(entry)}", must be of the form "Name-Version" ` +
-        '(e.g. "Gtk-4.0")';
-
-    return [rawIssue(value, [index], message, true)];
-};
-
-const isValidApplicationId = (applicationId: string): boolean => {
-    if (applicationId.length === 0 || applicationId.length > APPLICATION_ID_MAX_LENGTH) {
-        return false;
-    }
-
-    return APPLICATION_ID_PATTERN.test(applicationId);
-};
+const isValidApplicationId = (applicationId: string): boolean =>
+    applicationId.length <= APPLICATION_ID_MAX_LENGTH && APPLICATION_ID_PATTERN.test(applicationId);
 
 const resolveReactCompilerOptions = (setting: Config["reactCompiler"]): ResolvedReactCompilerOptions | null => {
     if (setting === false) {
@@ -294,20 +194,29 @@ const resolveReactCompilerOptions = (setting: Config["reactCompiler"]): Resolved
 
     const overrides = setting === undefined || setting === true ? {} : setting;
 
-    return { ...overrides, target: REACT_COMPILER_TARGET };
+    return {
+        ...(overrides.compilationMode !== undefined && { compilationMode: overrides.compilationMode }),
+        ...(overrides.panicThreshold !== undefined && { panicThreshold: overrides.panicThreshold }),
+        target: REACT_COMPILER_TARGET,
+    };
 };
 
-const isValidReactCompilerOption = (value: unknown, allowed: Set<string>): boolean =>
-    value === undefined || (typeof value === "string" && allowed.has(value));
-
-const validateConfig = (config: Config): void => {
-    const result = configSchema.safeParse(config);
+const validateConfig = (config: unknown): void => {
+    const result = validationSchema.safeParse(config);
 
     if (!result.success) {
         throw configError(result.error);
     }
 };
 
+const graduatedFutureKeys = (config: unknown): string[] => {
+    if (!isRecord(config) || !isRecord(config.future)) {
+        return [];
+    }
+
+    return Object.keys(config.future).toSorted((first, second) => first.localeCompare(second));
+};
+
 /**
  * Deep-merges a configuration over a base. `override` wins over `base` on conflicting scalar and object keys, while
  * arrays are concatenated with the `override` entries first.
@@ -356,19 +265,6 @@ const resolveMcpSettings = (config: Config): McpSettings => ({
     isReadOnly: config.mcp?.readOnly === true,
 });
 
-const resolveFuture = (future: Config["future"]): ResolvedFuture => ({
-    isByteArrayTyped: future?.v2ByteArrays === true,
-    isValueUnwrapped: future?.v2ValueReturns === true,
-    isFinishTrimmed: future?.v2FinishResults === true,
-    isInoutInPlace: future?.v2InoutReturns === true,
-    isResourceImported: future?.v2ResourceImports === true,
-    isAdwaitaDefault: future?.v2DefaultLibraries === true,
-    isTreeShaken: future?.v2TreeShaking === true,
-});
-
-const unknownFutureKeys = (future: Config["future"]): string[] =>
-    Object.keys(future ?? {}).filter((key) => !FUTURE_KEYS.has(key));
-
 const resolveConfig = (config: Config, root?: string): ResolvedConfig => ({
     applicationId: config.applicationId,
     reactCompiler: resolveReactCompilerOptions(config.reactCompiler),
@@ -383,6 +279,7 @@ export {
     isAgentReferenceEnabled,
     isAgentRulesEnabled,
     isValidApplicationId,
+    graduatedFutureKeys,
     validateConfig,
     mergeConfig,
     resolveLazyElements,
@@ -391,11 +288,8 @@ export {
     resolveMcpSettings,
     resolveOmittedProps,
     resolveConfig,
-    resolveFuture,
-    unknownFutureKeys,
     type McpSettings,
     type ResolvedReactCompilerOptions,
     type Config,
     type ResolvedConfig,
-    type ResolvedFuture,
 };

package/src/deploy.ts

@@ -119,7 +119,7 @@ const extraFileEntrySchema = z.union([text(SOURCE_PATH_ERROR), extraFileSchema],
 
 const nodeRuntimeSchema = z.strictObject({
     source: z.enum(NODE_SOURCES, { error: "must be one of download, host, path" }).optional(),
-    version: text("must be a Node.js version such as 24.19.0").optional(),
+    version: text("must be a Node.js version such as 26.7.0").optional(),
     path: text("must be a path to a node binary").optional(),
     shouldStrip: flag(BOOLEAN_ERROR).optional(),
     shouldUseCompileCache: flag(BOOLEAN_ERROR).optional(),

package/src/index.ts

@@ -1,4 +1,2 @@
-/** @public */
 export { type Config, defineConfig, mergeConfig, type ResolvedConfig } from "./config.ts";
-/** @public */
 export { type ConfigLoader, type LoadedConfig, loadConfig } from "./loader.ts";

package/src/internal.ts

@@ -1,4 +1,4 @@
-export type { McpSettings, ResolvedFuture, ResolvedReactCompilerOptions } from "./config.ts";
+export type { McpSettings, ResolvedReactCompilerOptions } from "./config.ts";
 export {
     APPLICATION_ID_MAX_LENGTH,
     isAgentReferenceEnabled,
@@ -6,11 +6,9 @@ export {
     isValidApplicationId,
     resolveElementComponents,
     resolveElementProps,
-    resolveFuture,
     resolveLazyElements,
     resolveMcpSettings,
     resolveOmittedProps,
-    unknownFutureKeys,
 } from "./config.ts";
 export { createConfigLoader } from "./loader.ts";
 export { resourceBasePath } from "./resource-base-path.ts";

package/src/loader.ts

@@ -1,10 +1,15 @@
-import { getOrInsert } from "@gtkx/utils";
+import { warn } from "@gtkx/utils";
 import { loadConfig as loadConfigFile } from "c12";
 import { existsSync } from "node:fs";
 import { resolve } from "node:path";
 import { missingConfigFileError } from "./config-error.ts";
-import { type Config, resolveConfig, type ResolvedConfig, validateConfig } from "./config.ts";
-import { warnDeprecations } from "./deprecations.ts";
+import {
+    type Config,
+    graduatedFutureKeys,
+    resolveConfig,
+    type ResolvedConfig,
+    validateConfig,
+} from "./config.ts";
 
 /** Result of loading a project's `gtkx.config.ts` file. */
 type LoadedConfig = {
@@ -33,10 +38,28 @@ type ConfigLoader = {
     resolve: (cwd: string) => Promise<ResolvedConfig>;
 };
 
+const GRADUATED_FUTURE_ENV = "GTKX_GRADUATED_FUTURE_SHOWN";
+const graduatedFutureWarnings: Map<string, string> = new Map();
+
+const warnGraduatedFuture = (config: unknown, root: string): void => {
+    const keys = graduatedFutureKeys(config);
+    const signature = keys.join(",");
+
+    if (
+        keys.length === 0 ||
+        graduatedFutureWarnings.get(root) === signature ||
+        process.env[GRADUATED_FUTURE_ENV] === signature
+    ) {
+        return;
+    }
+
+    graduatedFutureWarnings.set(root, signature);
+    process.env[GRADUATED_FUTURE_ENV] = signature;
+    warn(`GTKX 2 ignores graduated future flags: ${keys.join(", ")}. Remove them from gtkx.config.ts.`);
+};
+
 /**
- * Loads and validates the `gtkx.config.ts` file for a project. Writes one deprecation notice to stderr the
- * first time a configuration leaves a `future` flag unset, recording what it reported in the environment so
- * a child process does not repeat it.
+ * Loads and validates the `gtkx.config.ts` file for a project.
  * @param cwd Directory the configuration file is looked up in; parent directories are not searched.
  * @param options Loading options, such as the environment mode whose overrides are applied.
  * @throws When that directory holds no configuration file, or when the configuration fails validation.
@@ -63,7 +86,7 @@ const loadConfig = async (cwd: string, options: LoadConfigOptions = {}): Promise
     const config = result.config;
     const root = result.cwd ?? searched;
     validateConfig(config);
-    warnDeprecations(config, root);
+    warnGraduatedFuture(config, root);
 
     return {
         config,
@@ -77,7 +100,7 @@ const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
     const resolved: Map<string, Promise<ResolvedConfig>> = new Map();
 
     const load = (cwd: string): Promise<LoadedConfig> =>
-        getOrInsert(loaded, resolve(cwd), (root) => loadConfig(root, options));
+        loaded.getOrInsertComputed(resolve(cwd), (root) => loadConfig(root, options));
 
     const resolveAt = async (root: string): Promise<ResolvedConfig> => {
         const { config, root: configRoot } = await load(root);
@@ -87,7 +110,7 @@ const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
 
     return {
         load,
-        resolve: (cwd: string): Promise<ResolvedConfig> => getOrInsert(resolved, resolve(cwd), resolveAt),
+        resolve: (cwd: string): Promise<ResolvedConfig> => resolved.getOrInsertComputed(resolve(cwd), resolveAt),
     };
 };
 

package/src/schema-text.ts

@@ -40,4 +40,4 @@ const relativePathRecord = <Value extends z.ZodType>(
     recordMessage: string,
 ): z.ZodRecord<z.ZodString, Value> => z.record(relativePath(keyMessage), value, { error: recordMessage });
 
-export { fileExtension, flag, girLibrary, isGirLibrary, relativePathRecord, text, textList, textRecord, url };
+export { fileExtension, flag, girLibrary, relativePathRecord, text, textList, textRecord, url };

package/src/virtual.ts

@@ -5,11 +5,8 @@ const GTKX_CONFIG_VIRTUAL_ID = "virtual:gtkx-config";
 const RESOLVED_GTKX_CONFIG_VIRTUAL_ID = `\0${GTKX_CONFIG_VIRTUAL_ID}`;
 const METADATA_SPECIFIER = "@gtkx/jsx/metadata";
 
-const lazyElementConfig = (lazyElements: string[]): Record<string, { isLazy: boolean }> =>
-    Object.fromEntries(lazyElements.map((type) => [type, { isLazy: true }]));
-
 const renderConfigModule = (config: ResolvedConfig): string => {
-    const lazyJson = JSON.stringify(lazyElementConfig(config.lazyElements));
+    const lazyJson = JSON.stringify(Object.fromEntries(config.lazyElements.map((type) => [type, { isLazy: true }])));
 
     const behaviorImports =
         config.elements === null

package/dist/deprecations.d.ts

@@ -1,5 +0,0 @@
-import type { Config } from "./config.ts";
-declare const DEPRECATION_IDS: readonly ["gtkx-v2-byte-arrays", "gtkx-v2-value-returns", "gtkx-v2-finish-results", "gtkx-v2-inout-returns", "gtkx-v2-resource-imports", "gtkx-v2-default-libraries", "gtkx-v2-tree-shaking"];
-declare const warnDeprecations: (config: Config, root: string) => void;
-export { DEPRECATION_IDS, warnDeprecations };
-//# sourceMappingURL=deprecations.d.ts.map

package/dist/deprecations.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deprecations.d.ts","sourceRoot":"","sources":["../src/deprecations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAkB1C,QAAA,MAAM,eAAe,+LAQX,CAAC;AAuFX,QAAA,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,MAAM,MAAM,KAAG,IAaxD,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/deprecations.js

@@ -1,97 +0,0 @@
-import { warn } from "@gtkx/utils";
-const SHOWN_ENV = "GTKX_DEPRECATIONS_SHOWN";
-const GUIDE_URL = "https://gtkx.dev/guide/upgrading-to-2";
-const ENTRY_COLUMN = 30;
-const BUILD_REPORTS = " The build, not tsc, reports the specifiers still to change.";
-const NOTHING_REPORTS = " Nothing reports this one; check the app yourself.";
-const SILENT_SITES = " `Array.isArray` and `JSON.stringify` change silently; grep for them.";
-const DEPRECATION_IDS = [
-    "gtkx-v2-byte-arrays",
-    "gtkx-v2-value-returns",
-    "gtkx-v2-finish-results",
-    "gtkx-v2-inout-returns",
-    "gtkx-v2-resource-imports",
-    "gtkx-v2-default-libraries",
-    "gtkx-v2-tree-shaking",
-];
-const FUTURE_DEPRECATIONS = [
-    {
-        id: "gtkx-v2-byte-arrays",
-        flag: "v2ByteArrays",
-        change: "Byte sequences come back as number[]. In 2.0 they come back as Uint8Array.",
-        unchecked: SILENT_SITES,
-    },
-    {
-        id: "gtkx-v2-value-returns",
-        flag: "v2ValueReturns",
-        change: "Bindings that return a GValue hand back the box. In 2.0 they hand back its contents, as unknown.",
-    },
-    {
-        id: "gtkx-v2-finish-results",
-        flag: "v2FinishResults",
-        change: "Async pairs with out parameters resolve with a leading success boolean. In 2.0 it is dropped.",
-    },
-    {
-        id: "gtkx-v2-inout-returns",
-        flag: "v2InoutReturns",
-        change: "Inout records repeat in the return value. In 2.0 the repeated entry is dropped.",
-    },
-    {
-        id: "gtkx-v2-resource-imports",
-        flag: "v2ResourceImports",
-        change: "Assets resolve through the #data/ import map. In 2.0 they resolve through ?resource imports.",
-        unchecked: BUILD_REPORTS,
-    },
-    {
-        id: "gtkx-v2-default-libraries",
-        flag: "v2DefaultLibraries",
-        change: "Only Gtk-4.0 is bound by default. In 2.0 Adw-1 is bound alongside it.",
-        unchecked: NOTHING_REPORTS,
-    },
-    {
-        id: "gtkx-v2-tree-shaking",
-        flag: "v2TreeShaking",
-        change: "The stores register every class eagerly. " +
-            "In 2.0 each class registers itself and unused ones drop from bundles.",
-    },
-];
-const shownRoots = new Map();
-const isSilenced = (config, id) => (config.deprecations?.silence ?? []).includes(id);
-const unsetDeprecations = (config) => FUTURE_DEPRECATIONS.filter((deprecation) => config.future?.[deprecation.flag] !== true);
-const formatSummary = (unset, silenced) => {
-    const note = silenced === 0 ? "" : ` ${String(silenced)} of them silenced here.`;
-    return (`${String(unset)} of ${String(FUTURE_DEPRECATIONS.length)} future flags are unset. ` +
-        `Their behavior becomes the default in GTKX 2.0.${note}`);
-};
-const formatDeprecation = (deprecation) => `  [${deprecation.id}]`.padEnd(ENTRY_COLUMN) +
-    `future: { ${deprecation.flag}: true }\n    ${deprecation.change}` +
-    (deprecation.unchecked ?? "");
-const formatAdvice = (pending) => {
-    if (pending.every((deprecation) => deprecation.unchecked === undefined)) {
-        return "  Set one flag at a time and run tsc: every affected call site is a type error.";
-    }
-    return "  Set one flag at a time and run tsc: it reports every affected call site except where noted above.";
-};
-const formatBlock = (unset, pending, first) => [
-    formatSummary(unset.length, unset.length - pending.length),
-    "",
-    ...pending.flatMap((deprecation) => [formatDeprecation(deprecation), ""]),
-    formatAdvice(pending),
-    `  Guide    ${GUIDE_URL}`,
-    `  Silence  deprecations: { silence: [${JSON.stringify(first.id)}] }`,
-].join("\n");
-const hasShown = (root, signature) => shownRoots.get(root) === signature || process.env[SHOWN_ENV] === signature;
-const warnDeprecations = (config, root) => {
-    const unset = unsetDeprecations(config);
-    const pending = unset.filter((deprecation) => !isSilenced(config, deprecation.id));
-    const [first] = pending;
-    const signature = pending.map((deprecation) => deprecation.id).join(",");
-    if (first === undefined || hasShown(root, signature)) {
-        return;
-    }
-    shownRoots.set(root, signature);
-    process.env[SHOWN_ENV] = signature;
-    warn(formatBlock(unset, pending, first));
-};
-export { DEPRECATION_IDS, warnDeprecations };
-//# sourceMappingURL=deprecations.js.map

package/dist/deprecations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deprecations.js","sourceRoot":"","sources":["../src/deprecations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAYnC,MAAM,SAAS,GAAG,yBAAyB,CAAC;AAC5C,MAAM,SAAS,GAAG,uCAAuC,CAAC;AAC1D,MAAM,YAAY,GAAG,EAAE,CAAC;AACxB,MAAM,aAAa,GAAG,8DAA8D,CAAC;AACrF,MAAM,eAAe,GAAG,oDAAoD,CAAC;AAC7E,MAAM,YAAY,GAAG,uEAAuE,CAAC;AAE7F,MAAM,eAAe,GAAG;IACpB,qBAAqB;IACrB,uBAAuB;IACvB,wBAAwB;IACxB,uBAAuB;IACvB,0BAA0B;IAC1B,2BAA2B;IAC3B,sBAAsB;CAChB,CAAC;AAEX,MAAM,mBAAmB,GAAwB;IAC7C;QACI,EAAE,EAAE,qBAAqB;QACzB,IAAI,EAAE,cAAc;QACpB,MAAM,EAAE,4EAA4E;QACpF,SAAS,EAAE,YAAY;KAC1B;IACD;QACI,EAAE,EAAE,uBAAuB;QAC3B,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE,kGAAkG;KAC7G;IACD;QACI,EAAE,EAAE,wBAAwB;QAC5B,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE,+FAA+F;KAC1G;IACD;QACI,EAAE,EAAE,uBAAuB;QAC3B,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE,iFAAiF;KAC5F;IACD;QACI,EAAE,EAAE,0BAA0B;QAC9B,IAAI,EAAE,mBAAmB;QACzB,MAAM,EAAE,8FAA8F;QACtG,SAAS,EAAE,aAAa;KAC3B;IACD;QACI,EAAE,EAAE,2BAA2B;QAC/B,IAAI,EAAE,oBAAoB;QAC1B,MAAM,EAAE,uEAAuE;QAC/E,SAAS,EAAE,eAAe;KAC7B;IACD;QACI,EAAE,EAAE,sBAAsB;QAC1B,IAAI,EAAE,eAAe;QACrB,MAAM,EACF,2CAA2C;YAC3C,uEAAuE;KAC9E;CACJ,CAAC;AAEF,MAAM,UAAU,GAAwB,IAAI,GAAG,EAAE,CAAC;AAElD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAiB,EAAW,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAErH,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAuB,EAAE,CAC9D,mBAAmB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;AAE5F,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAU,EAAE;IAC9D,MAAM,IAAI,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAEjF,OAAO,CACH,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,2BAA2B;QACpF,kDAAkD,IAAI,EAAE,CAC3D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,WAA8B,EAAU,EAAE,CACjE,MAAM,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC;IAC5C,aAAa,WAAW,CAAC,IAAI,iBAAiB,WAAW,CAAC,MAAM,EAAE;IAClE,CAAC,WAAW,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;AAElC,MAAM,YAAY,GAAG,CAAC,OAA4B,EAAU,EAAE;IAC1D,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,KAAK,SAAS,CAAC,EAAE,CAAC;QACtE,OAAO,iFAAiF,CAAC;IAC7F,CAAC;IAED,OAAO,qGAAqG,CAAC;AACjH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAA0B,EAAE,OAA4B,EAAE,KAAwB,EAAU,EAAE,CAC/G;IACI,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC1D,EAAE;IACF,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;IACzE,YAAY,CAAC,OAAO,CAAC;IACrB,cAAc,SAAS,EAAE;IACzB,wCAAwC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK;CACxE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAW,EAAE,CAC1D,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC;AAE/E,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,IAAY,EAAQ,EAAE;IAC5D,MAAM,KAAK,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IACnF,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;IACxB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEzE,IAAI,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;QACnD,OAAO;IACX,CAAC;IAED,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IACnC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAC","sourcesContent":["import { warn } from \"@gtkx/utils\";\nimport type { Config } from \"./config.ts\";\n\ntype DeprecationId = (typeof DEPRECATION_IDS)[number];\n\ntype FutureDeprecation = {\n    id: DeprecationId;\n    flag: keyof NonNullable<Config[\"future\"]>;\n    change: string;\n    unchecked?: string;\n};\n\nconst SHOWN_ENV = \"GTKX_DEPRECATIONS_SHOWN\";\nconst GUIDE_URL = \"https://gtkx.dev/guide/upgrading-to-2\";\nconst ENTRY_COLUMN = 30;\nconst BUILD_REPORTS = \" The build, not tsc, reports the specifiers still to change.\";\nconst NOTHING_REPORTS = \" Nothing reports this one; check the app yourself.\";\nconst SILENT_SITES = \" `Array.isArray` and `JSON.stringify` change silently; grep for them.\";\n\nconst DEPRECATION_IDS = [\n    \"gtkx-v2-byte-arrays\",\n    \"gtkx-v2-value-returns\",\n    \"gtkx-v2-finish-results\",\n    \"gtkx-v2-inout-returns\",\n    \"gtkx-v2-resource-imports\",\n    \"gtkx-v2-default-libraries\",\n    \"gtkx-v2-tree-shaking\",\n] as const;\n\nconst FUTURE_DEPRECATIONS: FutureDeprecation[] = [\n    {\n        id: \"gtkx-v2-byte-arrays\",\n        flag: \"v2ByteArrays\",\n        change: \"Byte sequences come back as number[]. In 2.0 they come back as Uint8Array.\",\n        unchecked: SILENT_SITES,\n    },\n    {\n        id: \"gtkx-v2-value-returns\",\n        flag: \"v2ValueReturns\",\n        change: \"Bindings that return a GValue hand back the box. In 2.0 they hand back its contents, as unknown.\",\n    },\n    {\n        id: \"gtkx-v2-finish-results\",\n        flag: \"v2FinishResults\",\n        change: \"Async pairs with out parameters resolve with a leading success boolean. In 2.0 it is dropped.\",\n    },\n    {\n        id: \"gtkx-v2-inout-returns\",\n        flag: \"v2InoutReturns\",\n        change: \"Inout records repeat in the return value. In 2.0 the repeated entry is dropped.\",\n    },\n    {\n        id: \"gtkx-v2-resource-imports\",\n        flag: \"v2ResourceImports\",\n        change: \"Assets resolve through the #data/ import map. In 2.0 they resolve through ?resource imports.\",\n        unchecked: BUILD_REPORTS,\n    },\n    {\n        id: \"gtkx-v2-default-libraries\",\n        flag: \"v2DefaultLibraries\",\n        change: \"Only Gtk-4.0 is bound by default. In 2.0 Adw-1 is bound alongside it.\",\n        unchecked: NOTHING_REPORTS,\n    },\n    {\n        id: \"gtkx-v2-tree-shaking\",\n        flag: \"v2TreeShaking\",\n        change:\n            \"The stores register every class eagerly. \" +\n            \"In 2.0 each class registers itself and unused ones drop from bundles.\",\n    },\n];\n\nconst shownRoots: Map<string, string> = new Map();\n\nconst isSilenced = (config: Config, id: DeprecationId): boolean => (config.deprecations?.silence ?? []).includes(id);\n\nconst unsetDeprecations = (config: Config): FutureDeprecation[] =>\n    FUTURE_DEPRECATIONS.filter((deprecation) => config.future?.[deprecation.flag] !== true);\n\nconst formatSummary = (unset: number, silenced: number): string => {\n    const note = silenced === 0 ? \"\" : ` ${String(silenced)} of them silenced here.`;\n\n    return (\n        `${String(unset)} of ${String(FUTURE_DEPRECATIONS.length)} future flags are unset. ` +\n        `Their behavior becomes the default in GTKX 2.0.${note}`\n    );\n};\n\nconst formatDeprecation = (deprecation: FutureDeprecation): string =>\n    `  [${deprecation.id}]`.padEnd(ENTRY_COLUMN) +\n    `future: { ${deprecation.flag}: true }\\n    ${deprecation.change}` +\n    (deprecation.unchecked ?? \"\");\n\nconst formatAdvice = (pending: FutureDeprecation[]): string => {\n    if (pending.every((deprecation) => deprecation.unchecked === undefined)) {\n        return \"  Set one flag at a time and run tsc: every affected call site is a type error.\";\n    }\n\n    return \"  Set one flag at a time and run tsc: it reports every affected call site except where noted above.\";\n};\n\nconst formatBlock = (unset: FutureDeprecation[], pending: FutureDeprecation[], first: FutureDeprecation): string =>\n    [\n        formatSummary(unset.length, unset.length - pending.length),\n        \"\",\n        ...pending.flatMap((deprecation) => [formatDeprecation(deprecation), \"\"]),\n        formatAdvice(pending),\n        `  Guide    ${GUIDE_URL}`,\n        `  Silence  deprecations: { silence: [${JSON.stringify(first.id)}] }`,\n    ].join(\"\\n\");\n\nconst hasShown = (root: string, signature: string): boolean =>\n    shownRoots.get(root) === signature || process.env[SHOWN_ENV] === signature;\n\nconst warnDeprecations = (config: Config, root: string): void => {\n    const unset = unsetDeprecations(config);\n    const pending = unset.filter((deprecation) => !isSilenced(config, deprecation.id));\n    const [first] = pending;\n    const signature = pending.map((deprecation) => deprecation.id).join(\",\");\n\n    if (first === undefined || hasShown(root, signature)) {\n        return;\n    }\n\n    shownRoots.set(root, signature);\n    process.env[SHOWN_ENV] = signature;\n    warn(formatBlock(unset, pending, first));\n};\n\nexport { DEPRECATION_IDS, warnDeprecations };\n"]}