@fluixi/compiler 1.0.0-alpha.100

package/dist/transform/intrinsics.cjs

@@ -0,0 +1,261 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/transform/intrinsics.ts
+var intrinsics_exports = {};
+__export(intrinsics_exports, {
+  avoidBindingClashes: () => avoidBindingClashes,
+  collectIntrinsicEdits: () => collectIntrinsicEdits,
+  intrinsicImports: () => intrinsicImports
+});
+module.exports = __toCommonJS(intrinsics_exports);
+
+// src/analyze/intrinsics.ts
+var REACTIVE_MODULE = "@fluixi/reactive/signal";
+var INTRINSICS = {
+  $signal: { export: "signal", module: REACTIVE_MODULE, returns: "signal-handle" },
+  $memo: { export: "memo", module: REACTIVE_MODULE, returns: "memo-handle" },
+  $effect: { export: "effect", module: REACTIVE_MODULE, returns: "effect" },
+  $store: { export: "store", module: "@fluixi/reactive/store", returns: "store-handle" },
+  $resource: { export: "resource", module: REACTIVE_MODULE, returns: "resource-handle" },
+  $cachedResource: { export: "cachedResource", module: "@fluixi/reactive/cached-resource", returns: "resource-handle" },
+  // No short runtime form for these yet, so the intrinsic stands for the `create*`
+  // name. Still worth having: no import to write, and when a shorter form is
+  // designed, the change is this line rather than a compiler pass.
+  $selector: { export: "createSelector", module: REACTIVE_MODULE, returns: "memo-accessor" },
+  $deferred: { export: "createDeferred", module: REACTIVE_MODULE, returns: "memo-accessor" },
+  // Not value constructors, but the compiler has to know them: they change what a read
+  // does. `untrack` suppresses dependency collection, which is exactly the kind of thing
+  // dependency analysis must not guess at.
+  $untrack: { export: "untrack", module: REACTIVE_MODULE, returns: "plain" },
+  $untrackStore: { export: "untrackStore", module: "@fluixi/reactive/store", returns: "plain" },
+  // Scopes, scheduling and lifecycle: no value to classify, but the same authoring promise,
+  // no import to write. `$cleanup` registers a callback on the current owner (`onCleanup`).
+  $batch: { export: "batch", module: REACTIVE_MODULE, returns: "plain" },
+  $cleanup: { export: "onCleanup", module: REACTIVE_MODULE, returns: "plain" },
+  $root: { export: "root", module: REACTIVE_MODULE, returns: "plain" },
+  $context: { export: "context", module: REACTIVE_MODULE, returns: "plain" },
+  $renderEffect: { export: "renderEffect", module: REACTIVE_MODULE, returns: "effect" },
+  $computed: { export: "computed", module: REACTIVE_MODULE, returns: "effect" },
+  // Storage for where the code runs, and a signal kept in it. `$persisted` is a signal
+  // handle as far as reads go: the same accessor with `set` on it.
+  $storage: { export: "useStorage", module: "@fluixi/core/storage", returns: "plain" },
+  $asyncStorage: { export: "useAsyncStorage", module: "@fluixi/core/storage", returns: "plain" },
+  $persisted: { export: "persisted", module: "@fluixi/core/storage", returns: "signal-handle" },
+  // An environment variable, public or server-only; the browser build refuses a secret.
+  $env: { export: "env", module: "@fluixi/start/env", returns: "plain" }
+};
+var RUNTIME_PRIMITIVES = {
+  signal: "signal-handle",
+  memo: "memo-handle",
+  effect: "effect",
+  store: "store-handle",
+  createSignal: ["signal-accessor", "signal-setter"],
+  createMemo: "memo-accessor",
+  createEffect: "effect",
+  createRenderEffect: "effect",
+  renderEffect: "effect",
+  computed: "effect",
+  createStore: "reactive-object",
+  resource: "resource-handle",
+  cachedResource: "resource-handle",
+  createResource: "reactive-object",
+  createSelector: "memo-accessor",
+  createDeferred: "memo-accessor"
+};
+var PRIMITIVE_MODULES = [
+  "@fluixi/reactive",
+  "@fluixi/reactive/signal",
+  "@fluixi/reactive/store",
+  "@fluixi/reactive/cached-resource",
+  "@fluixi/core"
+];
+var INTRINSIC_CALL = new RegExp(`\\$(?:${Object.keys(INTRINSICS).map((n) => n.slice(1)).join("|")})\\s*\\(`);
+function isIntrinsicName(name) {
+  return Object.prototype.hasOwnProperty.call(INTRINSICS, name);
+}
+function isPrimitiveModule(source) {
+  return PRIMITIVE_MODULES.includes(source);
+}
+
+// src/analyze/reactive-bindings.ts
+function patternNames(node, out) {
+  if (!node) return;
+  switch (node.type) {
+    case "Identifier":
+      out.add(node.name);
+      return;
+    case "ObjectPattern":
+      for (const p of node.properties ?? []) {
+        if (p.type === "RestElement") patternNames(p.argument, out);
+        else patternNames(p.value, out);
+      }
+      return;
+    case "ArrayPattern":
+      for (const e of node.elements ?? []) patternNames(e, out);
+      return;
+    case "AssignmentPattern":
+      patternNames(node.left, out);
+      return;
+    case "RestElement":
+      patternNames(node.argument, out);
+      return;
+  }
+}
+function walk(root, visit) {
+  if (!root || typeof root !== "object" || typeof root.type !== "string") return;
+  visit(root);
+  for (const key of Object.keys(root)) {
+    if (key === "loc" || key === "leadingComments" || key === "trailingComments") continue;
+    const value = root[key];
+    if (Array.isArray(value)) for (const item of value) walk(item, visit);
+    else if (value && typeof value === "object") walk(value, visit);
+  }
+}
+function calledPrimitive(node, bindings) {
+  if (node.type !== "CallExpression") return void 0;
+  const callee = node.callee;
+  if (callee?.type !== "Identifier") return void 0;
+  const name = callee.name;
+  const imported = bindings.primitives.get(name);
+  if (imported) return imported;
+  const intrinsic = INTRINSICS[name];
+  if (intrinsic && !bindings.shadowed.has(name)) return intrinsic.returns;
+  return void 0;
+}
+function classify(id, returns, kinds) {
+  if (Array.isArray(returns)) {
+    if (id.type === "ArrayPattern") {
+      id.elements.forEach((element, index) => {
+        const kind = returns[index];
+        if (element?.type === "Identifier" && kind) kinds.set(element.name, kind);
+      });
+    }
+    return;
+  }
+  if (id.type === "Identifier") kinds.set(id.name, returns);
+}
+function resolveReactiveBindings(program) {
+  const bindings = { kinds: /* @__PURE__ */ new Map(), primitives: /* @__PURE__ */ new Map(), shadowed: /* @__PURE__ */ new Set() };
+  const root = program;
+  walk(root, (node) => {
+    const names = /* @__PURE__ */ new Set();
+    if (node.type === "VariableDeclarator") patternNames(node.id, names);
+    else if (node.type === "FunctionDeclaration" || node.type === "ClassDeclaration") patternNames(node.id, names);
+    else if (node.type === "ImportDefaultSpecifier" || node.type === "ImportNamespaceSpecifier") patternNames(node.local, names);
+    else if (node.type === "ImportSpecifier") patternNames(node.local, names);
+    else if (node.type === "FunctionExpression" || node.type === "ArrowFunctionExpression" || node.type === "FunctionDeclaration") {
+      for (const p of node.params ?? []) patternNames(p, names);
+    }
+    for (const name of names) if (INTRINSICS[name]) bindings.shadowed.add(name);
+  });
+  for (const statement of root.body ?? []) {
+    if (statement.type !== "ImportDeclaration") continue;
+    if (!isPrimitiveModule(statement.source?.value)) continue;
+    for (const specifier of statement.specifiers ?? []) {
+      if (specifier.type !== "ImportSpecifier") continue;
+      const importedNode = specifier.imported;
+      const imported = importedNode.type === "Identifier" ? importedNode.name : importedNode.value;
+      const returns = RUNTIME_PRIMITIVES[imported];
+      if (returns) bindings.primitives.set(specifier.local.name, returns);
+    }
+  }
+  walk(root, (node) => {
+    if (node.type !== "VariableDeclarator" || !node.init) return;
+    const returns = calledPrimitive(node.init, bindings);
+    if (returns) classify(node.id, returns, bindings.kinds);
+  });
+  return bindings;
+}
+
+// src/transform/intrinsics.ts
+function walk2(root, visit) {
+  if (!root || typeof root !== "object" || typeof root.type !== "string") return;
+  visit(root);
+  for (const key of Object.keys(root)) {
+    if (key === "loc" || key === "leadingComments" || key === "trailingComments") continue;
+    const value = root[key];
+    if (Array.isArray(value)) for (const item of value) walk2(item, visit);
+    else if (value && typeof value === "object") walk2(value, visit);
+  }
+}
+function collectIntrinsicEdits(program) {
+  const edits = [];
+  const diagnostics = [];
+  const imports = /* @__PURE__ */ new Map();
+  const reported = /* @__PURE__ */ new Set();
+  const { shadowed } = resolveReactiveBindings(program);
+  walk2(program, (node) => {
+    if (node.type !== "CallExpression") return;
+    const callee = node.callee;
+    if (callee?.type !== "Identifier") return;
+    const name = callee.name;
+    if (!isIntrinsicName(name)) return;
+    if (shadowed.has(name)) {
+      if (!reported.has(name)) {
+        reported.add(name);
+        diagnostics.push({
+          name,
+          message: `${name} is reserved for the compiler, and this module binds it. The call keeps your binding's meaning; rename it to use the intrinsic.`,
+          start: callee.start
+        });
+      }
+      return;
+    }
+    const intrinsic = INTRINSICS[name];
+    edits.push({ start: callee.start, end: callee.end, code: intrinsic.export });
+    const forModule = imports.get(intrinsic.module) ?? /* @__PURE__ */ new Set();
+    forModule.add(intrinsic.export);
+    imports.set(intrinsic.module, forModule);
+  });
+  return { edits, diagnostics, imports };
+}
+function avoidBindingClashes(program, result, bound) {
+  const importedAsIs = /* @__PURE__ */ new Set();
+  for (const stmt of program.body ?? []) {
+    if (stmt.type !== "ImportDeclaration") continue;
+    const module2 = stmt.source.value;
+    for (const spec of stmt.specifiers ?? []) {
+      if (spec.type !== "ImportSpecifier") continue;
+      const imported = spec.imported.name ?? spec.imported.value;
+      if (imported === spec.local.name && result.imports.get(module2)?.has(imported)) {
+        importedAsIs.add(imported);
+      }
+    }
+  }
+  const aliases = /* @__PURE__ */ new Map();
+  for (const names of result.imports.values()) {
+    for (const name of names) if (bound.has(name) && !importedAsIs.has(name)) aliases.set(name, `__fx_${name}`);
+  }
+  if (!aliases.size) return;
+  for (const edit of result.edits) {
+    const alias = aliases.get(edit.code);
+    if (alias) edit.code = alias;
+  }
+  result.aliases = aliases;
+}
+function intrinsicImports(result, bound) {
+  const lines = [];
+  for (const [module2, names] of [...result.imports].sort(([a], [b]) => a.localeCompare(b))) {
+    const wanted = [...names].filter((name) => result.aliases?.has(name) || !bound.has(name)).sort().map((name) => result.aliases?.has(name) ? `${name} as ${result.aliases.get(name)}` : name);
+    if (wanted.length) lines.push(`import { ${wanted.join(", ")} } from ${JSON.stringify(module2)};`);
+  }
+  return lines.length ? `${lines.join("\n")}
+` : "";
+}

