@gtkx/codegen 1.0.0-rc.2 → 1.0.0-rc.4

package/src/store/resolve-store.ts

@@ -0,0 +1,100 @@
+import { existsSync, readFileSync, realpathSync } from "node:fs";
+import { dirname, join, parse } from "node:path";
+import type { StoreOptions } from "./store-fs.js";
+
+/**
+ * Where a project's generated stores live, ready to spread into `runCodegen`. `jsx` is null when the
+ * project has no `@gtkx/react` installed, in which case only the `@gtkx/gi` store can be generated.
+ */
+type ResolvedStore = {
+    /** Where the `@gtkx/gi` store goes, versioned by the installed `@gtkx/runtime`. */
+    gi: StoreOptions;
+    /** Where the `@gtkx/jsx` store goes, versioned by the installed `@gtkx/react`; null when it is absent. */
+    jsx: StoreOptions | null;
+    /** Subexport names of the installed `@gtkx/react`, empty when it is absent. */
+    reactSubexports: string[];
+};
+
+type ResolvedPackage = { dir: string; version: string };
+
+const STORE_DIR = ".gtkx";
+const SCOPE = "@gtkx";
+
+const readManifest = (path: string): { version?: string; exports?: Record<string, unknown> } =>
+    JSON.parse(readFileSync(path, "utf8")) as { version?: string; exports?: Record<string, unknown> };
+
+const subexportNames = (packageDir: string): string[] =>
+    Object.keys(readManifest(join(packageDir, "package.json")).exports ?? {})
+        .filter((key) => key.startsWith("./") && key !== "./package.json")
+        .map((key) => key.slice(2));
+
+const loadPackage = (manifest: string): ResolvedPackage | null => {
+    if (!existsSync(manifest)) {
+        return null;
+    }
+
+    const real = realpathSync(manifest);
+
+    return { dir: dirname(real), version: readManifest(real).version ?? "0.0.0" };
+};
+
+const nodeModulesChain = function* (projectRoot: string): Generator<string> {
+    const { root } = parse(projectRoot);
+    let current = projectRoot;
+
+    while (current !== root) {
+        yield join(current, "node_modules");
+        current = dirname(current);
+    }
+
+    yield join(root, "node_modules");
+};
+
+const resolvePackage = (projectRoot: string, packageName: string): ResolvedPackage | null => {
+    for (const nodeModules of nodeModulesChain(projectRoot)) {
+        const found = loadPackage(join(nodeModules, packageName, "package.json"));
+
+        if (found !== null) {
+            return found;
+        }
+    }
+
+    return loadPackage(join(projectRoot, "packages", packageName.replace(/^@[^/]+\//, ""), "package.json"));
+};
+
+const storeOptions = (nodeModules: string, name: string, version: string): StoreOptions => ({
+    storeDir: join(nodeModules, STORE_DIR, name),
+    linkDir: join(nodeModules, SCOPE, name),
+    version,
+});
+
+/**
+ * Resolves where a project's `@gtkx/gi` and `@gtkx/jsx` stores belong, from the project root alone. The
+ * result supplies every `runCodegen` input except `libraries` and `girPath`, so a caller that has
+ * already resolved those can spread it straight into the call.
+ *
+ * Store versions come from the installed `@gtkx/runtime` and `@gtkx/react`, so a dependency upgrade
+ * invalidates the stores. Pass explicit `gi` or `jsx` options to `runCodegen` to override any of it.
+ *
+ * @param projectRoot Directory holding the project's `package.json` and `node_modules`.
+ * @returns The store locations and the React subexports that shape the jsx store.
+ * @throws If `@gtkx/runtime` cannot be resolved from the project.
+ */
+const resolveStore = (projectRoot: string): ResolvedStore => {
+    const runtime = resolvePackage(projectRoot, "@gtkx/runtime");
+
+    if (runtime === null) {
+        throw new Error(`Cannot resolve @gtkx/runtime from ${projectRoot}; is it installed?`);
+    }
+
+    const react = resolvePackage(projectRoot, "@gtkx/react");
+    const nodeModules = join(projectRoot, "node_modules");
+
+    return {
+        gi: storeOptions(nodeModules, "gi", runtime.version),
+        jsx: react === null ? null : storeOptions(nodeModules, "jsx", react.version),
+        reactSubexports: react === null ? [] : subexportNames(react.dir),
+    };
+};
+
+export { resolveStore, type ResolvedStore };

package/src/store/store-fs.ts

@@ -1,10 +1,14 @@
-import { existsSync, mkdirSync, mkdtempSync, renameSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
+import { chmodSync, existsSync, mkdirSync, mkdtempSync, renameSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
 import { dirname, join, relative } from "node:path";
 import { compileStore } from "./compile-store.js";
 
+/** Where one generated store is written and how it is reached. */
 type StoreOptions = {
+    /** Directory the generated package is written to, replaced atomically on each run. */
     storeDir: string;
+    /** Path the store is symlinked at, which is the specifier's resolution target under `node_modules`. */
     linkDir: string;
+    /** Version stamped on the store's `package.json`, taken from the dependency the store is generated for. */
     version: string;
 };
 
@@ -37,9 +41,11 @@ type WriteStoreParams = {
     files: StoreFile[];
     manifest: Manifest;
     rawFiles?: RawFile[];
-    configEnv?: boolean;
+    requiresEnvReference?: boolean;
 };
 
+const STORE_DIR_MODE = 0o755;
+
 const subpathExport = (stem: string): { types: string; default: string } => ({
     types: `./${stem}.d.ts`,
     default: `./${stem}.js`,
@@ -73,7 +79,7 @@ const writeStore = (params: WriteStoreParams): void => {
             storeDir: tmp,
             files: params.files,
             packageName: params.manifest.name,
-            ...(params.configEnv !== undefined && { configEnv: params.configEnv }),
+            ...(params.requiresEnvReference !== undefined && { requiresEnvReference: params.requiresEnvReference }),
         });
 
         writePackageJson(tmp, params.manifest);
@@ -83,7 +89,6 @@ const writeStore = (params: WriteStoreParams): void => {
             writeFileSync(join(tmp, raw.relativePath), raw.content);
         }
 
-        symlinkRelative(join(tmp, "node_modules", ...params.manifest.name.split("/")), tmp);
         swapStore(tmp, params.storeDir, params.linkDir);
     } finally {
         rmSync(tmp, { recursive: true, force: true });
@@ -121,8 +126,10 @@ const swapStore = (tmp: string, storeDir: string, visibleLink: string): void =>
 
 const createTempStore = (storeDir: string): string => {
     mkdirSync(dirname(storeDir), { recursive: true });
+    const tmp = mkdtempSync(`${storeDir}.tmp-`);
+    chmodSync(tmp, STORE_DIR_MODE);
 
-    return mkdtempSync(`${storeDir}.tmp-`);
+    return tmp;
 };
 
 export { subpathExport, buildManifest, writeStore, type StoreOptions, type RawFile };

package/dist/store/gi/class-struct-record.d.ts

@@ -1,10 +0,0 @@
-import type { GirFunction } from "../../gir/function.js";
-import type { Library } from "../../gir/library.js";
-import type { GirRecord } from "../../gir/record.js";
-import type { TypeId } from "../../gir/type-id.js";
-import type { ModuleContext } from "../../writer/context.js";
-declare const isClassStructRecord: (library: Library, namespaceName: string, record: GirRecord) => boolean;
-declare const isClassStructRef: (context: ModuleContext, ref: TypeId | undefined) => boolean;
-declare const hasClassStructReference: (context: ModuleContext, fn: GirFunction) => boolean;
-export { isClassStructRecord, isClassStructRef, hasClassStructReference };
-//# sourceMappingURL=class-struct-record.d.ts.map

package/dist/store/gi/class-struct-record.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"class-struct-record.d.ts","sourceRoot":"","sources":["../../../src/store/gi/class-struct-record.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAO7D,QAAA,MAAM,mBAAmB,GAAI,SAAS,OAAO,EAAE,eAAe,MAAM,EAAE,QAAQ,SAAS,KAAG,OAsBzF,CAAC;AAEF,QAAA,MAAM,gBAAgB,GAAI,SAAS,aAAa,EAAE,KAAK,MAAM,GAAG,SAAS,KAAG,OA8B3E,CAAC;AAEF,QAAA,MAAM,uBAAuB,GAAI,SAAS,aAAa,EAAE,IAAI,WAAW,KAAG,OAEK,CAAC;AAEjF,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/store/gi/class-struct-record.js

@@ -1,52 +0,0 @@
-const TYPE_STRUCT_ROOTS = new Set(["GObject.TypeClass", "GObject.TypeInterface"]);
-const EXPLICIT_CLASS_STRUCTS = new Set(["Pango.AttrClass"]);
-const qualify = (namespaceName, name) => `${namespaceName}.${name}`;
-const isClassStructRecord = (library, namespaceName, record) => {
-    const qualified = qualify(namespaceName, record.name);
-    if (TYPE_STRUCT_ROOTS.has(qualified) || EXPLICIT_CLASS_STRUCTS.has(qualified)) {
-        return true;
-    }
-    const first = record.fields[0];
-    // A class struct embeds its parent vtable by value (`GTypeClass g_type_class`); an instance
-    // struct stores a pointer to it (`GTypeClass *g_class`). Only the first is a vtable.
-    if (first?.type === undefined || first.cType?.endsWith("*") === true) {
-        return false;
-    }
-    const name = library.nameFor(first.type);
-    if (name === undefined) {
-        return false;
-    }
-    return TYPE_STRUCT_ROOTS.has(qualify(name.namespaceName, name.typeName));
-};
-const isClassStructRef = (context, ref) => {
-    if (ref === undefined) {
-        return false;
-    }
-    const type = context.library.typeFor(ref);
-    if (type === undefined) {
-        return false;
-    }
-    switch (type.kind) {
-        case "record": {
-            return isClassStructRecord(context.library, type.namespace.name, type.value);
-        }
-        case "carray":
-        case "list": {
-            return isClassStructRef(context, type.element);
-        }
-        case "alias":
-        case "callback":
-        case "class":
-        case "enum":
-        case "hashtable":
-        case "interface":
-        case "primitive":
-        case "varargs": {
-            return false;
-        }
-    }
-};
-const hasClassStructReference = (context, fn) => isClassStructRef(context, fn.returnValue.type) ||
-    fn.parameters.some((parameter) => isClassStructRef(context, parameter.type));
-export { isClassStructRecord, isClassStructRef, hasClassStructReference };
-//# sourceMappingURL=class-struct-record.js.map

package/dist/store/gi/class-struct-record.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"class-struct-record.js","sourceRoot":"","sources":["../../../src/store/gi/class-struct-record.ts"],"names":[],"mappings":"AAMA,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,CAAC,CAAC;AAClF,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAE5D,MAAM,OAAO,GAAG,CAAC,aAAqB,EAAE,IAAY,EAAU,EAAE,CAAC,GAAG,aAAa,IAAI,IAAI,EAAE,CAAC;AAE5F,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,aAAqB,EAAE,MAAiB,EAAW,EAAE;IAChG,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAEtD,IAAI,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE/B,4FAA4F;IAC5F,qFAAqF;IACrF,IAAI,KAAK,EAAE,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEzC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAsB,EAAE,GAAuB,EAAW,EAAE;IAClF,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,mBAAmB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACjF,CAAC;QACD,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC,CAAC,CAAC;YACV,OAAO,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,OAAO,CAAC;QACb,KAAK,UAAU,CAAC;QAChB,KAAK,OAAO,CAAC;QACb,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW,CAAC;QACjB,KAAK,WAAW,CAAC;QACjB,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS,CAAC,CAAC,CAAC;YACb,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,OAAsB,EAAE,EAAe,EAAW,EAAE,CACjF,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;IAC9C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAEjF,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC","sourcesContent":["import type { GirFunction } from \"../../gir/function.js\";\nimport type { Library } from \"../../gir/library.js\";\nimport type { GirRecord } from \"../../gir/record.js\";\nimport type { TypeId } from \"../../gir/type-id.js\";\nimport type { ModuleContext } from \"../../writer/context.js\";\n\nconst TYPE_STRUCT_ROOTS = new Set([\"GObject.TypeClass\", \"GObject.TypeInterface\"]);\nconst EXPLICIT_CLASS_STRUCTS = new Set([\"Pango.AttrClass\"]);\n\nconst qualify = (namespaceName: string, name: string): string => `${namespaceName}.${name}`;\n\nconst isClassStructRecord = (library: Library, namespaceName: string, record: GirRecord): boolean => {\n    const qualified = qualify(namespaceName, record.name);\n\n    if (TYPE_STRUCT_ROOTS.has(qualified) || EXPLICIT_CLASS_STRUCTS.has(qualified)) {\n        return true;\n    }\n\n    const first = record.fields[0];\n\n    // A class struct embeds its parent vtable by value (`GTypeClass g_type_class`); an instance\n    // struct stores a pointer to it (`GTypeClass *g_class`). Only the first is a vtable.\n    if (first?.type === undefined || first.cType?.endsWith(\"*\") === true) {\n        return false;\n    }\n\n    const name = library.nameFor(first.type);\n\n    if (name === undefined) {\n        return false;\n    }\n\n    return TYPE_STRUCT_ROOTS.has(qualify(name.namespaceName, name.typeName));\n};\n\nconst isClassStructRef = (context: ModuleContext, ref: TypeId | undefined): boolean => {\n    if (ref === undefined) {\n        return false;\n    }\n\n    const type = context.library.typeFor(ref);\n\n    if (type === undefined) {\n        return false;\n    }\n\n    switch (type.kind) {\n        case \"record\": {\n            return isClassStructRecord(context.library, type.namespace.name, type.value);\n        }\n        case \"carray\":\n        case \"list\": {\n            return isClassStructRef(context, type.element);\n        }\n        case \"alias\":\n        case \"callback\":\n        case \"class\":\n        case \"enum\":\n        case \"hashtable\":\n        case \"interface\":\n        case \"primitive\":\n        case \"varargs\": {\n            return false;\n        }\n    }\n};\n\nconst hasClassStructReference = (context: ModuleContext, fn: GirFunction): boolean =>\n    isClassStructRef(context, fn.returnValue.type) ||\n    fn.parameters.some((parameter) => isClassStructRef(context, parameter.type));\n\nexport { isClassStructRecord, isClassStructRef, hasClassStructReference };\n"]}

package/src/store/gi/class-struct-record.ts

@@ -1,72 +0,0 @@
-import type { GirFunction } from "../../gir/function.js";
-import type { Library } from "../../gir/library.js";
-import type { GirRecord } from "../../gir/record.js";
-import type { TypeId } from "../../gir/type-id.js";
-import type { ModuleContext } from "../../writer/context.js";
-
-const TYPE_STRUCT_ROOTS = new Set(["GObject.TypeClass", "GObject.TypeInterface"]);
-const EXPLICIT_CLASS_STRUCTS = new Set(["Pango.AttrClass"]);
-
-const qualify = (namespaceName: string, name: string): string => `${namespaceName}.${name}`;
-
-const isClassStructRecord = (library: Library, namespaceName: string, record: GirRecord): boolean => {
-    const qualified = qualify(namespaceName, record.name);
-
-    if (TYPE_STRUCT_ROOTS.has(qualified) || EXPLICIT_CLASS_STRUCTS.has(qualified)) {
-        return true;
-    }
-
-    const first = record.fields[0];
-
-    // A class struct embeds its parent vtable by value (`GTypeClass g_type_class`); an instance
-    // struct stores a pointer to it (`GTypeClass *g_class`). Only the first is a vtable.
-    if (first?.type === undefined || first.cType?.endsWith("*") === true) {
-        return false;
-    }
-
-    const name = library.nameFor(first.type);
-
-    if (name === undefined) {
-        return false;
-    }
-
-    return TYPE_STRUCT_ROOTS.has(qualify(name.namespaceName, name.typeName));
-};
-
-const isClassStructRef = (context: ModuleContext, ref: TypeId | undefined): boolean => {
-    if (ref === undefined) {
-        return false;
-    }
-
-    const type = context.library.typeFor(ref);
-
-    if (type === undefined) {
-        return false;
-    }
-
-    switch (type.kind) {
-        case "record": {
-            return isClassStructRecord(context.library, type.namespace.name, type.value);
-        }
-        case "carray":
-        case "list": {
-            return isClassStructRef(context, type.element);
-        }
-        case "alias":
-        case "callback":
-        case "class":
-        case "enum":
-        case "hashtable":
-        case "interface":
-        case "primitive":
-        case "varargs": {
-            return false;
-        }
-    }
-};
-
-const hasClassStructReference = (context: ModuleContext, fn: GirFunction): boolean =>
-    isClassStructRef(context, fn.returnValue.type) ||
-    fn.parameters.some((parameter) => isClassStructRef(context, parameter.type));
-
-export { isClassStructRecord, isClassStructRef, hasClassStructReference };