@fluixi/compiler 1.0.0-alpha.83 → 1.0.0-alpha.85

package/dist/analyze/static-graph.d.cts

@@ -0,0 +1,102 @@
+export type StaticNodeKind = 'state' | 'memo' | 'effect' | 'store' | 'resource' | 'component'
+/** Control flow the framework supplies: `Show`, `For`, `Switch`, `Suspense`, `Await`. */
+ | 'control'
+/** The router's own tags: `Router`, `Outlet`, `Link`, `Redirect`. */
+ | 'router'
+/** A server route handler: `GET`, `POST` in an api file. Not a component. */
+ | 'handler';
+export interface StaticNode {
+    id: number;
+    label: string;
+    kind: StaticNodeKind;
+    /** Ids this one names in its body. */
+    deps: number[];
+    writes: number[];
+    /** Never run, so never pulsed. A renderer reads this as "nothing has happened yet". */
+    runs: number;
+    lastPulse: number;
+    source: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    /** The component whose body declares it. */
+    createdIn?: number;
+    /** Where this value is written into the document. */
+    targets?: StaticDomTarget[];
+    /**
+     * The elements this component writes, as a tree, read from the source rather than from a
+     * page. Only what is written literally: anything inside a hole is decided at runtime.
+     */
+    dom?: StaticDomNode[];
+}
+/**
+ * An element a component writes, in the shape a panel already draws.
+ *
+ * Deliberately the same fields as devtools' `DomNode`, minus the ones only a running page
+ * can fill. Mirrored rather than imported: the compiler does not depend on devtools.
+ */
+export interface StaticDomNode {
+    /** The element as written: `div#root`, `span.num`. */
+    label: string;
+    children: StaticDomNode[];
+    /** The component rendered here, when a tag stands in this position rather than an element. */
+    owner?: number;
+    /** Where the tag was written. */
+    at?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+}
+/** Where a value reaches the document, read from the jsx rather than from a running page. */
+export interface StaticDomTarget {
+    /** `content` for a hole between tags, `attribute` for one in a prop. */
+    kind: 'content' | 'attribute';
+    /** The attribute name, when it is one. */
+    name?: string;
+    /** The element as written: `span.num`, `div#root`. */
+    element: string;
+    /** Where the hole is, in the author's file. */
+    source: {
+        file: string;
+        line: number;
+        column: number;
+    };
+}
+export interface StaticGraph {
+    t: number;
+    nodes: StaticNode[];
+    /** Says what this graph is, for a panel that draws both kinds. */
+    static: true;
+}
+export interface StaticGraphFile {
+    path: string;
+    code: string;
+}
+export interface AnalyzeOptions {
+    /**
+     * Where file-routes live, relative to the project root.
+     *
+     * Nothing in the source references these components: the router is handed a table built
+     * from the directory listing, so a page with no signals in it is named nowhere and reads
+     * as a component belonging to nothing. The directory is what says otherwise.
+     *
+     * `routesDir` in fluixi.config; a host that has read the config should pass what it found.
+     * @default 'src/routes'
+     */
+    routesDir?: string;
+    /**
+     * Where file-based API routes live. Same problem as the pages: the handlers are served by
+     * the directory they sit in, so nothing names them and each one draws on its own.
+     *
+     * `apiDir` in fluixi.config.
+     * @default 'src/api'
+     */
+    apiDir?: string;
+}
+/**
+ * Files are analysed independently, then joined: an imported name resolves to the node the
+ * exporting file declared under it, which connects a store to the memo reading it elsewhere.
+ */
+export declare function analyzeReactiveGraph(files: readonly StaticGraphFile[], options?: AnalyzeOptions): StaticGraph;

package/dist/analyze/static-graph.d.ts

@@ -3,7 +3,7 @@ export type StaticNodeKind = 'state' | 'memo' | 'effect' | 'store' | 'resource'
  | 'control'
 /** The router's own tags: `Router`, `Outlet`, `Link`, `Redirect`. */
  | 'router'
-/** A server route handler — `GET`, `POST` in an api file. Not a component. */
+/** A server route handler: `GET`, `POST` in an api file. Not a component. */
  | 'handler';
 export interface StaticNode {
     id: number;

package/dist/analyze/static-graph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"static-graph.d.ts","sourceRoot":"","sources":["../../src/analyze/static-graph.ts"],"names":[],"mappings":"AA6BA,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,MAAM,GACN,QAAQ,GACR,OAAO,GACP,UAAU,GACV,WAAW;AACb,yFAAyF;GACvF,SAAS;AACX,qEAAqE;GACnE,QAAQ;AACV,8EAA8E;GAC5E,SAAS,CAAC;AAEd,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,cAAc,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B;;;OAGG;IACH,GAAG,CAAC,EAAE,aAAa,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,EAAE,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACrD;AAED,6FAA6F;AAC7F,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,IAAI,EAAE,SAAS,GAAG,WAAW,CAAC;IAC9B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACxD;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kEAAkE;IAClE,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA+PD;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,SAAS,eAAe,EAAE,EACjC,OAAO,GAAE,cAAmB,GAC3B,WAAW,CAimBb"}
+{"version":3,"file":"static-graph.d.ts","sourceRoot":"","sources":["../../src/analyze/static-graph.ts"],"names":[],"mappings":"AA6BA,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,MAAM,GACN,QAAQ,GACR,OAAO,GACP,UAAU,GACV,WAAW;AACb,yFAAyF;GACvF,SAAS;AACX,qEAAqE;GACnE,QAAQ;AACV,6EAA6E;GAC3E,SAAS,CAAC;AAEd,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,cAAc,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B;;;OAGG;IACH,GAAG,CAAC,EAAE,aAAa,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,EAAE,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACrD;AAED,6FAA6F;AAC7F,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,IAAI,EAAE,SAAS,GAAG,WAAW,CAAC;IAC9B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACxD;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kEAAkE;IAClE,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA+PD;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,SAAS,eAAe,EAAE,EACjC,OAAO,GAAE,cAAmB,GAC3B,WAAW,CAimBb"}

