@bendyline/squisq 1.5.2 → 2.0.0

package/src/__tests__/fixtures/asciiDiagrams.ts

@@ -0,0 +1,287 @@
+/**
+ * Shared ASCII-diagram fixtures for the codec test suites (parse, render
+ * fixpoint, detection corpus, pipeline). Positive fixtures are the parse
+ * contract; the negative corpus is the detection contract.
+ */
+
+export const TWO_BOX_VERTICAL = [
+  '┌────────┐',
+  '│ Alpha  │',
+  '└───┬────┘',
+  '    │',
+  '    ▼',
+  '┌────────┐',
+  '│ Beta   │',
+  '└────────┘',
+].join('\n');
+
+export const TWO_BOX_VERTICAL_ASCII = [
+  '+--------+',
+  '| Alpha  |',
+  '+---+----+',
+  '    |',
+  '    v',
+  '+--------+',
+  '| Beta   |',
+  '+--------+',
+].join('\n');
+
+export const TWO_BOX_HORIZONTAL_ASCII = [
+  '+--------+     +--------+',
+  '| Input  | --> | Output |',
+  '+--------+     +--------+',
+].join('\n');
+
+export const TWO_BOX_HORIZONTAL_UNICODE = [
+  '┌────────┐     ┌────────┐',
+  '│ Input  │────►│ Output │',
+  '└────────┘     └────────┘',
+].join('\n');
+
+export const UNDIRECTED = [
+  '┌────────┐     ┌────────┐',
+  '│ Left   │─────│ Right  │',
+  '└────────┘     └────────┘',
+].join('\n');
+
+export const BIDIRECTIONAL = [
+  '┌───────┐         ┌───────┐',
+  '│ Peer  │◄───────►│ Peer  │',
+  '└───────┘         └───────┘',
+].join('\n');
+
+export const FAN_OUT_COLUMNS = [
+  '┌──────────────────────┐',
+  '│        Source        │',
+  '└──────┬───────┬───────┘',
+  '       │       │',
+  '       ▼       ▼',
+  '   ┌─────┐ ┌─────┐',
+  '   │ One │ │ Two │',
+  '   └─────┘ └─────┘',
+].join('\n');
+
+export const FAN_OUT_BUS = [
+  '┌──────────────────────┐',
+  '│        Source        │',
+  '└──────────┬───────────┘',
+  '     ┌─────┴─────┐',
+  '     ▼           ▼',
+  '  ┌─────┐     ┌─────┐',
+  '  │ One │     │ Two │',
+  '  └─────┘     └─────┘',
+].join('\n');
+
+export const PARALLEL_DUPES = [
+  '┌────────────────┐',
+  '│     Wide A     │',
+  '└──┬──────────┬──┘',
+  '   │          │',
+  '   ▼          ▼',
+  '┌────────────────┐',
+  '│     Wide B     │',
+  '└────────────────┘',
+].join('\n');
+
+/** The canonical AI-style nested diagram: container + 2×3 children + column edges. */
+export const NESTED_CONTAINER = [
+  '┌────────────────────────────────────────────────┐',
+  '│                 Data Pipeline                  │',
+  '│                                                │',
+  '│   ┌────────┐    ┌─────────┐    ┌────────┐      │',
+  '│   │ Ingest │    │ Enrich  │    │ Export │      │',
+  '│   └───┬────┘    └────┬────┘    └───┬────┘      │',
+  '│       │              │             │           │',
+  '│       ▼              ▼             ▼           │',
+  '│   ┌────────┐    ┌─────────┐    ┌────────┐      │',
+  '│   │ Raw    │    │ Silver  │    │ Gold   │      │',
+  '│   └────────┘    └─────────┘    └────────┘      │',
+  '└────────────────────────────────────────────────┘',
+].join('\n');
+
+export const CONTAINER_EMBEDDED_TITLE = [
+  '┌─── Cluster ────┐',
+  '│  ┌──────────┐  │',
+  '│  │ Worker   │  │',
+  '│  └──────────┘  │',
+  '└────────────────┘',
+].join('\n');
+
+export const MULTILINE_LABELS = [
+  '┌──────────────┐      ┌──────────────┐',
+  '│ molen-kernel │      │ molen-client │',
+  '│ headless sim │      │ three.js     │',
+  '│ no DOM       │      │ cameras      │',
+  '└──────┬───────┘      └──────────────┘',
+  '       │',
+  '       ▼',
+  '┌──────────────┐',
+  '│    Worker    │',
+  '└──────────────┘',
+].join('\n');
+
+/** `├──┤` interior dividers are indistinguishable from stacked shared-border boxes → two nodes. */
+export const SECTIONED_CARD = [
+  '┌──────────┐',
+  '│ Header   │',
+  '├──────────┤',
+  '│ Body     │',
+  '└──────────┘',
+].join('\n');
+
+export const STACKED_SHARED_BORDER_ASCII = [
+  '+-------+',
+  '| Upper |',
+  '+-------+',
+  '| Lower |',
+  '+-------+',
+].join('\n');
+
+export const EDGE_LABEL = [
+  '┌────────┐             ┌────────┐',
+  '│ Client │──auth──────►│ Server │',
+  '└────────┘             └────────┘',
+].join('\n');
+
+export const EDGE_LABEL_SPACED = [
+  '┌────────┐               ┌────────┐',
+  '│ Client │── auth flow ─►│ Server │',
+  '└────────┘               └────────┘',
+].join('\n');
+
+export const DUPLICATE_LABELS = [
+  '┌───────┐     ┌───────┐',
+  '│ Cache │     │ Cache │',
+  '└───────┘     └───────┘',
+].join('\n');
+
+export const ROUNDED_AND_DOUBLE = [
+  '╭────────╮      ╔════════╗',
+  '│ Round  │      ║ Double ║',
+  '╰────────╯      ╚════════╝',
+].join('\n');
+
+export const SINGLE_BOX = ['┌────────┐', '│ Alone  │', '└────────┘'].join('\n');
+
+/** Every positive fixture the fixpoint suite must survive. */
+export const POSITIVE_FIXTURES: Record<string, string> = {
+  TWO_BOX_VERTICAL,
+  TWO_BOX_VERTICAL_ASCII,
+  TWO_BOX_HORIZONTAL_ASCII,
+  TWO_BOX_HORIZONTAL_UNICODE,
+  UNDIRECTED,
+  BIDIRECTIONAL,
+  FAN_OUT_COLUMNS,
+  FAN_OUT_BUS,
+  PARALLEL_DUPES,
+  NESTED_CONTAINER,
+  CONTAINER_EMBEDDED_TITLE,
+  MULTILINE_LABELS,
+  SECTIONED_CARD,
+  STACKED_SHARED_BORDER_ASCII,
+  EDGE_LABEL,
+  EDGE_LABEL_SPACED,
+  DUPLICATE_LABELS,
+  ROUNDED_AND_DOUBLE,
+};
+
+// ---------------------------------------------------------------------------
+// Negative corpus — all of these must be REJECTED by detectAsciiDiagram.
+// ---------------------------------------------------------------------------
+
+export const NEG_MARKDOWN_TABLE = [
+  '| Name  | Role     |',
+  '|-------|----------|',
+  '| Ada   | Engineer |',
+  '| Grace | Admiral  |',
+].join('\n');
+
+export const NEG_PSQL_TABLE = [
+  '+----+-------+',
+  '| id | name  |',
+  '+----+-------+',
+  '| 1  | Alice |',
+  '+----+-------+',
+  '| 2  | Bob   |',
+  '+----+-------+',
+].join('\n');
+
+export const NEG_MYSQL_TABLE = [
+  '+----------+----------+---------+',
+  '| Database | Table    | Rows    |',
+  '+----------+----------+---------+',
+  '| app      | users    | 1042    |',
+  '| app      | sessions | 98213   |',
+  '+----------+----------+---------+',
+].join('\n');
+
+export const NEG_SHELL_PIPES = [
+  'cat access.log | grep 500 | awk "{print $7}" | sort | uniq -c',
+  'ps aux | head -20',
+  'docker ps -a | wc -l',
+].join('\n');
+
+export const NEG_TS_UNION = [
+  'type Result<T> =',
+  '  | { ok: true; value: T }',
+  '  | { ok: false; error: Error };',
+  'const x: A | B | C = pick();',
+].join('\n');
+
+export const NEG_SQL_DDL = [
+  'CREATE TABLE users (',
+  '  id INTEGER PRIMARY KEY,',
+  '  name TEXT NOT NULL,',
+  '  created_at TIMESTAMP',
+  ');',
+].join('\n');
+
+export const NEG_FILE_TREE = [
+  'src/',
+  '├── components/',
+  '│   ├── App.tsx',
+  '│   └── Button.tsx',
+  '└── utils/',
+  '    └── math.ts',
+].join('\n');
+
+export const NEG_YAML = [
+  'services:',
+  '  web:',
+  '    image: nginx',
+  '    ports:',
+  '      - "80:80"',
+].join('\n');
+
+export const NEG_LOG_COLUMNS = [
+  '2026-01-01 │ INFO  │ started',
+  '2026-01-02 │ WARN  │ disk low',
+  '2026-01-03 │ ERROR │ crashed',
+].join('\n');
+
+export const NEG_PROSE_HEAVY = [
+  'This paragraph explains the architecture in detail before showing it.',
+  'There is a great deal of text here that is not part of any box at all,',
+  'and the actual diagram below is a small part of the overall content.',
+  'More prose lines continue to pad this out considerably, adding noise',
+  'that should push the loose-content ratio well past the threshold.',
+  '┌───┐ ┌───┐',
+  '│ A │ │ B │',
+  '└───┘ └───┘',
+  'And afterwards even more explanation text follows the tiny diagram,',
+  'ensuring that the fence is mostly prose rather than mostly diagram.',
+].join('\n');
+
+export const NEGATIVE_FIXTURES: Record<string, string> = {
+  NEG_MARKDOWN_TABLE,
+  NEG_PSQL_TABLE,
+  NEG_MYSQL_TABLE,
+  NEG_SHELL_PIPES,
+  NEG_TS_UNION,
+  NEG_SQL_DDL,
+  NEG_FILE_TREE,
+  NEG_YAML,
+  NEG_LOG_COLUMNS,
+  NEG_PROSE_HEAVY,
+  SINGLE_BOX,
+};