package/dist/transform/intrinsics.d.cts

@@ -0,0 +1,33 @@
+export interface IntrinsicEdit {
+    start: number;
+    end: number;
+    code: string;
+}
+export interface IntrinsicDiagnostic {
+    /** The `$` name the module bound itself. */
+    name: string;
+    message: string;
+    start: number;
+}
+export interface IntrinsicsResult {
+    edits: IntrinsicEdit[];
+    diagnostics: IntrinsicDiagnostic[];
+    /** Runtime exports the rewritten code needs, by module. */
+    imports: Map<string, Set<string>>;
+    /** Runtime exports imported under another name, because the module binds theirs. */
+    aliases?: Map<string, string>;
+}
+/** Find the `$` calls in a module and say what they compile to. */
+export declare function collectIntrinsicEdits(program: unknown): IntrinsicsResult;
+/**
+ * Point a rewritten call past a local binding of the same name.
+ *
+ * `$env('X')` becomes `env('X')`, and the import of `env` used to be skipped when the module
+ * already bound `env`, on the assumption that it was the same import. A config module with its
+ * own `const env = {…}` is common, and there the call reached the app's object instead. Such a
+ * name is now imported under a private alias. A module that imports that very export from that
+ * very module keeps the old behaviour: the binding is the runtime already.
+ */
+export declare function avoidBindingClashes(program: unknown, result: IntrinsicsResult, bound: Set<string>): void;
+/** The import statements a result needs, minus anything the module already binds. */
+export declare function intrinsicImports(result: IntrinsicsResult, bound: Set<string>): string;

