@gtkx/cli 1.0.0-rc.1 → 1.0.0-rc.2

package/src/vite-plugins/resource-init-module.ts

@@ -1,54 +1,57 @@
-import { BUNDLE_FILENAME } from "./resource-shared.js";
+import { BUNDLE_FILENAME, REFRESH_EXPORT } from "./resource-shared.js";
 
 const buildInitModuleSource = (): string =>
     [
-        `import { dirname, join } from "node:path";`,
-        `import { fileURLToPath } from "node:url";`,
-        `import { resourceLoad, resourcesRegister } from "@gtkx/gi/gio";`,
-        ``,
-        `const bundleDir = dirname(fileURLToPath(import.meta.url));`,
-        `const resource = resourceLoad(join(bundleDir, ${JSON.stringify(BUNDLE_FILENAME)}));`,
-        `resourcesRegister(resource);`,
-        ``,
-        `export function ensureRegistered() {}`,
-        `export function __refresh() {}`,
+        "import { dirname, join } from \"node:path\";",
+        "import { fileURLToPath } from \"node:url\";",
+        "import { Resource, resourcesRegister } from \"@gtkx/gi/gio\";",
+        "",
+        "const bundleDir = dirname(fileURLToPath(import.meta.url));",
+        `const resource = Resource.load(join(bundleDir, ${JSON.stringify(BUNDLE_FILENAME)}));`,
+        "resourcesRegister(resource);",
+        "",
+        "export function ensureRegistered() {}",
+        `export function ${REFRESH_EXPORT}() {}`,
     ].join("\n");
 
 const devInitModuleSource = (bundlePath: string): string => {
     const bundlePathLiteral = JSON.stringify(bundlePath);
+
     return [
-        `import { existsSync, statSync } from "node:fs";`,
-        `import { resourceLoad, resourcesRegister, resourcesUnregister } from "@gtkx/gi/gio";`,
-        ``,
-        `let current = null;`,
-        `let lastSig = "";`,
-        ``,
-        `function register() {`,
-        `    const next = resourceLoad(${bundlePathLiteral});`,
-        `    if (current) resourcesUnregister(current);`,
-        `    resourcesRegister(next);`,
-        `    current = next;`,
-        `}`,
-        ``,
-        `export function ensureRegistered() {`,
+        "import { existsSync, statSync } from \"node:fs\";",
+        "import { Resource, resourcesRegister, resourcesUnregister } from \"@gtkx/gi/gio\";",
+        "",
+        "let current = null;",
+        "let lastSig = \"\";",
+        "",
+        "function register() {",
+        `    const next = Resource.load(${bundlePathLiteral});`,
+        "    if (current) resourcesUnregister(current);",
+        "    resourcesRegister(next);",
+        "    current = next;",
+        "}",
+        "",
+        "export function ensureRegistered() {",
         `    if (!existsSync(${bundlePathLiteral})) return;`,
         `    const { size, mtimeMs } = statSync(${bundlePathLiteral});`,
-        `    const sig = size + ":" + mtimeMs;`,
-        `    if (sig === lastSig) return;`,
-        `    register();`,
-        `    lastSig = sig;`,
-        `}`,
-        ``,
-        `ensureRegistered();`,
-        ``,
-        `export function __refresh() {`,
+        "    const sig = size + \":\" + mtimeMs;",
+        "    if (sig === lastSig) return;",
+        "    register();",
+        "    lastSig = sig;",
+        "}",
+        "",
+        "ensureRegistered();",
+        "",
+        `export function ${REFRESH_EXPORT}() {`,
         `    if (!existsSync(${bundlePathLiteral})) return;`,
-        `    register();`,
+        "    register();",
         `    const { size, mtimeMs } = statSync(${bundlePathLiteral});`,
-        `    lastSig = size + ":" + mtimeMs;`,
-        `}`,
+        "    lastSig = size + \":\" + mtimeMs;",
+        "}",
     ].join("\n");
 };
 
-export const renderInitModule = (options: { isBuild: boolean; devBundlePath: string }): string =>
+const renderInitModule = (options: { isBuild: boolean; devBundlePath: string }): string =>
     options.isBuild ? buildInitModuleSource() : devInitModuleSource(options.devBundlePath);
