@gtkx/config 2.0.0-beta.10 → 2.0.0-beta.12

package/src/loader.ts

@@ -1,20 +1,16 @@
 import { isPathInside, warn } from "@gtkx/utils";
 import { loadConfig as loadConfigFile } from "c12";
 import { existsSync } from "node:fs";
-import { basename, extname, isAbsolute, relative, resolve } from "node:path";
+import { relative, resolve } from "node:path";
 import {
+    addConfigSource,
     captureConfigDependencies,
+    createConfigImporter,
     setConfigDependencies,
-    transformConfigModule,
 } from "./config-dependencies.ts";
 import { missingConfigFileError } from "./config-error.ts";
-import {
-    type Config,
-    graduatedFutureKeys,
-    resolveConfig,
-    type ResolvedConfig,
-    validateConfig,
-} from "./config.ts";
+import { type ConfigResolutionOptions, localConfigSourcePath } from "./config-source.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. */
@@ -34,6 +30,8 @@ type LoadConfigOptions = {
      * top-level values, and the name is passed to a config authored as a function.
      */
     mode?: string | undefined;
+    /** Whether to report graduated future flags; supervising processes can own these warnings. Defaults to true. */
+    shouldWarnGraduatedFuture?: boolean | undefined;
 } & Partial<Record<"configFile", string | undefined>>;
 
 /** Reads a project's configuration once per directory, caching what it loads and what it resolves. */