package/dist/transform/intrinsics.d.ts

@@ -0,0 +1,34 @@
+export interface IntrinsicEdit {
+    start: number;
+    end: number;
+    code: string;
+}
+export interface IntrinsicDiagnostic {
+    /** The `$` name the module bound itself. */
+    name: string;
+    message: string;
+    start: number;
+}
+export interface IntrinsicsResult {
+    edits: IntrinsicEdit[];
+    diagnostics: IntrinsicDiagnostic[];
+    /** Runtime exports the rewritten code needs, by module. */
+    imports: Map<string, Set<string>>;
+    /** Runtime exports imported under another name, because the module binds theirs. */
+    aliases?: Map<string, string>;
+}
+/** Find the `$` calls in a module and say what they compile to. */
+export declare function collectIntrinsicEdits(program: unknown): IntrinsicsResult;
+/**
+ * Point a rewritten call past a local binding of the same name.
+ *
+ * `$env('X')` becomes `env('X')`, and the import of `env` used to be skipped when the module
+ * already bound `env`, on the assumption that it was the same import. A config module with its
+ * own `const env = {…}` is common, and there the call reached the app's object instead. Such a
+ * name is now imported under a private alias. A module that imports that very export from that
+ * very module keeps the old behaviour: the binding is the runtime already.
+ */
+export declare function avoidBindingClashes(program: unknown, result: IntrinsicsResult, bound: Set<string>): void;
+/** The import statements a result needs, minus anything the module already binds. */
+export declare function intrinsicImports(result: IntrinsicsResult, bound: Set<string>): string;
+//# sourceMappingURL=intrinsics.d.ts.map