package/dist/analyze/static-graph.js

@@ -185,7 +185,7 @@ function positionsIn(code) {
         return { line: low + 1, column: offset - starts[low] };
     };
 }
-/** `span.box` — a template element as written, static attributes only, like describeJsx. */
+/** `span.box`: a template element as written, static attributes only, like describeJsx. */
 function describeTemplateElement(el) {
     let id = '';
     const classes = [];
@@ -200,7 +200,7 @@ function describeTemplateElement(el) {
     }
     return `${el.tag}${id}${classes.map((c) => `.${c}`).join('')}`;
 }
-/** Which holes an attribute value reads — one for `=${x}`, several for `"a-${x}-${y}"`. */
+/** Which holes an attribute value reads: one for `=${x}`, several for `"a-${x}-${y}"`. */
 function valueHoles(value) {
     if (!value)
         return [];
@@ -211,7 +211,7 @@ function valueHoles(value) {
     return [];
 }
 /**
- * `span.num`, `div#root` — the element as written.
+ * `span.num`, `div#root`: the element as written.
  *
  * Static attributes only: a class computed at runtime is not something the source can name,
  * and guessing would put a lie on the card.
@@ -271,7 +271,7 @@ export function analyzeReactiveGraph(files, options = {}) {
     const unresolved = [];
     /**
      * What each component's body names. Kept apart from `reads`, which becomes dependency
-     * edges — a component mentioning a route table does not depend on it reactively.
+     * edges: a component mentioning a route table does not depend on it reactively.
      */
     const componentMentions = new Map();
     let seq = 0;
@@ -465,8 +465,8 @@ export function analyzeReactiveGraph(files, options = {}) {
         /**
          * The elements each component writes, as a tree.
          *
-         * Nothing has run, so this is the structure the source states outright. A hole —
-         * `{items().map(...)}`, a `<Show>` body — is decided at runtime and has no elements
+         * Nothing has run, so this is the structure the source states outright. A hole ,
+         * `{items().map(...)}`, a `<Show>` body: is decided at runtime and has no elements
          * here; the tag stands in its place and fills in once the application is up.
          */
         const describeTree = (el) => {
@@ -487,7 +487,7 @@ export function analyzeReactiveGraph(files, options = {}) {
             // A capitalised tag renders its own dom, so it stands here as itself and the panel
             // pulls that component's row in. `components` has the directives, `here` the names
             // this file declares; anything else is a name another file exports, which is only
-            // resolvable once they have all been read. The children stay either way — they are
+            // resolvable once they have all been read. The children stay either way, they are
             // written here, and a row that resolves replaces them with the component's own.
             if (tag[0] === tag[0]?.toUpperCase()) {
                 const node = { label: tag, children, ...(where ? { at: where } : {}) };
@@ -532,7 +532,7 @@ export function analyzeReactiveGraph(files, options = {}) {
          * The tags and holes are inside a string, so none of the walks above can see them: a
          * `<Show>` in a template is not a JSXElement and a `${count()}` is not an expression
          * container. The template parser reads the string into the same shape the compiler
-         * lowers, and each hole maps back by index to the expression Babel already parsed —
+         * lowers, and each hole maps back by index to the expression Babel already parsed ,
          * which is where the position and the names read come from.
          */
         walk(program, (node, stack) => {
@@ -672,7 +672,7 @@ export function analyzeReactiveGraph(files, options = {}) {
                     }
                 }
             };
-            // Whatever body the template is written in — the same lookup the tag walk uses.
+            // Whatever body the template is written in, the same lookup the tag walk uses.
             let owner;
             for (let i = stack.length - 1; i >= 0; i--) {
                 const found = components.get(stack[i]);
@@ -795,7 +795,7 @@ export function analyzeReactiveGraph(files, options = {}) {
     /**
      * A file-route belongs to the outlet it renders into.
      *
-     * Nothing names these components — the table comes from the directory — so a page that
+     * Nothing names these components: the table comes from the directory, so a page that
      * declares no signals is connected to nothing at all and sits on its own. `<Outlet />` is
      * the hole a matched route fills, so it is the honest owner; a router with no outlet
      * written out renders into itself. Only one of either is a definite answer: with two
@@ -819,7 +819,7 @@ export function analyzeReactiveGraph(files, options = {}) {
      * The api routes hang off one card of their own.
      *
      * A handler is served because of the directory it sits in, so like a page nothing names it
-     * — but unlike a page nothing renders it either, and hanging it off the router would say
+     *: but unlike a page nothing renders it either, and hanging it off the router would say
      * something false. A root of its own is what it is: one card, the handlers under it.
      */
     const loose = pending.filter((p) => p.node.kind === 'handler' && p.node.createdIn === undefined);