+
+export { renderInitModule };

package/src/vite-plugins/resource-shared.ts

@@ -1,27 +1,40 @@
 import { createVirtualNamespace } from "./virtual-module.js";
 
 const VIRTUAL_PREFIX = "\0gtkx-resources:";
+const VIRTUAL_INIT = "\0gtkx-resources-init";
+const BUNDLE_FILENAME = "gtkx.gresource";
+const REL_SEPARATOR = "\0rel=";
+const REFRESH_EXPORT = "__refresh";
+const { isVirtual, toVirtualId, fromVirtualId } = createVirtualNamespace(VIRTUAL_PREFIX);
 
-export const VIRTUAL_INIT = "\0gtkx-resources-init";
-
-export const BUNDLE_FILENAME = "gtkx.gresource";
-
-export const REL_SEPARATOR = "\0rel=";
-
-export const { isVirtual, toVirtualId, fromVirtualId } = createVirtualNamespace(VIRTUAL_PREFIX);
-
-export const escapeXml = (value: string): string =>
+const escapeXml = (value: string): string =>
     value.replaceAll(/[<>&"']/g, (char) => {
         switch (char) {
-            case "<":
+            case "<": {
                 return "&lt;";
-            case ">":
+            }
+            case ">": {
                 return "&gt;";
-            case "&":
+            }
+            case "&": {
                 return "&amp;";
-            case '"':
+            }
+            case "\"": {
                 return "&quot;";
-            default:
+            }
+            default: {
                 return "&apos;";
+            }
         }
     });
+
+export {
+    VIRTUAL_INIT,
+    BUNDLE_FILENAME,
+    REL_SEPARATOR,
+    REFRESH_EXPORT,
+    escapeXml,
+    isVirtual,
+    toVirtualId,
+    fromVirtualId,
+};

package/src/vite-plugins/resources.ts

@@ -1,10 +1,10 @@
+import type { Plugin, ResolvedConfig, UserConfig, ViteDevServer } from "vite";
+import { type ConfigLoader, createConfigLoader } from "@gtkx/config/internal";
+import { error, formatChildProcessError, info, sortStrings } from "@gtkx/utils";
 import { execFileSync } from "node:child_process";
 import { copyFileSync, mkdirSync, mkdtempSync, readFileSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { dirname, join } from "node:path";
-import { type ConfigLoader, createConfigLoader } from "@gtkx/config/internal";
-import { error, formatChildProcessError, info } from "@gtkx/utils";
-import type { Plugin, ResolvedConfig, UserConfig, ViteDevServer } from "vite";
 import { DATA_IMPORT_PREFIX, resolveDataDir } from "../internal/data-dir.js";
 import { type ListedFile, listFilesRecursive } from "../internal/list-files.js";
 import { resolveCliTool } from "../internal/resolve-cli-tool.js";
@@ -16,22 +16,12 @@ import {
     escapeXml,
     fromVirtualId,
     isVirtual,
+    REFRESH_EXPORT,
     REL_SEPARATOR,
     toVirtualId,
     VIRTUAL_INIT,
 } from "./resource-shared.js";
-
-const DATA_PREFIX = `${DATA_IMPORT_PREFIX}/`;
-
-const RESOURCE_COMPILER = "glib-compile-resources";
-const MANIFEST_PREFIX = "/";
-
-const deriveResourcePrefix = (applicationId: string): string => `/${applicationId.replaceAll(".", "/")}`;
-
-const stripQuery = (source: string): string => {
-    const queryIndex = source.indexOf("?");
-    return queryIndex === -1 ? source : source.slice(0, queryIndex);
-};
+import { stripQuery } from "./strip-query.js";
 
 type ResourceEntry = {
     sourcePath: string;
@@ -51,32 +41,44 @@ type PluginState = {
     dataDir: string | null;
 };
 
+const DATA_PREFIX = `${DATA_IMPORT_PREFIX}/`;
+const RESOURCE_COMPILER = "glib-compile-resources";
+const MANIFEST_PREFIX = "/";
+
+const deriveResourcePrefix = (applicationId: string): string => `/${applicationId.replaceAll(".", "/")}`;
+
 const compileBundle = (state: PluginState, outputPath: string): Buffer =>
     withStagingDir("resources", (dir) => {
         const manifest = stageBundle(dir, state.entries);
+
         return runCompiler(dir, manifest, outputPath);
     });
 
 const stageBundle = (dir: string, entries: Map<string, ResourceEntry>): string => {
     const fileNodes: string[] = [];
+
     for (const entry of entries.values()) {
         const targetPath = join(dir, entry.stagedRelPath);
         mkdirSync(dirname(targetPath), { recursive: true });
         copyFileSync(entry.sourcePath, targetPath);
         fileNodes.push(`        <file>${escapeXml(entry.stagedRelPath)}</file>`);
     }
+
     const prefix = escapeXml(MANIFEST_PREFIX);
     const manifest = join(dir, "gtkx.gresource.xml");
+
     const xml = [
-        `<?xml version="1.0" encoding="UTF-8"?>`,
-        `<gresources>`,
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
+        "<gresources>",
         `    <gresource prefix="${prefix}">`,
         ...fileNodes,
-        `    </gresource>`,
-        `</gresources>`,
-        ``,
+        "    </gresource>",
+        "</gresources>",
+        "",
     ].join("\n");
+
     writeFileSync(manifest, xml);
+
     return manifest;
 };
 
@@ -89,42 +91,63 @@ const runCompiler = (sourceDir: string, manifest: string, outputPath: string): B
         ]);
     } catch (error) {
         const details = formatChildProcessError(error);
-        throw new Error(`${RESOURCE_COMPILER} failed${details ? `:\n${details}` : ""}`, { cause: error });
+        const suffix = details ? `:\n${details}` : "";
+        throw new Error(`${RESOURCE_COMPILER} failed${suffix}`, { cause: error });
     }