@@ -44,35 +42,18 @@ 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 rejectMissingLocalConfig = (source: string, options: ConfigResolutionOptions): undefined => {
+    const path = localConfigSourcePath(source, options);
 
-const localConfigSourcePath = (source: string, options: ConfigResolutionOptions): string | undefined => {
-    if (source === "." || !isLocalConfigSource(source)) {
-        return undefined;
+    if (path === undefined) {
+        return;
     }
 
-    const cwd = options.cwd ?? process.cwd();
-
-    return isDirectoryConfigSource(source)
-        ? resolve(cwd, source, options.configFile ?? "gtkx.config")
-        : resolve(cwd, source);
-};
+    addConfigSource(path);
 
-const rejectMissingLocalConfig = (source: string, options: ConfigResolutionOptions): undefined => {
-    const path = localConfigSourcePath(source, options);
-
-    if (path !== undefined && !existsSync(path)) {
+    if (!existsSync(path)) {
         throw new Error(`Extended configuration does not exist at ${path}`);
     }
 };
@@ -107,16 +88,11 @@ 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
-    ) {
+    if (keys.length === 0 || graduatedFutureWarnings.get(root) === 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.`);
 };
 
@@ -138,25 +114,22 @@ const loadConfig = async (cwd: string, options: LoadConfigOptions = {}): Promise
             rcFile: false,
             globalRc: false,
             packageJson: false,
+            omit$Keys: true,
             context: { mode: options.mode },
-            jitiOptions: { fsCache: false, transform: transformConfigModule },
+            jiti: createConfigImporter(),
             resolve: rejectMissingLocalConfig,
             ...(requestedConfigFile !== undefined && { configFile: requestedConfigFile }),
-            ...((options.mode !== undefined) && { envName: options.mode }),
-        }));
+            ...(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,
-    ];
+    const layerFiles = (result.layers ?? []).flatMap((layer) =>
+        layer.configFile === undefined ? [] : [resolve(layer.cwd ?? root, layer.configFile)],
+    );
+    const dependencies = [...(configFile === undefined ? [] : [configFile]), ...layerFiles, ...captured.dependencies];
 
     return withConfigDependencies(dependencies, () => {
         if (configFile === undefined || !existsSync(resolve(searched, configFile))) {
@@ -165,7 +138,9 @@ const loadConfig = async (cwd: string, options: LoadConfigOptions = {}): Promise
 
         const config = result.config;
         validateConfig(config, configFile);
-        warnGraduatedFuture(config, root);
+        if (options.shouldWarnGraduatedFuture !== false) {
+            warnGraduatedFuture(config, root);
+        }
 
         const loaded = {
             config,
@@ -198,4 +173,4 @@ const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
     };
 };
 
-export { loadConfig, createConfigLoader, type LoadedConfig, type ConfigLoader };
+export { loadConfig, createConfigLoader, type LoadedConfig, type ConfigLoader, type LoadConfigOptions };

package/src/node-version.ts

@@ -1,6 +1,7 @@
 const MINIMUM_NODE_MAJOR = 26;
 const MINIMUM_NODE_MINOR = 7;
 const MINIMUM_NODE_VERSION = "26.7.0";
+const DEFAULT_NODE_VERSION = "26.8.2";
 
 const assertSupportedNodeVersion = (): void => {
     const [major = 0, minor = 0] = process.versions.node.split(".").map(Number);
@@ -13,4 +14,4 @@ const assertSupportedNodeVersion = (): void => {
     }
 };
 
-export { assertSupportedNodeVersion, MINIMUM_NODE_VERSION };
+export { assertSupportedNodeVersion, DEFAULT_NODE_VERSION, MINIMUM_NODE_VERSION };

package/src/virtual.ts

@@ -3,23 +3,22 @@ import { resourceBasePath } from "./resource-base-path.ts";
 
 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 renderConfigModule = (config: ResolvedConfig): string => {
+const renderConfigModule = (config: ResolvedConfig, localeDir: string | null = null): string => {
     const lazyJson = JSON.stringify(Object.fromEntries(config.lazyElements.map((type) => [type, { isLazy: true }])));
 
     const behaviorImports =
         config.elements === null
             ? []
             : [
-                    "import { mergeElementConfigs } from \"@gtkx/react/config\";",
-                    `import __elementBehaviors from ${JSON.stringify(config.elements)};`,
-                ];
+                  'import { mergeElementConfigs } from "@gtkx/react/config";',
+                  `import __elementBehaviors from ${JSON.stringify(config.elements)};`,
+              ];
 
     return [
         ...behaviorImports,
-        `export * from ${JSON.stringify(METADATA_SPECIFIER)};`,
         `export const applicationId = ${JSON.stringify(config.applicationId)};`,
+        `export const localeDir = ${JSON.stringify(localeDir)};`,
         `export const resourceBasePath = ${JSON.stringify(resourceBasePath(config.applicationId))};`,
         `export const userEventSignals = ${JSON.stringify(config.userEventSignals)};`,
         config.elements === null

package/src/vite-plugin.ts

@@ -1,11 +1,10 @@
 import type { Plugin, UserConfig } from "vite";
+import { resolve } from "node:path";
 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, falling back to the working directory. */
     root: string;
 };
 
@@ -19,12 +18,16 @@ const loadVirtualModule = async (
     id: string,
     loadConfig: ConfigLoader,
     state: PluginState,
+    localeDir: string | null | undefined,
 ): Promise<string | undefined> => {
     if (id !== RESOLVED_GTKX_CONFIG_VIRTUAL_ID) {
         return undefined;
     }
 
-    return renderConfigModule(await loadConfig.resolve(state.root));
+    return renderConfigModule(
+        await loadConfig.resolve(state.root),
+        localeDir == null ? null : resolve(state.root, localeDir),
+    );
 };
 
 /**
@@ -36,6 +39,8 @@ const createConfigPlugin = (options: {
     name: string;
     /** Loader the configuration is resolved through, defaulting to a fresh caching loader. */
     loadConfig?: ConfigLoader;
+    /** Catalog directory for development or tests, resolved relative to the project root. */
+    localeDir?: string | null | undefined;
     /** Extra Vite configuration contributed from the plugin's `config` hook, given the user's own configuration. */
     config?: (config: UserConfig) => Omit<UserConfig, "plugins">;
 }): Plugin => {
@@ -55,7 +60,7 @@ const createConfigPlugin = (options: {
         },
         load: {
             filter: { id: RESOLVED_VIRTUAL_ID_RE },
-            handler: (id: string) => loadVirtualModule(id, loadConfig, state),
+            handler: (id: string) => loadVirtualModule(id, loadConfig, state, options.localeDir),
         },
     };
 };