package/dist/transform/intrinsics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intrinsics.d.ts","sourceRoot":"","sources":["../../src/transform/intrinsics.ts"],"names":[],"mappings":"AAwBA,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,WAAW,EAAE,mBAAmB,EAAE,CAAC;IACnC,2DAA2D;IAC3D,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAClC,oFAAoF;IACpF,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAaD,mEAAmE;AACnE,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAuCxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAwBxG;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAUrF"}

package/dist/transform/intrinsics.js

@@ -0,0 +1,120 @@
+/**
+ * Compile the `$` intrinsics into the runtime calls they stand for.
+ *
+ *   const [count, setCount] = $signal(0);
+ *   → const [count, setCount] = createSignal(0);   + the import
+ *
+ * Only the callee is rewritten, so arguments keep the author's text and the span stays
+ * put: `$signal(0)` and `createSignal(0)` map to the same place. Imports are collected
+ * from what the module actually used, so a file with one `$signal` gets one import.
+ *
+ * A module that binds `$signal` itself keeps its own meaning and is reported instead;
+ * the compiler quietly rewriting code that means something else is the one outcome
+ * worth failing over.
+ */
+import { INTRINSICS, isIntrinsicName } from '../analyze/intrinsics.js';
+import { resolveReactiveBindings } from '../analyze/reactive-bindings.js';
+function walk(root, visit) {
+    if (!root || typeof root !== 'object' || typeof root.type !== 'string')
+        return;
+    visit(root);
+    for (const key of Object.keys(root)) {
+        if (key === 'loc' || key === 'leadingComments' || key === 'trailingComments')
+            continue;
+        const value = root[key];
+        if (Array.isArray(value))
+            for (const item of value)
+                walk(item, visit);
+        else if (value && typeof value === 'object')
+            walk(value, visit);
+    }
+}
+/** Find the `$` calls in a module and say what they compile to. */
+export function collectIntrinsicEdits(program) {
+    const edits = [];
+    const diagnostics = [];
+    const imports = new Map();
+    const reported = new Set();
+    const { shadowed } = resolveReactiveBindings(program);
+    walk(program, (node) => {
+        if (node.type !== 'CallExpression')
+            return;
+        const callee = node.callee;
+        if (callee?.type !== 'Identifier')
+            return;
+        const name = callee.name;
+        if (!isIntrinsicName(name))
+            return;
+        if (shadowed.has(name)) {
+            if (!reported.has(name)) {
+                reported.add(name);
+                diagnostics.push({
+                    name,
+                    message: `${name} is reserved for the compiler, and this module binds it. The call keeps your binding's meaning; rename it to use the intrinsic.`,
+                    start: callee.start,
+                });
+            }
+            return;
+        }
+        const intrinsic = INTRINSICS[name];
+        // The callee only. Arguments are untouched, so a template or JSX inside one is still
+        // compiled by the pass that owns it.
+        edits.push({ start: callee.start, end: callee.end, code: intrinsic.export });
+        const forModule = imports.get(intrinsic.module) ?? new Set();
+        forModule.add(intrinsic.export);
+        imports.set(intrinsic.module, forModule);
+    });
+    return { edits, diagnostics, imports };
+}
+/**
+ * Point a rewritten call past a local binding of the same name.
+ *
+ * `$env('X')` becomes `env('X')`, and the import of `env` used to be skipped when the module
+ * already bound `env`, on the assumption that it was the same import. A config module with its
+ * own `const env = {…}` is common, and there the call reached the app's object instead. Such a
+ * name is now imported under a private alias. A module that imports that very export from that
+ * very module keeps the old behaviour: the binding is the runtime already.
+ */
+export function avoidBindingClashes(program, result, bound) {
+    const importedAsIs = new Set();
+    for (const stmt of program.body ?? []) {
+        if (stmt.type !== 'ImportDeclaration')
+            continue;
+        const module = stmt.source.value;
+        for (const spec of stmt.specifiers ?? []) {
+            if (spec.type !== 'ImportSpecifier')
+                continue;
+            const imported = (spec.imported.name ?? spec.imported.value);
+            if (imported === spec.local.name && result.imports.get(module)?.has(imported)) {
+                importedAsIs.add(imported);
+            }
+        }
+    }
+    const aliases = new Map();
+    for (const names of result.imports.values()) {
+        for (const name of names)
+            if (bound.has(name) && !importedAsIs.has(name))
+                aliases.set(name, `__fx_${name}`);
+    }
+    if (!aliases.size)
+        return;
+    for (const edit of result.edits) {
+        const alias = aliases.get(edit.code);
+        if (alias)
+            edit.code = alias;
+    }
+    result.aliases = aliases;
+}
+/** The import statements a result needs, minus anything the module already binds. */
+export function intrinsicImports(result, bound) {
+    const lines = [];
+    for (const [module, names] of [...result.imports].sort(([a], [b]) => a.localeCompare(b))) {
+        const wanted = [...names]
+            .filter((name) => result.aliases?.has(name) || !bound.has(name))
+            .sort()
+            .map((name) => (result.aliases?.has(name) ? `${name} as ${result.aliases.get(name)}` : name));
+        if (wanted.length)
+            lines.push(`import { ${wanted.join(', ')} } from ${JSON.stringify(module)};`);
+    }
+    return lines.length ? `${lines.join('\n')}\n` : '';
+}