+
     return readFileSync(outputPath);
 };
 
 const ensureStagingDir = (state: PluginState): void => {
-    if (!state.devStagingDir) {
-        state.devStagingDir = mkdtempSync(join(tmpdir(), "gtkx-resources-dev-"));
-        state.devBundlePath = join(state.devStagingDir, BUNDLE_FILENAME);
+    if (state.devStagingDir) {
+        return;
     }
+
+    state.devStagingDir = mkdtempSync(join(tmpdir(), "gtkx-resources-dev-"));
+    state.devBundlePath = join(state.devStagingDir, BUNDLE_FILENAME);
 };
 
-const entriesSignature = (state: PluginState): string =>
-    [...state.entries.keys()].sort((a, b) => a.localeCompare(b)).join("\0");
+const entriesSignature = (state: PluginState): string => sortStrings(state.entries.keys()).join("\0");
 
 const compileDevBundle = (state: PluginState): void => {
     ensureStagingDir(state);
-    if (state.entries.size === 0) return;
+
+    if (state.entries.size === 0) {
+        return;
+    }
+
     compileBundle(state, state.devBundlePath);
     state.compiledSignature = entriesSignature(state);
 };
 
+const isRefreshHook = (value: unknown): value is () => void => typeof value === "function";
+
 const reregisterDevBundle = async (state: PluginState): Promise<void> => {
     const server = state.server;
-    if (!server) return;
-    const mod = (await server.ssrLoadModule(VIRTUAL_INIT)) as { __refresh?: () => void };
-    mod.__refresh?.();
+
+    if (!server) {
+        return;
+    }
+
+    const mod = await server.ssrLoadModule(VIRTUAL_INIT);
+    const refresh: unknown = mod[REFRESH_EXPORT];
+
+    if (isRefreshHook(refresh)) {
+        refresh();
+    }
 };
 
 const scanDataAssets = (dataDir: string): ListedFile[] => listFilesRecursive(dataDir, (name) => ASSET_RE.test(name));
 
 const primeDevBundle = (state: PluginState): void => {
-    if (state.dataDir === null) return;
+    if (state.dataDir === null) {
+        return;
+    }
+
     for (const { absPath, rel } of scanDataAssets(state.dataDir)) {
         registerEntry(state, absPath, rel);
     }
+
     compileDevBundle(state);
 };
 
@@ -136,21 +159,56 @@ const registerDevAsset = (state: PluginState): void => {
 
 const registerEntry = (state: PluginState, absPath: string, rel: string): ResourceEntry => {
     const existing = state.entries.get(absPath);
-    if (existing) return existing;
+
+    if (existing) {
+        return existing;
+    }
 
     const resourcePath = `${state.prefix}/${rel}`;
+
     const entry: ResourceEntry = {
         sourcePath: absPath,
         stagedRelPath: resourcePath.replace(/^\/+/, ""),
         resourcePath,
     };
+
     state.entries.set(absPath, entry);
     state.sourcePaths.add(absPath);
+
     return entry;
 };
 
 const isTrackedSource = (state: PluginState, file: string): boolean => state.sourcePaths.has(file);
 
+const dataAssetSource = (source: string): string | null => {
+    const clean = stripQuery(source);
+
+    if (!clean.startsWith(DATA_PREFIX) || !ASSET_PATH_RE.test(clean)) {
+        return null;
+    }
+
+    return clean;
+};
+
+const resolvedAssetId = (
+    resolved: { id: string; external: boolean | string } | null,
+    clean: string,
+): string | undefined => {
+    if (!resolved || resolved.external) {
+        return undefined;
+    }
+
+    return toVirtualId(resolved.id) + REL_SEPARATOR + clean.slice(DATA_PREFIX.length);
+};
+
+const loadInitModule = (state: PluginState): string => {
+    if (!state.isBuild) {
+        ensureStagingDir(state);
+    }
+
+    return renderInitModule({ isBuild: state.isBuild, devBundlePath: state.devBundlePath });
+};
+
 const loadAssetModule = (state: PluginState, virtualId: string): string => {
     const rest = fromVirtualId(virtualId);
     const separatorIndex = rest.indexOf(REL_SEPARATOR);
@@ -165,7 +223,7 @@ const loadAssetModule = (state: PluginState, virtualId: string): string => {
 
     return [
         `import { ensureRegistered } from ${JSON.stringify(VIRTUAL_INIT)};`,
-        `ensureRegistered();`,
+        "ensureRegistered();",
         `export default ${JSON.stringify(uri)};`,
         `export const path = ${JSON.stringify(entry.resourcePath)};`,
     ].join("\n");
@@ -175,42 +233,81 @@ const emitBuildBundle = (
     ctx: { emitFile: (asset: { type: "asset"; fileName: string; source: Buffer }) => string },
     state: PluginState,
 ): void => {
-    if (!state.isBuild || state.entries.size === 0) return;
+    if (!state.isBuild || state.entries.size === 0) {
+        return;
+    }
+
     const compiled = withStagingDir("resources-out", (outDir) => compileBundle(state, join(outDir, BUNDLE_FILENAME)));
     ctx.emitFile({ type: "asset", fileName: BUNDLE_FILENAME, source: compiled });
-    info(`Compiled ${state.entries.size} resource(s) into ${BUNDLE_FILENAME}`);
+    info(`Compiled ${String(state.entries.size)} resource(s) into ${BUNDLE_FILENAME}`);
 };
 
 const refreshDevRegistration = async (state: PluginState): Promise<void> => {
     compileDevBundle(state);
+
     try {
         await reregisterDevBundle(state);
-    } catch (cause) {
-        error("Failed to refresh GResource bundle:", cause);
+    } catch (error_) {
+        error("Failed to refresh GResource bundle:", error_);
     }
 };
 
 const resolveResourceConfig = async (state: PluginState, config: UserConfig, loadConfig: ConfigLoader) => {
     const { applicationId } = await loadConfig(config.root ?? process.cwd());
     state.prefix = deriveResourcePrefix(applicationId);
+
     return {
         assetsInclude: [ASSET_RE],
     };
 };
 
+const refreshTrackedSource = async (state: PluginState, file: string): Promise<void> => {
+    if (!isTrackedSource(state, file)) {
+        return;
+    }
+
+    try {
+        await refreshDevRegistration(state);
+    } catch (error_) {
+        error("GResource refresh failed:", error_);
+    }
+};
+
 const attachResourceWatcher = (state: PluginState, server: ViteDevServer): void => {
     state.server = server;
+
     const onFileEvent = (file: string): void => {
-        if (!isTrackedSource(state, file)) return;
-        refreshDevRegistration(state).catch((cause) => {
-            error("GResource refresh failed:", cause);
-        });
+        void refreshTrackedSource(state, file);
     };
+
     server.watcher.on("change", onFileEvent);
     server.watcher.on("add", onFileEvent);
 };
 
-export function gtkxResources(loadConfig: ConfigLoader = createConfigLoader()): Plugin {
+const applyResolvedConfig = (state: PluginState, config: ResolvedConfig): void => {
+    state.isBuild = config.command === "build";
+
+    if (state.isBuild) {
+        return;
+    }
+
+    const relativeDataDir = resolveDataDir(config.root);
+    state.dataDir = relativeDataDir === null ? null : join(config.root, relativeDataDir);
+};
+
+const loadResourceModule = (state: PluginState, id: string): string | undefined => {
+    if (id === VIRTUAL_INIT) {
+        return loadInitModule(state);
+    }
+
+    if (!isVirtual(id)) {
+        return undefined;
+    }
+
+    return loadAssetModule(state, id);
+};
+
+function gtkxResources(loadConfig: ConfigLoader = createConfigLoader()): Plugin {
     const state: PluginState = {
         prefix: "",
         isBuild: false,
@@ -232,11 +329,7 @@ export function gtkxResources(loadConfig: ConfigLoader = createConfigLoader()):
         },
 
         configResolved(config: ResolvedConfig) {
-            state.isBuild = config.command === "build";
-            if (!state.isBuild) {
-                const relativeDataDir = resolveDataDir(config.root);
-                state.dataDir = relativeDataDir === null ? null : join(config.root, relativeDataDir);
-            }
+            applyResolvedConfig(state, config);
         },
 
         configureServer(server) {
@@ -245,24 +338,23 @@ export function gtkxResources(loadConfig: ConfigLoader = createConfigLoader()):
         },
 
         async resolveId(source, importer, opts) {
-            if (source === VIRTUAL_INIT) return VIRTUAL_INIT;
-            const clean = stripQuery(source);
-            if (!clean.startsWith(DATA_PREFIX) || !ASSET_PATH_RE.test(clean)) return;
+            if (source === VIRTUAL_INIT) {
+                return VIRTUAL_INIT;
+            }
+
+            const clean = dataAssetSource(source);
+
+            if (clean === null) {
+                return;
+            }
 
             const resolved = await this.resolve(clean, importer, { ...opts, skipSelf: true });
-            if (!resolved || resolved.external) return;
 
-            const rel = clean.slice(DATA_PREFIX.length);
-            return toVirtualId(resolved.id) + REL_SEPARATOR + rel;
+            return resolvedAssetId(resolved, clean);
         },
 
         load(id) {
-            if (id === VIRTUAL_INIT) {
-                if (!state.isBuild) ensureStagingDir(state);
-                return renderInitModule({ isBuild: state.isBuild, devBundlePath: state.devBundlePath });
-            }
-            if (!isVirtual(id)) return;
-            return loadAssetModule(state, id);
+            return loadResourceModule(state, id);
         },
 
         buildEnd() {
@@ -270,3 +362,5 @@ export function gtkxResources(loadConfig: ConfigLoader = createConfigLoader()):
         },
     };
 }
+
+export { gtkxResources };

package/src/vite-plugins/settings-worker-env.ts

@@ -3,7 +3,7 @@ import type { Plugin } from "vitest/config";
 import { resolveDataDir } from "../internal/data-dir.js";
 import { prependSchemaDir, stageAndCompileProjectSchemas } from "../settings/schema.js";
 
-export function gtkxSettingsWorkerEnv(): Plugin {
+function gtkxSettingsWorkerEnv(): Plugin {
     return {
         name: "gtkx:settings-worker-env",
         enforce: "pre",
@@ -11,7 +11,10 @@ export function gtkxSettingsWorkerEnv(): Plugin {
         config(config: UserConfig) {
             const root = config.root ?? process.cwd();
             const dir = stageAndCompileProjectSchemas(root, resolveDataDir(root));
-            if (dir === null) return;
+
+            if (dir === null) {
+                return;
+            }
 
             process.env.GTKX_DEV_SCHEMA_DIR = dir;
 
@@ -23,3 +26,5 @@ export function gtkxSettingsWorkerEnv(): Plugin {
         },
     };
 }
+
+export { gtkxSettingsWorkerEnv };