@gtkx/config 1.6.0 → 2.0.0-beta.10

package/src/deploy.ts

@@ -14,6 +14,7 @@ const APPIMAGE_COMPRESSIONS = ["gzip", "xz", "zstd"] as const;
 const DEB_COMPRESSIONS = ["gzip", "none", "xz", "zstd"] as const;
 const DEB_SIGN_METHODS = ["debsign", "dpkg-sig"] as const;
 const DEB_SIGN_TYPES = ["archive", "maint", "origin"] as const;
+const DEPLOY_ARCH_NAMES = ["arm64", "x64"] as const;
 const DEPLOY_TARGET_NAMES = ["appimage", "deb", "flatpak", "rpm"] as const;
 const FLATPAK_MODES = ["prebuilt", "source"] as const;
 const NODE_SOURCES = ["download", "host", "path"] as const;
@@ -37,16 +38,22 @@ const URL_KINDS = [
 const BOOLEAN_ERROR = "must be a boolean";
 const EPOCH_ERROR = "must be a non-negative integer";
 const EXTRA_FILE_ERROR = "must be a source path or a { source, mode } entry";
-const FILE_MODE_ERROR = "must be an octal file mode such as 755";
+const FILE_MODE_ERROR = "must be an octal file mode without setuid or setgid bits, such as 755";
 const FILE_MODE_PATTERN = /^[0-7]{3,4}$/;
+const FILE_MODE_RADIX = 8;
+const PRIVILEGED_FILE_MODE_MASK = 0o6000;
 const HEX_COLOR_ERROR = "must be a #rrggbb color";
 const HEX_COLOR_PATTERN = /^#[\dA-Fa-f]{6}$/;
 const KEY_FILE_ERROR = "must be a path to a PGP key file";
 const KEY_ID_ERROR = "must be a PGP key id";
+const LAUNCHER_ENV_ERROR = "must be a record of POSIX environment names to values without null bytes";
+const LAUNCHER_ENV_NAME_ERROR = "must be a POSIX environment name";
+const LAUNCHER_ENV_NAME_PATTERN = /^[A-Za-z_]\w*$/;
 const MINIMUM_LIBRARY_VERSION_ERROR = "must be a version such as 4.18";
 const MINIMUM_LIBRARY_VERSION_PATTERN = /^\d+(?:\.\d+)*$/;
 const MINIMUM_LIBRARY_VERSIONS_ERROR = "must be a record of GIR library ids to a minimum version";
-const LIBRARY_ID_ERROR = 'must be a GIR library identifier of the form "Name-Version", such as "Gtk-4.0"';
+const NODE_FLAG_ERROR = "must be a Node.js flag beginning with a hyphen and containing no null bytes";
+const LIBRARY_ID_ERROR = 'must be a GIR library identifier of the form "Name-Version", such as "Adw-1"';
 const SCRIPT_ERROR = "must be a path to a shell script";
 const SOURCE_PATH_ERROR = "must be a source path";
 const SPDX_ERROR = "must be an SPDX license expression";
@@ -110,16 +117,55 @@ const brandingSchema = z.strictObject({
     dark: hexColorSchema,
 });
 
-const extraFileSchema = z.strictObject({
+/**
+ * A `deploy.extraFiles` entry in object form: the source file, resolved against the project root, that is
+ * installed at the entry's prefix-relative destination, and the octal mode it is installed with.
+ */
+type DeployExtraFileOptions = Record<"source", string> & {
+    /** Octal file mode. Setuid and setgid bits are rejected. */
+    mode?: string | undefined;
+};
+const extraFileSchema: z.ZodType<DeployExtraFileOptions> = z.strictObject({
     source: text(SOURCE_PATH_ERROR),
-    mode: z.string({ error: FILE_MODE_ERROR }).regex(FILE_MODE_PATTERN, { error: FILE_MODE_ERROR }).optional(),
+    mode: z
+        .string({ error: FILE_MODE_ERROR })
+        .regex(FILE_MODE_PATTERN, { error: FILE_MODE_ERROR })
+        .refine((mode) => (Number.parseInt(mode, FILE_MODE_RADIX) & PRIVILEGED_FILE_MODE_MASK) === 0, {
+            error: FILE_MODE_ERROR,
+        })
+        .optional(),
 });
 
 const extraFileEntrySchema = z.union([text(SOURCE_PATH_ERROR), extraFileSchema], { error: EXTRA_FILE_ERROR });
 
-const nodeRuntimeSchema = z.strictObject({
+const launcherEnvSchema = z.record(
+    z.string({ error: LAUNCHER_ENV_NAME_ERROR }).regex(LAUNCHER_ENV_NAME_PATTERN, { error: LAUNCHER_ENV_NAME_ERROR }),
+    z.string({ error: LAUNCHER_ENV_ERROR }).refine((value) => !value.includes("\0"), { error: LAUNCHER_ENV_ERROR }),
+    { error: (issue) => issue.code === "invalid_key" ? LAUNCHER_ENV_NAME_ERROR : LAUNCHER_ENV_ERROR },
+);
+
+const nodeFlagsSchema = z.array(
+    z
+        .string({ error: NODE_FLAG_ERROR })
+        .refine((value) => value.startsWith("-") && !value.includes("\0"), { error: NODE_FLAG_ERROR }),
+    { error: "must be an array of Node.js flags" },
+);
+
+/**
+ * The `deploy.node` options: where the Node.js runtime bundled with the application comes from, the version it
+ * is expected to be, whether its binary is stripped, and whether the launcher enables the compile cache.
+ */
+type DeployNodeOptions = Partial<
+    Record<"source", "download" | "host" | "path" | undefined> &
+    Record<"path", string | undefined> &
+    Record<"shouldStrip" | "shouldUseCompileCache", boolean | undefined>
+> & {
+    /** Expected Node.js version. Downloaded runtimes default to exactly 26.7.0 when omitted. */
+    version?: string | undefined;
+};
+const nodeRuntimeSchema: z.ZodType<DeployNodeOptions> = 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(),
@@ -229,6 +275,11 @@ const deploySchema = z.strictObject({
             error: "must be an array of deploy targets",
         })
         .optional(),
+    architectures: z
+        .array(z.enum(DEPLOY_ARCH_NAMES, { error: "must be one of arm64, x64" }), {
+            error: "must be an array of deploy architectures",
+        })
+        .optional(),
     outDir: text("must be a directory path relative to the project root").optional(),
     name: text("must be the display name shown in the launcher").optional(),
     genericName: text("must be a generic application name").optional(),
@@ -262,6 +313,8 @@ const deploySchema = z.strictObject({
         .optional(),
     releases: z.array(releaseSchema, { error: "must be an array of releases" }).optional(),
     execArgs: textList("argument", "must be an array of arguments appended to Exec").optional(),
+    launcherEnv: launcherEnvSchema.optional(),
+    nodeFlags: nodeFlagsSchema.optional(),
     fileAssociations: z
         .array(fileAssociationSchema, { error: "must be an array of file associations" })
         .optional(),
@@ -271,6 +324,7 @@ const deploySchema = z.strictObject({
         .optional(),
     desktopEntry: textRecord("must be a desktop entry value", "must be a record of desktop entry keys to values")
         .optional(),
+    metainfoExtra: textList("AppStream XML fragment", "must be an array of AppStream XML fragments").optional(),
     isDbusActivatable: flag(BOOLEAN_ERROR).optional(),
     extraFiles: relativePathRecord(
         "must be a destination path inside the install prefix, without a leading slash or a .. segment",
@@ -289,4 +343,4 @@ const deploySchema = z.strictObject({
     rpm: rpmSchema.optional(),
 });
 
-export { deploySchema };
+export { deploySchema, type DeployExtraFileOptions, type DeployNodeOptions };

package/src/index.ts

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

package/src/internal.ts

@@ -1,4 +1,5 @@
-export type { McpSettings, ResolvedFuture, ResolvedReactCompilerOptions } from "./config.ts";
+export { configDependenciesFor } from "./config-dependencies.ts";
+export type { McpSettings, ResolvedReactCompilerOptions } from "./config.ts";
 export {
     APPLICATION_ID_MAX_LENGTH,
     isAgentReferenceEnabled,
@@ -6,11 +7,11 @@ export {
     isValidApplicationId,
     resolveElementComponents,
     resolveElementProps,
-    resolveFuture,
     resolveLazyElements,
     resolveMcpSettings,
     resolveOmittedProps,
-    unknownFutureKeys,
 } from "./config.ts";
 export { createConfigLoader } from "./loader.ts";
+export { assertSupportedNodeVersion, MINIMUM_NODE_VERSION } from "./node-version.ts";
 export { resourceBasePath } from "./resource-base-path.ts";
+export { viteProjectRoot } from "./vite-root.ts";

package/src/loader.ts

@@ -1,10 +1,21 @@
-import { getOrInsert } from "@gtkx/utils";
+import { isPathInside, warn } from "@gtkx/utils";
 import { loadConfig as loadConfigFile } from "c12";
 import { existsSync } from "node:fs";
-import { resolve } from "node:path";
+import { basename, extname, isAbsolute, relative, resolve } from "node:path";
+import {
+    captureConfigDependencies,
+    setConfigDependencies,
+    transformConfigModule,
+} from "./config-dependencies.ts";
 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";
+import { assertSupportedNodeVersion } from "./node-version.ts";
 
 /** Result of loading a project's `gtkx.config.ts` file. */
 type LoadedConfig = {
@@ -23,7 +34,7 @@ type LoadConfigOptions = {
      * top-level values, and the name is passed to a config authored as a function.
      */
     mode?: string | undefined;
-};
+} & Partial<Record<"configFile", string | undefined>>;
 
 /** Reads a project's configuration once per directory, caching what it loads and what it resolves. */
 type ConfigLoader = {
@@ -33,51 +44,147 @@ type ConfigLoader = {
     resolve: (cwd: string) => Promise<ResolvedConfig>;
 };
 
+const GRADUATED_FUTURE_ENV = "GTKX_GRADUATED_FUTURE_SHOWN";
+const graduatedFutureWarnings: Map<string, string> = new Map();
+
+type ConfigResolutionOptions = { configFile?: string | undefined; cwd?: string | undefined };
+
+const isLocalConfigSource = (source: string): boolean => source.startsWith(".") || isAbsolute(source);
+
+const isDirectoryConfigSource = (source: string): boolean => {
+    const extension = extname(source);
+
+    return extension.length === 0 || extension === basename(source);
+};
+
+const localConfigSourcePath = (source: string, options: ConfigResolutionOptions): string | undefined => {
+    if (source === "." || !isLocalConfigSource(source)) {
+        return undefined;
+    }
+
+    const cwd = options.cwd ?? process.cwd();
+
+    return isDirectoryConfigSource(source)
+        ? resolve(cwd, source, options.configFile ?? "gtkx.config")
+        : resolve(cwd, source);
+};
+
+const rejectMissingLocalConfig = (source: string, options: ConfigResolutionOptions): undefined => {
+    const path = localConfigSourcePath(source, options);
+
+    if (path !== undefined && !existsSync(path)) {
+        throw new Error(`Extended configuration does not exist at ${path}`);
+    }
+};
+
+const withConfigDependencies = <T>(dependencies: string[], operation: () => T): T => {
+    try {
+        return operation();
+    } catch (error) {
+        if (typeof error === "object" && error !== null) {
+            setConfigDependencies(error, dependencies);
+        }
+
+        throw error;
+    }
+};
+
+const selectedConfigFile = (root: string, configured: string | undefined): string | undefined => {
+    if (configured === undefined) {
+        return undefined;
+    }
+
+    const path = resolve(root, configured);
+
+    if (!isPathInside(root, path)) {
+        throw new Error(`Configuration file ${configured} must be inside the project root ${root}`);
+    }
+
+    return relative(root, path);
+};
+
+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.
  */
 const loadConfig = async (cwd: string, options: LoadConfigOptions = {}): Promise<LoadedConfig> => {
+    assertSupportedNodeVersion();
     const searched = resolve(cwd);
+    const requestedConfigFile = selectedConfigFile(searched, options.configFile);
 
-    const result = await loadConfigFile<Config>({
-        name: "gtkx",
-        cwd: searched,
-        rcFile: false,
-        globalRc: false,
-        packageJson: false,
-        context: { mode: options.mode },
-        ...((options.mode !== undefined) && { envName: options.mode }),
-    });
+    const captured = await captureConfigDependencies(() =>
+        loadConfigFile<Config>({
+            name: "gtkx",
+            cwd: searched,
+            rcFile: false,
+            globalRc: false,
+            packageJson: false,
+            context: { mode: options.mode },
+            jitiOptions: { fsCache: false, transform: transformConfigModule },
+            resolve: rejectMissingLocalConfig,
+            ...(requestedConfigFile !== undefined && { configFile: requestedConfigFile }),
+            ...((options.mode !== undefined) && { envName: options.mode }),
+        }));
+    const result = captured.value;
 
     const configFile = result.configFile;
+    const root = result.cwd ?? searched;
+    const layerFiles = (result.layers ?? [])
+        .flatMap((layer) => layer.configFile === undefined
+            ? []
+            : [resolve(layer.cwd ?? root, layer.configFile)]);
+    const dependencies = [
+        ...(configFile === undefined ? [] : [configFile]),
+        ...layerFiles,
+        ...captured.dependencies,
+    ];
 
-    if (configFile === undefined || !existsSync(resolve(searched, configFile))) {
-        throw missingConfigFileError(searched);
-    }
+    return withConfigDependencies(dependencies, () => {
+        if (configFile === undefined || !existsSync(resolve(searched, configFile))) {
+            throw missingConfigFileError(searched, requestedConfigFile);
+        }
 
-    const config = result.config;
-    const root = result.cwd ?? searched;
-    validateConfig(config);
-    warnDeprecations(config, root);
+        const config = result.config;
+        validateConfig(config, configFile);
+        warnGraduatedFuture(config, root);
 
-    return {
-        config,
-        configFile,
-        root,
-    };
+        const loaded = {
+            config,
+            configFile,
+            root,
+        };
+        setConfigDependencies(loaded, dependencies);
+
+        return loaded;
+    });
 };
 
 const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
+    assertSupportedNodeVersion();
     const loaded: Map<string, Promise<LoadedConfig>> = new Map();
     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 +194,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/node-version.ts

@@ -0,0 +1,16 @@
+const MINIMUM_NODE_MAJOR = 26;
+const MINIMUM_NODE_MINOR = 7;
+const MINIMUM_NODE_VERSION = "26.7.0";
+
+const assertSupportedNodeVersion = (): void => {
+    const [major = 0, minor = 0] = process.versions.node.split(".").map(Number);
+    const isSupported = major > MINIMUM_NODE_MAJOR || (major === MINIMUM_NODE_MAJOR && minor >= MINIMUM_NODE_MINOR);
+
+    if (!isSupported) {
+        throw new Error(
+            `GTKX requires Node.js ${MINIMUM_NODE_VERSION} or newer. Current version: ${process.versions.node}.`,
+        );
+    }
+};
+
+export { assertSupportedNodeVersion, MINIMUM_NODE_VERSION };

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/src/vite-plugin.ts

@@ -1,13 +1,17 @@
 import type { Plugin, UserConfig } from "vite";
 import { type ConfigLoader, createConfigLoader } from "./loader.ts";
 import { GTKX_CONFIG_VIRTUAL_ID, renderConfigModule, RESOLVED_GTKX_CONFIG_VIRTUAL_ID } from "./virtual.ts";
+import { viteProjectRoot } from "./vite-root.ts";
 
 /** State the plugin carries from Vite's `config` hook to the virtual module it serves. */
 type PluginState = {
-    /** Project root taken from Vite's `config` hook, undefined when the user config leaves it unset. */
-    root: string | undefined;
+    /** Project root taken from Vite's `config` hook, falling back to the working directory. */
+    root: string;
 };
 
+const VIRTUAL_ID_RE = new RegExp(`^${GTKX_CONFIG_VIRTUAL_ID}$`);
+const RESOLVED_VIRTUAL_ID_RE = new RegExp(`^${RESOLVED_GTKX_CONFIG_VIRTUAL_ID}$`);
+
 const resolveVirtualId = (id: string): string | null =>
     id === GTKX_CONFIG_VIRTUAL_ID ? RESOLVED_GTKX_CONFIG_VIRTUAL_ID : null;
 
@@ -20,7 +24,7 @@ const loadVirtualModule = async (
         return undefined;
     }
 
-    return renderConfigModule(await loadConfig.resolve(state.root ?? process.cwd()));
+    return renderConfigModule(await loadConfig.resolve(state.root));
 };
 
 /**
@@ -36,17 +40,23 @@ const createConfigPlugin = (options: {
     config?: (config: UserConfig) => Omit<UserConfig, "plugins">;
 }): Plugin => {
     const loadConfig = options.loadConfig ?? createConfigLoader();
-    const state: PluginState = { root: undefined };
+    const state: PluginState = { root: process.cwd() };
 
     return {
         name: options.name,
         config(config: UserConfig) {
-            state.root = config.root ?? state.root;
+            state.root = viteProjectRoot(config);
 
             return options.config?.(config);
         },
-        resolveId: (id: string) => resolveVirtualId(id),
-        load: (id: string) => loadVirtualModule(id, loadConfig, state),
+        resolveId: {
+            filter: { id: VIRTUAL_ID_RE },
+            handler: (id: string) => resolveVirtualId(id),
+        },
+        load: {
+            filter: { id: RESOLVED_VIRTUAL_ID_RE },
+            handler: (id: string) => loadVirtualModule(id, loadConfig, state),
+        },
     };
 };
 

package/src/vite-root.ts

@@ -0,0 +1,8 @@
+type RootConfig = {
+    root?: string | undefined;
+    test?: { root?: string | undefined } | undefined;
+};
+
+const viteProjectRoot = (config: RootConfig): string => config.test?.root ?? config.root ?? process.cwd();
+
+export { viteProjectRoot };

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"]}