package/src/__tests__/fixtures/asciiTimelines.ts

@@ -0,0 +1,35 @@
+/** The motivating timeline from the feature request, byte-for-byte inside its fence. */
+export const TICK_INTERPOLATION_TIMELINE = ` kernel ticks (30 Hz):     T28        T29        T30        T31
+ ─────────────────────●──────────●──────────●──────────●──────────► sim time
+ deltas sent:         └─Δ28──────└─Δ29──────└─Δ30──────└─Δ31
+
+ client frames (e.g. 120 Hz):  f f f f f f f f f f f f f f f f
+ estimated kernel clock:                        ▲ estTick ≈ 30.4
+ render position:                   ▲ renderTick = estTick − 1.5 ≈ 28.9
+                                    └─ interpolate between snapshot T28 and T29 at t=0.9`;
+
+/** Two independently labelled tracks plus an explicit cross-track branch. */
+export const MULTI_TRACK_BRANCH_TIMELINE = [
+  'Kernel: ● T28 :: snapshot {#t28} ──────────● T29 :: snapshot {#t29} ──────────►',
+  'Client: ● F28 :: snapshot {#f28} ──────────● F29 :: snapshot {#f29} ──────────►',
+  'branch: t29 -> f29 : interpolation path',
+].join('\n');
+
+/** Sparse ASCII form: only an explicit `timeline` fence should claim it. */
+export const SINGLE_POINT_ASCII_TIMELINE = 'Release: *---- Alpha {#alpha} ---->';
+
+/** Multi-lane AI-authored flow with a right-edge error return. */
+export const WRAPPED_CLIENT_KERNEL_TIMELINE = `  CLIENT (main thread)                          KERNEL (Web Worker / Node)
+  ────────────────────                          ──────────────────────────
+  input events ──► InputMap ──► command ───────►  validate (schema)
+                                                  ├─ invalid → command-rejected event ─┐
+                                                  └─ valid → queue at tick T           │
+                                                                                       │
+                                                  tick T: phases                       │
+                                                  commands → update → physics → late   │
+                                                                                       │
+  interpolation buffer ◄── delta {tick T} ◄────── dirty-tracked per-tick delta         │
+  (render ~1.5 ticks                                                                   │
+   behind, lerp/slerp)  ◄── keyframe ◄─────────── every 60 ticks + on demand           │
+                                                                                       │
+  error surfaced to user/agent ◄───────────────────────────────────────────────────────┘`;

