diagramo 0.1.0

package/LICENSE

@@ -0,0 +1,4 @@
+UNLICENSED
+
+All rights reserved.
+Replace this file with your intended license before publishing.

package/README.md

@@ -0,0 +1,171 @@
+# diagramo
+
+Diagramo renders Surface, Core, and NCF S-expression diagrams into SVG.
+
+This package includes:
+
+- `dist/diagramo.js`: ESM library entry for npm consumers
+- `dist/diagramo.browser.js`: standalone browser bundle for drop-in static pages
+
+## Install
+
+```bash
+npm install diagramo
+```
+
+This package declares `d3` and `d3-dag` as runtime dependencies.
+
+## ESM usage
+
+```js
+import { renderAll, renderElement, renderSource, compileSource } from "diagramo";
+
+renderAll(document);
+```
+
+Render a single element:
+
+```js
+import { renderElement } from "diagramo";
+
+const el = document.querySelector("pre.diagramo");
+renderElement(el, { zoom: false });
+```
+
+Render directly into a host element:
+
+```js
+import { renderSource } from "diagramo";
+
+const host = document.querySelector("#diagram-host");
+renderSource(`(program (X) (-> f X Y))`, host, { zoom: false, height: 320 });
+```
+
+## Static page drop-in
+
+After you publish the package, you can use the browser bundle from a CDN:
+
+```html
+<pre class="diagramo">
+(program
+  (X)
+  (ZinsideX:X)
+  (-> f A B)
+  (-> g B A)
+  (-> h X Y)
+)</pre>
+
+<script src="https://unpkg.com/diagramo/dist/diagramo.browser.js"></script>
+```
+
+The browser bundle auto-renders `pre.diagramo` elements on page load.
+
+### Default behavior
+
+- zoom is off by default
+- source `<pre>` elements are replaced with rendered hosts
+- labels default to IDs in Surface shorthand
+- `(-> f A B)` synthesizes missing nodes `A` and `B`
+
+### Data attributes
+
+These can be placed on the source element or the host:
+
+- `data-diagramo-mode="auto|surface|core|ncf"`
+- `data-diagramo-zoom="on|off"`
+- `data-diagramo-ortho="on|off"`
+- `data-diagramo-wiring="on|off"`
+- `data-diagramo-glyphs="on|off"`
+- `data-diagramo-height="360"`
+
+Example:
+
+```html
+<pre class="diagramo" data-diagramo-height="420" data-diagramo-zoom="off">
+(program
+  (X)
+  (-> f X Y)
+)</pre>
+```
+
+## Browser global API
+
+The standalone browser bundle exposes `window.Diagramo` with:
+
+- `parseSexpr`
+- `compileAst`
+- `compileSource`
+- `emitCoreDoc`
+- `emitNCFDoc`
+- `renderSource`
+- `renderElement`
+- `renderAll`
+- `autoRender`
+
+Example:
+
+```html
+<script>
+  window.Diagramo.renderAll();
+</script>
+```
+
+## API
+
+### `compileSource(source, mode = "auto")`
+
+Compiles source text into:
+
+```js
+{
+  kind,     // "surface" | "core" | "ncf"
+  core,     // canonical core doc object or null
+  ncf,      // canonical ncf doc object
+  coreText, // core serialization
+  ncfText,  // ncf serialization
+  warnings  // array of warning strings
+}
+```
+
+### `renderSource(source, host, options = {})`
+
+Options:
+
+- `mode`
+- `zoom`
+- `ortho`
+- `wiring`
+- `glyphs`
+- `height`
+- `observeResize`
+- `replaceSource`
+
+Returns:
+
+```js
+{
+  host,
+  compiled,
+  fit,
+  rerender
+}
+```
+
+## Surface shorthand supported
+
+```lisp
+(A)              ; node A, label "A"
+(ZinsideX:X)     ; child ZinsideX under X
+(-> f A B)       ; arrow f from A to B, label "f", synthesize A/B if needed
+```
+
+## Notes before publishing
+
+- The package name `diagramo` may already be taken on npm. Change `name` in `package.json` if needed.
+- The package is marked `UNLICENSED`. Replace the license field and `LICENSE` file with your intended license before publishing.
+
+## Files
+
+- `dist/diagramo.js`
+- `dist/diagramo.browser.js`
+- `examples/static-page.html`