@gtkx/cli 1.3.0 → 1.4.0

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

@@ -1,16 +1,20 @@
 import type { UserConfig } from "vite";
 import type { Plugin } from "vitest/config";
+import { createConfigLoader } from "@gtkx/config/internal";
 import { resolveDataDir } from "../internal/data-dir.js";
 import { prependSchemaDir, stageAndCompileProjectSchemas } from "../settings/schema.js";
 
 function gtkxSettingsWorkerEnv(): Plugin {
+    const loadConfig = createConfigLoader();
+
     return {
         name: "gtkx:settings-worker-env",
         enforce: "pre",
 
-        config(config: UserConfig) {
-            const root = config.root ?? process.cwd();
-            const dir = stageAndCompileProjectSchemas(root, resolveDataDir(root));
+        async config(config: UserConfig) {
+            const loaded = await loadConfig.load(config.root ?? process.cwd());
+            const dataDir = loaded.config.future?.v2ResourceImports === true ? null : resolveDataDir(loaded.root);
+            const dir = stageAndCompileProjectSchemas(loaded.root, dataDir);
 
             if (dir === null) {
                 return;

package/src/vite-plugins/settings.ts

@@ -1,7 +1,9 @@
+import type { ConfigLoader } from "@gtkx/config";
 import type { ModuleNode, Plugin, ResolvedConfig, UserConfig, ViteDevServer } from "vite";
-import { error, errorMessage, info } from "@gtkx/utils";
+import { error, errorMessage, info, sortStrings } from "@gtkx/utils";
 import { readFileSync } from "node:fs";
 import { basename, join } from "node:path";
+import type { BuildManifestCollector } from "../internal/build-manifest.js";
 import type { AssetEmitter } from "./asset-emitter.js";
 import { prependBanner } from "../internal/banner.js";
 import { resolveDataDir } from "../internal/data-dir.js";
@@ -9,14 +11,23 @@ import { createRetainedStagingDir, type RetainedStagingDir, withStagingDir } fro
 import { compileSchemas } from "../settings/compile.js";
 import { parseSchemaXml, SchemaParseError } from "../settings/parser.js";
 import { renderRuntimeModule } from "../settings/render.js";
-import { emitSchemaEnv, prependSchemaDir, SCHEMA_SUFFIX, stageSchema } from "../settings/schema.js";
+import {
+    assertUniqueSchemaBasenames,
+    emitSchemaEnv,
+    prependSchemaDir,
+    projectRelativeSchemaPath,
+    SCHEMA_SUFFIX,
+    stageSchema,
+} from "../settings/schema.js";
 import { createVirtualNamespace } from "./virtual-module.js";
 
 type PluginState = {
     schemaDir: RetainedStagingDir;
     rootDir: string | null;
     dataDir: string | null;
+    isV2ResourceImports: boolean;
     isBuild: boolean;
+    schemaEnvTimer: ReturnType<typeof setTimeout> | null;
     trackedSchemas: Map<string, string>;
     buildSchemas: Set<string>;
 };
@@ -27,6 +38,8 @@ type PluginContext = AssetEmitter & {
 
 const VIRTUAL_PREFIX = "\0gtkx-settings:";
 const SCHEMA_STAGING_PREFIX = "schemas";
+const SOURCE_MODULE_RE = /\.[cm]?[jt]sx?$/;
+const SCHEMA_ENV_DEBOUNCE_MS = 50;
 const { isVirtual, fromVirtualId, resolveToVirtual } = createVirtualNamespace(VIRTUAL_PREFIX);
 
 const SCHEMA_ENV_BANNER = [
@@ -67,14 +80,34 @@ const syncSchemaEnv = (state: PluginState): void => {
     }
 
     try {
-        emitSchemaEnv(state.rootDir, state.dataDir);
+        emitSchemaEnv(state.rootDir, state.dataDir, state.isV2ResourceImports);
     } catch (error_) {
         error(`Failed to generate GSettings schema types: ${errorMessage(error_)}`);
     }
 };
 
-const applyUserConfig = (state: PluginState, config: UserConfig): void => {
-    state.dataDir = resolveDataDir(config.root ?? process.cwd());
+const cancelSchemaEnvSync = (state: PluginState): void => {
+    if (state.schemaEnvTimer === null) {
+        return;
+    }
+
+    clearTimeout(state.schemaEnvTimer);
+    state.schemaEnvTimer = null;
+};
+
+const scheduleSchemaEnvSync = (state: PluginState): void => {
+    cancelSchemaEnvSync(state);
+
+    state.schemaEnvTimer = setTimeout(() => {
+        state.schemaEnvTimer = null;
+        syncSchemaEnv(state);
+    }, SCHEMA_ENV_DEBOUNCE_MS);
+};
+
+const applyUserConfig = async (state: PluginState, config: UserConfig, loadConfig: ConfigLoader): Promise<void> => {
+    const loaded = await loadConfig.load(config.root ?? process.cwd());
+    state.isV2ResourceImports = loaded.config.future?.v2ResourceImports === true;
+    state.dataDir = state.isV2ResourceImports ? null : resolveDataDir(loaded.root);
 };
 
 const applyResolvedConfig = (state: PluginState, config: ResolvedConfig): void => {
@@ -128,13 +161,9 @@ const loadSchemaModule = (ctx: PluginContext, state: PluginState, id: string): s
     return renderRuntimeModule(parsed);
 };
 
-const emitCompiledSchemas = (ctx: PluginContext, state: PluginState): void => {
-    if (!state.isBuild || state.buildSchemas.size === 0) {
-        return;
-    }
-
-    const compiled = withStagingDir("schemas-build", (dir) => {
-        for (const filePath of state.buildSchemas) {
+const compileBuildSchemas = (schemaFiles: string[]): Buffer =>
+    withStagingDir("schemas-build", (dir) => {
+        for (const filePath of schemaFiles) {
             stageSchema(dir, filePath);
         }
 
@@ -143,18 +172,53 @@ const emitCompiledSchemas = (ctx: PluginContext, state: PluginState): void => {
         return readFileSync(join(dir, "gschemas.compiled"));
     });
 
+const buildSchemaPaths = (rootDir: string, schemaFiles: string[]): string[] =>
+    schemaFiles.map((filePath) => {
+        const rel = projectRelativeSchemaPath(rootDir, filePath);
+
+        if (rel === null) {
+            throw new Error(`Cannot package the GSettings schema ${filePath}: it is outside ${rootDir}`);
+        }
+
+        return rel;
+    });
+
+const emitBuildSchemas = (
+    ctx: PluginContext,
+    state: PluginState,
+    buildManifest: BuildManifestCollector | undefined,
+): void => {
+    if (!state.isBuild || state.rootDir === null) {
+        return;
+    }
+
+    const rootDir = state.rootDir;
+    const schemaFiles = sortStrings(state.buildSchemas);
+    assertUniqueSchemaBasenames(schemaFiles);
+    const schemas = buildSchemaPaths(rootDir, schemaFiles);
+
+    if (buildManifest !== undefined) {
+        buildManifest.schemas = schemas;
+    }
+
+    if (schemaFiles.length === 0) {
+        return;
+    }
+
+    const compiled = compileBuildSchemas(schemaFiles);
+
     ctx.emitFile({
         type: "asset",
         fileName: "gschemas.compiled",
         source: compiled,
     });
 
-    info(`Compiled ${String(state.buildSchemas.size)} GSettings schema(s)`);
+    info(`Compiled ${String(schemaFiles.length)} GSettings schema(s)`);
 };
 
 const handleSchemaHotUpdate = (state: PluginState, file: string, server: ViteDevServer): ModuleNode[] | undefined => {
-    if (file.endsWith(SCHEMA_SUFFIX)) {
-        syncSchemaEnv(state);
+    if (file.endsWith(SCHEMA_SUFFIX) || SOURCE_MODULE_RE.test(file)) {
+        scheduleSchemaEnvSync(state);
     }
 
     const virtualId = state.trackedSchemas.get(file);
@@ -180,6 +244,7 @@ const handleSchemaHotUpdate = (state: PluginState, file: string, server: ViteDev
 
 const watchSchemaFiles = (state: PluginState, server: ViteDevServer): void => {
     const onClose = (): void => {
+        cancelSchemaEnvSync(state);
         state.schemaDir.release();
     };
 
@@ -187,8 +252,8 @@ const watchSchemaFiles = (state: PluginState, server: ViteDevServer): void => {
     server.watcher.once("close", onClose);
 
     const refreshSchemaTypes = (file: string): void => {
-        if (file.endsWith(SCHEMA_SUFFIX)) {
-            syncSchemaEnv(state);
+        if (file.endsWith(SCHEMA_SUFFIX) || SOURCE_MODULE_RE.test(file)) {
+            scheduleSchemaEnvSync(state);
         }
     };
 
@@ -196,12 +261,14 @@ const watchSchemaFiles = (state: PluginState, server: ViteDevServer): void => {
     server.watcher.on("unlink", refreshSchemaTypes);
 };
 
-function gtkxSettings(): Plugin {
+function gtkxSettings(loadConfig: ConfigLoader, buildManifest?: BuildManifestCollector): Plugin {
     const state: PluginState = {
         schemaDir: createRetainedStagingDir(SCHEMA_STAGING_PREFIX),
         rootDir: null,
         dataDir: null,
+        isV2ResourceImports: false,
         isBuild: false,
+        schemaEnvTimer: null,
         trackedSchemas: new Map(),
         buildSchemas: new Set(),
     };
@@ -210,8 +277,8 @@ function gtkxSettings(): Plugin {
         name: "gtkx:settings",
         enforce: "pre",
 
-        config(config: UserConfig) {
-            applyUserConfig(state, config);
+        async config(config: UserConfig) {
+            await applyUserConfig(state, config, loadConfig);
         },
 
         configResolved(config) {
@@ -243,10 +310,11 @@ function gtkxSettings(): Plugin {
         },
 
         buildEnd() {
-            emitCompiledSchemas(this, state);
+            emitBuildSchemas(this, state, buildManifest);
         },
 
         closeBundle() {
+            cancelSchemaEnvSync(state);
             state.schemaDir.release();
         },
 

package/dist/vite-plugins/bundled-packages.d.ts

@@ -1,5 +0,0 @@
-import type { Plugin } from "vite";
-declare const BUNDLED_PACKAGES_FILENAME = "gtkx-packages.json";
-declare function gtkxBundledPackages(root: string): Plugin;
-export { BUNDLED_PACKAGES_FILENAME, gtkxBundledPackages };
-//# sourceMappingURL=bundled-packages.d.ts.map

package/dist/vite-plugins/bundled-packages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundled-packages.d.ts","sourceRoot":"","sources":["../../src/vite-plugins/bundled-packages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAmBnC,QAAA,MAAM,yBAAyB,uBAAuB,CAAC;AAoDvD,iBAAS,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqBjD;AAED,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/vite-plugins/bundled-packages.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundled-packages.js","sourceRoot":"","sources":["../../src/vite-plugins/bundled-packages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAe9C,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AACvD,MAAM,iBAAiB,GAAG,cAAc,CAAC;AACzC,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,MAAM,WAAW,GAAG,CAAC,CAAC;AAEtB,MAAM,UAAU,GAAG,CAAC,GAAW,EAA0B,EAAE;IACvD,IAAI,CAAC;QACD,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAEvF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtG,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAA0B,EAAE;IACtD,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE5B,OAAO,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,EAAU,EAA0B,EAAE;IAC5D,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,KAAsB,EAAU,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;AAE1F,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAsB,EAAmB,EAAE,CAAC,CAAC;IAC7E,GAAG,KAAK;IACR,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,GAAa,EAAU,EAAE;IAC7D,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IACtF,MAAM,MAAM,GAAiC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACnG,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAElG,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;AAClE,CAAC,CAAC;AAEF,SAAS,mBAAmB,CAAC,IAAY;IACrC,MAAM,KAAK,GAAkB,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,CAAC;IAErE,OAAO;QACH,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,OAAO;QAEd,cAAc,CAAC,MAAM;YACjB,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;QAED,cAAc,CAAC,QAAQ,EAAE,MAAM;YAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAEzG,IAAI,CAAC,QAAQ,CAAC;gBACV,IAAI,EAAE,OAAO;gBACb,QAAQ,EAAE,yBAAyB;gBACnC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC;aAC5C,CAAC,CAAC;QACP,CAAC;KACJ,CAAC;AACN,CAAC;AAED,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,CAAC","sourcesContent":["import type { Plugin } from \"vite\";\nimport { isRecord, sortStringsBy } from \"@gtkx/utils\";\nimport { readFileSync } from \"node:fs\";\nimport { dirname, join, relative, resolve } from \"node:path\";\nimport { stripQuery } from \"./strip-query.js\";\n\ntype PackageIdentity = {\n    name: string;\n    version: string | null;\n};\n\ntype RecordedPackage = PackageIdentity & {\n    dir: string;\n};\n\ntype PackagesState = {\n    outDir: string;\n};\n\nconst BUNDLED_PACKAGES_FILENAME = \"gtkx-packages.json\";\nconst MANIFEST_FILENAME = \"package.json\";\nconst DEFAULT_OUT_DIR = \"dist\";\nconst JSON_INDENT = 4;\n\nconst identityIn = (dir: string): PackageIdentity | null => {\n    try {\n        const parsed: unknown = JSON.parse(readFileSync(join(dir, MANIFEST_FILENAME), \"utf8\"));\n\n        if (!isRecord(parsed) || typeof parsed.name !== \"string\") {\n            return null;\n        }\n\n        return { name: parsed.name, version: typeof parsed.version === \"string\" ? parsed.version : null };\n    } catch {\n        return null;\n    }\n};\n\nconst packageIn = (dir: string): RecordedPackage | null => {\n    const identity = identityIn(dir);\n\n    if (identity !== null) {\n        return { ...identity, dir };\n    }\n\n    const parent = dirname(dir);\n\n    return parent === dir ? null : packageIn(parent);\n};\n\nconst packageForModule = (id: string): RecordedPackage | null => {\n    const path = stripQuery(id);\n\n    return path.startsWith(\"/\") ? packageIn(dirname(path)) : null;\n};\n\nconst keyFor = (entry: RecordedPackage): string => `${entry.name}@${entry.version ?? \"\"}`;\n\nconst relativeTo = (outDir: string, entry: RecordedPackage): RecordedPackage => ({\n    ...entry,\n    dir: relative(outDir, entry.dir),\n});\n\nconst renderPackages = (outDir: string, ids: string[]): string => {\n    const found = ids.map((id) => packageForModule(id)).filter((entry) => entry !== null);\n    const unique: Map<string, RecordedPackage> = new Map(found.map((entry) => [keyFor(entry), entry]));\n    const packages = sortStringsBy(unique.values(), keyFor).map((entry) => relativeTo(outDir, entry));\n\n    return `${JSON.stringify({ packages }, null, JSON_INDENT)}\\n`;\n};\n\nfunction gtkxBundledPackages(root: string): Plugin {\n    const state: PackagesState = { outDir: join(root, DEFAULT_OUT_DIR) };\n\n    return {\n        name: \"gtkx:bundled-packages\",\n        apply: \"build\",\n\n        configResolved(config) {\n            state.outDir = resolve(config.root, config.build.outDir);\n        },\n\n        generateBundle(_options, bundle) {\n            const ids = Object.values(bundle).flatMap((output) => (output.type === \"chunk\" ? output.moduleIds : []));\n\n            this.emitFile({\n                type: \"asset\",\n                fileName: BUNDLED_PACKAGES_FILENAME,\n                source: renderPackages(state.outDir, ids),\n            });\n        },\n    };\n}\n\nexport { BUNDLED_PACKAGES_FILENAME, gtkxBundledPackages };\n"]}