package/src/__tests__/fixtures/treeviewFixtures.ts

@@ -0,0 +1,243 @@
+/**
+ * Battle-test corpus for the ASCII treeview codec: a broad set of AI-style
+ * trees (project scaffolds, monorepos, dependency trees, category/decision
+ * outlines, forests) with their intended flat semantics. Every fixture is
+ * verified to detect + parse to exactly this shape + round-trip byte-stably.
+ *
+ * GENERATED by scratchpad/gen-tree-fixtures.mjs — edit there and re-run.
+ */
+
+export interface TreeFixture {
+  name: string;
+  category: string;
+  art: string;
+  /** Flat "depth:label[ #comment]" lines, depth-first. */
+  expect: string[];
+}
+
+export const TREE_FIXTURES: TreeFixture[] = [
+  {
+    name: 'reactApp',
+    category: 'scaffold',
+    art: `my-app/
+├── public/
+│   └── index.html
+├── src/
+│   ├── App.tsx
+│   ├── index.tsx
+│   └── components/
+│       ├── Header.tsx
+│       └── Footer.tsx
+├── package.json
+└── tsconfig.json`,
+    expect: [
+      '0:my-app/',
+      '1:public/',
+      '2:index.html',
+      '1:src/',
+      '2:App.tsx',
+      '2:index.tsx',
+      '2:components/',
+      '3:Header.tsx',
+      '3:Footer.tsx',
+      '1:package.json',
+      '1:tsconfig.json',
+    ],
+  },
+  {
+    name: 'pythonPkg',
+    category: 'scaffold',
+    art: `mypackage/
+├── __init__.py
+├── core.py
+├── utils/
+│   ├── __init__.py
+│   └── helpers.py
+└── tests/
+    └── test_core.py`,
+    expect: [
+      '0:mypackage/',
+      '1:__init__.py',
+      '1:core.py',
+      '1:utils/',
+      '2:__init__.py',
+      '2:helpers.py',
+      '1:tests/',
+      '2:test_core.py',
+    ],
+  },
+  {
+    name: 'monorepo',
+    category: 'scaffold',
+    art: `workspace/
+├── packages/
+│   ├── core/
+│   ├── ui/
+│   └── cli/
+├── apps/
+│   └── web/
+└── package.json`,
+    expect: [
+      '0:workspace/',
+      '1:packages/',
+      '2:core/',
+      '2:ui/',
+      '2:cli/',
+      '1:apps/',
+      '2:web/',
+      '1:package.json',
+    ],
+  },
+  {
+    name: 'asciiStyle',
+    category: 'style',
+    art: `docs/
+|-- guide.md
+|-- api/
+|   |-- rest.md
+|   \`-- graphql.md
+\`-- README.md`,
+    expect: ['0:docs/', '1:guide.md', '1:api/', '2:rest.md', '2:graphql.md', '1:README.md'],
+  },
+  {
+    name: 'plusStyle',
+    category: 'style',
+    art: `root
++-- moduleA
+|   +-- fileA1
+|   +-- fileA2
++-- moduleB
+    +-- fileB1`,
+    expect: ['0:root', '1:moduleA', '2:fileA1', '2:fileA2', '1:moduleB', '2:fileB1'],
+  },
+  {
+    name: 'withComments',
+    category: 'comments',
+    art: `service/
+├── main.go       # entrypoint
+├── config.yaml   # runtime config
+├── handlers/     # HTTP handlers
+│   └── users.go
+└── go.mod`,
+    expect: [
+      '0:service/',
+      '1:main.go #entrypoint',
+      '1:config.yaml #runtime config',
+      '1:handlers/ #HTTP handlers',
+      '2:users.go',
+      '1:go.mod',
+    ],
+  },
+  {
+    name: 'depTree',
+    category: 'outline',
+    art: `express@4.18.2
+├── body-parser@1.20.1
+│   ├── bytes@3.1.2
+│   └── qs@6.11.0
+├── cookie@0.5.0
+└── debug@2.6.9
+    └── ms@2.0.0`,
+    expect: [
+      '0:express@4.18.2',
+      '1:body-parser@1.20.1',
+      '2:bytes@3.1.2',
+      '2:qs@6.11.0',
+      '1:cookie@0.5.0',
+      '1:debug@2.6.9',
+      '2:ms@2.0.0',
+    ],
+  },
+  {
+    name: 'categoryOutline',
+    category: 'outline',
+    art: `Animals
+├── Mammals
+│   ├── Dogs
+│   └── Cats
+├── Birds
+│   ├── Eagles
+│   └── Sparrows
+└── Reptiles
+    └── Snakes`,
+    expect: [
+      '0:Animals',
+      '1:Mammals',
+      '2:Dogs',
+      '2:Cats',
+      '1:Birds',
+      '2:Eagles',
+      '2:Sparrows',
+      '1:Reptiles',
+      '2:Snakes',
+    ],
+  },
+  {
+    name: 'decisionOutline',
+    category: 'outline',
+    art: `Deploy?
+├── Tests pass
+│   ├── Deploy to staging
+│   └── Run smoke tests
+└── Tests fail
+    └── Notify team`,
+    expect: [
+      '0:Deploy?',
+      '1:Tests pass',
+      '2:Deploy to staging',
+      '2:Run smoke tests',
+      '1:Tests fail',
+      '2:Notify team',
+    ],
+  },
+  {
+    name: 'forest',
+    category: 'shape',
+    art: `frontend/
+├── index.html
+└── app.js
+backend/
+├── server.py
+└── models.py
+shared/
+└── types.ts`,
+    expect: [
+      '0:frontend/',
+      '1:index.html',
+      '1:app.js',
+      '0:backend/',
+      '1:server.py',
+      '1:models.py',
+      '0:shared/',
+      '1:types.ts',
+    ],
+  },
+  {
+    name: 'deepChain',
+    category: 'shape',
+    art: `a/
+└── b/
+    └── c/
+        └── d/
+            └── e.txt`,
+    expect: ['0:a/', '1:b/', '2:c/', '3:d/', '4:e.txt'],
+  },
+  {
+    name: 'wideFlat',
+    category: 'shape',
+    art: `config/
+├── dev.json
+├── staging.json
+├── prod.json
+├── test.json
+└── local.json`,
+    expect: [
+      '0:config/',
+      '1:dev.json',
+      '1:staging.json',
+      '1:prod.json',
+      '1:test.json',
+      '1:local.json',
+    ],
+  },
+];