@diagrammo/dgmo 0.46.0 → 0.48.0

package/src/class/parser.ts

@@ -1,635 +0,0 @@
-import { resolveColorWithDiagnostic } from '../colors';
-import type { PaletteColors } from '../palettes';
-import {
-  makeDgmoError,
-  formatDgmoError,
-  NAME_DIAGNOSTIC_CODES,
-  nameMergedMessage,
-} from '../diagnostics';
-import { validateLabelCharacters } from '../utils/arrows';
-import {
-  measureIndent,
-  parseFirstLine,
-  OPTION_NOCOLON_RE,
-  tryParseSharedOption,
-} from '../utils/parsing';
-import { normalizeName, displayName } from '../utils/name-normalize';
-import { tryCollectNote, resolveNotes, type DiagramNote } from '../utils/notes';
-import type { Writable } from '../utils/brand';
-import type {
-  ParsedClassDiagram,
-  ClassNode,
-  ClassMember,
-  ClassModifier,
-  MemberVisibility,
-  RelationshipType,
-} from './types';
-
-// ============================================================
-// Helpers
-// ============================================================
-
-function classId(name: string): string {
-  return normalizeName(name);
-}
-
-// ============================================================
-// Regex patterns
-// ============================================================
-
-// Class declaration: [modifier] ClassName [extends Parent] [implements Interface] [color] [as alias]
-// Color is the universal §1.5 trailing-token form (a bare lowercase palette
-// color word after structural slots). Multi-word names allowed
-// (`Customer Service`); quote with `"name"` if name contains reserved chars.
-// ClassName must start with uppercase. Captures (positional):
-//   1: modifier (abstract|interface|enum) | undefined
-//   2: quotedClassName | undefined
-//   3: bareClassName | undefined
-//   4: quotedExtends | undefined
-//   5: bareExtends | undefined
-//   6: quotedImplements | undefined
-//   7: bareImplements | undefined
-//   8: legacy bracket modifier | undefined
-//   9: color (trailing token; recognized palette word) | undefined
-//  10: alias literal (TD-18) | undefined
-const CLASS_DECL_RE =
-  /^(?:(abstract|interface|enum)\s+)?(?:"([^"]+)"|([A-Z][^":]*?))(?:\s+extends\s+(?:"([^"]+)"|([A-Z][^":]*?)))?(?:\s+implements\s+(?:"([^"]+)"|([A-Z][^":]*?)))?(?:\s+\[(abstract|interface|enum)\])?(?:\s+(red|orange|yellow|green|blue|purple|teal|cyan|gray|black|white))?(?:\s+as\s+([A-Za-z][A-Za-z0-9_]{0,11}))?\s*$/;
-
-// Relationship — arrow syntax (indented under source class).
-// Arrows: --|>  ..|>  *--  o--  ..>  ->
-// Captures: [1]=arrow [2]=quotedTarget [3]=bareTarget [4]=label
-// Bare target accepts both `[A-Z]…` (canonical class name) and
-// `[a-z]…` (TD-18 alias literal) so alias references resolve here.
-const INDENT_REL_ARROW_RE =
-  /^(--\|>|\.\.\|>|\*--|o--|\.\.>|->)\s*(?:"([^"]+)"|([A-Za-z][^":]*?))(?:\s+:?\s*(.+))?$/;
-
-// Legacy top-level relationship regex (used only for detection/rejection)
-// Captures: [1]=qSrc [2]=bareSrc [3]=arrow [4]=qTarget [5]=bareTarget [6]=label
-const REL_ARROW_RE =
-  /^(?:"([^"]+)"|([A-Z][^":]*?))\s*(--\|>|\.\.\|>|\*--|o--|\.\.>|->)\s*(?:"([^"]+)"|([A-Z][^":]*?))(?:\s+:?\s*(.+))?$/;
-
-// Member line patterns
-const VISIBILITY_RE = /^([+\-#])\s*/;
-const STATIC_SUFFIX_RE = /\{static\}\s*$/;
-const METHOD_RE = /^(.+?)\(([^)]*)\)(?:\s*:\s*(.+))?$/;
-const FIELD_RE = /^(.+?)\s*:\s*(.+)$/;
-
-const ARROW_TO_TYPE: Record<string, RelationshipType> = {
-  '--|>': 'extends',
-  '..|>': 'implements',
-  '*--': 'composes',
-  'o--': 'aggregates',
-  '..>': 'depends',
-  '->': 'associates',
-};
-
-function parseVisibility(prefix: string): MemberVisibility {
-  switch (prefix) {
-    case '-':
-      return 'private';
-    case '#':
-      return 'protected';
-    default:
-      return 'public';
-  }
-}
-
-// ============================================================
-// Member parser
-// ============================================================
-
-function parseMember(
-  line: string,
-  lineNumber: number,
-  isEnum: boolean
-): ClassMember | null {
-  let text = line.trim();
-  if (!text) return null;
-
-  // Enum values: plain text, no colon, no parens needed
-  if (isEnum) {
-    return {
-      name: text,
-      visibility: 'public',
-      isStatic: false,
-      isMethod: false,
-      lineNumber,
-    };
-  }
-
-  // Extract visibility prefix
-  let visibility: MemberVisibility = 'public';
-  const visMatch = text.match(VISIBILITY_RE);
-  if (visMatch) {
-    // VISIBILITY_RE captures the prefix; group 1 always exists when matched.
-    visibility = parseVisibility(visMatch[1]!);
-    text = text.substring(visMatch[0].length);
-  }
-
-  // Check for {static} suffix
-  let isStatic = false;
-  if (STATIC_SUFFIX_RE.test(text)) {
-    isStatic = true;
-    text = text.replace(STATIC_SUFFIX_RE, '').trim();
-  }
-
-  // Method: name(params) : returnType
-  const methodMatch = text.match(METHOD_RE);
-  if (methodMatch) {
-    // METHOD_RE: [1]=name, [2]=params, [3]=optional returnType.
-    const methodType = methodMatch[3]?.trim();
-    return {
-      name: methodMatch[1]!.trim(),
-      params: methodMatch[2]!.trim(),
-      ...(methodType !== undefined && { type: methodType }),
-      visibility,
-      isStatic,
-      isMethod: true,
-      lineNumber,
-    };
-  }
-
-  // Field: name : type
-  const fieldMatch = text.match(FIELD_RE);
-  if (fieldMatch) {
-    // FIELD_RE: [1]=name, [2]=type.
-    return {
-      name: fieldMatch[1]!.trim(),
-      type: fieldMatch[2]!.trim(),
-      visibility,
-      isStatic,
-      isMethod: false,
-      lineNumber,
-    };
-  }
-
-  // Plain name (field with no type)
-  return {
-    name: text,
-    visibility,
-    isStatic,
-    isMethod: false,
-    lineNumber,
-  };
-}
-
-// ============================================================
-// Main parser
-// ============================================================
-
-export function parseClassDiagram(
-  content: string,
-  palette?: PaletteColors
-): ParsedClassDiagram {
-  const lines = content.split('\n');
-  const options: Record<string, string> = {};
-  const result: Writable<ParsedClassDiagram> = {
-    type: 'class',
-    classes: [],
-    relationships: [],
-    options,
-    diagnostics: [],
-    error: null,
-  };
-
-  const classMap = new Map<string, Writable<ClassNode>>();
-  const notes: DiagramNote[] = [];
-
-  // Per-parse alias literal → canonical class id (TD-18). Per C8.
-  const nameAliasMap = new Map<string, string>();
-  function resolveAliasName(token: string | undefined): string | undefined {
-    if (!token) return token;
-    const trimmed = token.trim();
-    const hit = nameAliasMap.get(trimmed);
-    if (hit !== undefined) {
-      // The aliasMap stores canonical-id; need to invert to canonical-name
-      // for callers like getOrCreateClass that hash the name. Walk classMap.
-      for (const [, node] of classMap) {
-        if (classId(node.name) === hit) return node.name;
-      }
-    }
-    return token;
-  }
-  let currentClass: Writable<ClassNode> | null = null;
-  let contentStarted = false;
-
-  function getOrCreateClass(
-    name: string,
-    lineNumber: number
-  ): Writable<ClassNode> {
-    const key = classId(name);
-    const existing = classMap.get(key);
-    if (existing) {
-      const incomingDisplay = displayName(name);
-      const existingDisplay = displayName(existing.name);
-      if (incomingDisplay !== existingDisplay) {
-        result.diagnostics.push(
-          makeDgmoError(
-            lineNumber,
-            nameMergedMessage({
-              incomingDisplay,
-              incomingLine: lineNumber,
-              existingDisplay,
-              existingLine: existing.lineNumber,
-            }),
-            'warning',
-            NAME_DIAGNOSTIC_CODES.NAME_MERGED
-          )
-        );
-      }
-      return existing;
-    }
-
-    const node: Writable<ClassNode> = {
-      id: key,
-      name,
-      members: [],
-      lineNumber,
-    };
-    classMap.set(key, node);
-    result.classes.push(node);
-    return node;
-  }
-
-  for (let i = 0; i < lines.length; i++) {
-    // In-bounds by loop guard.
-    const raw = lines[i]!;
-    const trimmed = raw.trim();
-    const lineNumber = i + 1;
-    const indent = measureIndent(raw);
-
-    // Skip empty lines
-    if (!trimmed) {
-      // Empty line ends current class context
-      if (indent === 0) currentClass = null;
-      continue;
-    }
-
-    // Skip comments
-    if (trimmed.startsWith('//')) continue;
-
-    // Note annotation (top-level): `note <ClassName> [inline body]` + an
-    // optional indented body. Checked before options so a note is never
-    // swallowed as an option; gated to indent 0 so an indented member
-    // starting with "note" stays a member. `note -> X` is excluded.
-    if (indent === 0) {
-      const noteResult = tryCollectNote(
-        lines,
-        i,
-        indent,
-        palette,
-        result.diagnostics
-      );
-      if (noteResult) {
-        currentClass = null;
-        contentStarted = true;
-        if (noteResult.note) notes.push(noteResult.note);
-        i = noteResult.lastIndex;
-        continue;
-      }
-    }
-
-    // First line: bare chart type + optional title (new syntax)
-    if (!contentStarted && indent === 0 && i === 0) {
-      const firstLine = parseFirstLine(trimmed);
-      if (firstLine?.chartType === 'class') {
-        if (firstLine.title) {
-          result.title = firstLine.title;
-          result.titleLineNumber = lineNumber;
-        }
-        continue;
-      }
-    }
-
-    // Space-separated options before content (new syntax): `no-auto-color`
-    // Only match lines starting with a lowercase token (options), not uppercase (class names)
-    if (!contentStarted && indent === 0 && /^[a-z]/.test(trimmed)) {
-      if (trimmed.toLowerCase() === 'no-auto-color') {
-        result.diagnostics.push(
-          makeDgmoError(
-            lineNumber,
-            '"no-auto-color" was removed — colors are always auto-assigned from the palette; delete this line.',
-            'warning'
-          )
-        );
-        continue;
-      }
-      if (tryParseSharedOption(trimmed, options)) {
-        continue;
-      }
-      const optMatch = trimmed.match(OPTION_NOCOLON_RE);
-      if (optMatch) {
-        // OPTION_NOCOLON_RE: [1]=key, [2]=value.
-        const key = optMatch[1]!.toLowerCase();
-        const value = optMatch[2]!.trim();
-        // Don't swallow lines that look like class modifier keywords
-        if (key !== 'abstract' && key !== 'interface' && key !== 'enum') {
-          options[key] = value;
-          continue;
-        }
-      }
-    }
-
-    // Indented lines = relationships or members of current class
-    if (indent > 0 && currentClass) {
-      // Try indented relationship arrow: --|> TargetClass [label]
-      // Captures: [1]=arrow [2]=quotedTarget [3]=bareTarget [4]=label
-      const indentRel = trimmed.match(INDENT_REL_ARROW_RE);
-      if (indentRel) {
-        // INDENT_REL_ARROW_RE: [1]=arrow (always present on match).
-        const arrow = indentRel[1]!;
-        const rawTarget = (indentRel[2] ?? indentRel[3] ?? '').trim();
-        // TD-18: resolve alias literal → canonical class name.
-        const targetName = resolveAliasName(rawTarget) ?? rawTarget;
-        const label = indentRel[4]?.trim();
-
-        getOrCreateClass(targetName, lineNumber);
-
-        if (label) {
-          result.diagnostics.push(
-            ...validateLabelCharacters(label, lineNumber)
-          );
-        }
-        result.relationships.push({
-          source: currentClass.id,
-          target: classId(targetName),
-          // INDENT_REL_ARROW_RE only matches arrows present in ARROW_TO_TYPE.
-          type: ARROW_TO_TYPE[arrow]!,
-          ...(label && { label }),
-          lineNumber,
-        });
-        continue;
-      }
-
-      const member = parseMember(
-        trimmed,
-        lineNumber,
-        currentClass.modifier === 'enum'
-      );
-      if (member) {
-        currentClass.members.push(member);
-      }
-      continue;
-    }
-
-    // At indent 0 — this ends any previous class context
-    currentClass = null;
-    contentStarted = true;
-
-    // Reject top-level relationship arrows — must be indented under source class
-    // Captures: [1]=qSrc [2]=bareSrc [3]=arrow [4]=qTarget [5]=bareTarget [6]=label
-    const relArrow = trimmed.match(REL_ARROW_RE);
-    if (relArrow) {
-      const sourceName = (relArrow[1] ?? relArrow[2] ?? '').trim();
-      const arrow = relArrow[3];
-      const targetName = (relArrow[4] ?? relArrow[5] ?? '').trim();
-      result.diagnostics.push(
-        makeDgmoError(
-          lineNumber,
-          `Relationship "${sourceName} ${arrow} ${targetName}" must be indented under the source class "${sourceName}"`,
-          'warning'
-        )
-      );
-      continue;
-    }
-
-    // Try class declaration
-    // Captures: [1]=modifier [2]=qName [3]=bareName [4]=qExt [5]=bareExt
-    //   [6]=qImpl [7]=bareImpl [8]=bracketMod [9]=color
-    const classDecl = trimmed.match(CLASS_DECL_RE);
-    if (classDecl) {
-      const prefixModifier = classDecl[1] as ClassModifier | undefined;
-      const name = (classDecl[2] ?? classDecl[3] ?? '').trim();
-      const extendsRaw = classDecl[4] ?? classDecl[5];
-      const extendsParent = extendsRaw ? extendsRaw.trim() : undefined;
-      const implementsRaw = classDecl[6] ?? classDecl[7];
-      const implementsInterface = implementsRaw
-        ? implementsRaw.trim()
-        : undefined;
-      const bracketModifier = classDecl[8] as ClassModifier | undefined;
-      const modifier = prefixModifier ?? bracketModifier;
-      const colorName = classDecl[9]?.trim();
-      const color = colorName
-        ? resolveColorWithDiagnostic(
-            colorName,
-            lineNumber,
-            result.diagnostics,
-            palette
-          )
-        : undefined;
-
-      const aliasLiteral = classDecl[10];
-
-      const node = getOrCreateClass(name, lineNumber);
-      if (modifier) node.modifier = modifier;
-      if (color) node.color = color;
-      if (aliasLiteral) nameAliasMap.set(aliasLiteral, classId(name));
-      // Update line number to the declaration line (may have been created by relationship)
-      node.lineNumber = lineNumber;
-
-      // Inline extends creates an extends relationship — resolve alias.
-      if (extendsParent) {
-        const ext = resolveAliasName(extendsParent) ?? extendsParent;
-        getOrCreateClass(ext, lineNumber);
-        result.relationships.push({
-          source: classId(name),
-          target: classId(ext),
-          type: 'extends',
-          lineNumber,
-        });
-      }
-
-      // Inline implements creates an implements relationship — resolve alias.
-      if (implementsInterface) {
-        const impl =
-          resolveAliasName(implementsInterface) ?? implementsInterface;
-        getOrCreateClass(impl, lineNumber);
-        result.relationships.push({
-          source: classId(name),
-          target: classId(impl),
-          type: 'implements',
-          lineNumber,
-        });
-      }
-
-      currentClass = node;
-      continue;
-    }
-
-    // Catch-all: nothing matched this line
-    result.diagnostics.push(
-      makeDgmoError(
-        lineNumber,
-        `Unexpected line: '${trimmed}'. Classes start uppercase at indent 0 ('Ship'); members are indented and colon-typed ('+ name: string', '+ sail(): void'); relationships are indented arrows ('--|> Vessel'). (§10)`,
-        'warning'
-      )
-    );
-  }
-
-  // Resolve note refs against class names (forward refs OK — runs after all
-  // classes parsed). The id→note binding is recomputed in layout; this pass
-  // only surfaces unknown/ambiguous/duplicate diagnostics.
-  if (notes.length > 0) {
-    result.notes = notes;
-    resolveNotes(
-      notes,
-      result.classes.map((c) => ({ id: c.id, label: c.name })),
-      result.diagnostics
-    );
-  }
-
-  // Validation
-  if (result.classes.length === 0 && !result.error) {
-    const diag = makeDgmoError(
-      1,
-      'No classes found. Add class declarations like "ClassName" or "ClassName [interface]".'
-    );
-    result.diagnostics.push(diag);
-    result.error = formatDgmoError(diag);
-  }
-
-  // Warn about isolated classes (not in any relationship)
-  if (
-    result.classes.length >= 2 &&
-    result.relationships.length >= 1 &&
-    !result.error
-  ) {
-    const connectedIds = new Set<string>();
-    for (const rel of result.relationships) {
-      // rel.source/target are class ids set via classId() at relationship parse
-      // eslint-disable-next-line name-normalize/required-at-insertion
-      connectedIds.add(rel.source);
-      // eslint-disable-next-line name-normalize/required-at-insertion
-      connectedIds.add(rel.target);
-    }
-    for (const cls of result.classes) {
-      if (!connectedIds.has(cls.id)) {
-        result.diagnostics.push(
-          makeDgmoError(
-            cls.lineNumber,
-            `Class "${cls.name}" is not connected to any other class`,
-            'warning'
-          )
-        );
-      }
-    }
-  }
-
-  return result;
-}
-
-// ============================================================
-// Detection helper
-// ============================================================
-
-/**
- * Detect if content looks like a class diagram without explicit `chart: class`.
- * Requires class-like patterns (capitalized names with modifiers or UML relationships).
- * Must not false-positive on flowcharts.
- */
-export function looksLikeClassDiagram(content: string): boolean {
-  const lines = content.split('\n');
-
-  let hasModifier = false;
-  let hasRelationship = false;
-  let hasIndentedMember = false;
-  let hasClassDecl = false;
-
-  for (const line of lines) {
-    const trimmed = line.trim();
-    if (!trimmed || trimmed.startsWith('//')) continue;
-
-    // Skip metadata
-    if (/^(chart|title)\s*:/i.test(trimmed)) continue;
-    // Skip new-style first line (bare chart type)
-    if (/^class(\s|$)/i.test(trimmed)) continue;
-
-    const indent = measureIndent(line);
-
-    if (indent === 0) {
-      // Check for bare modifier keyword: `abstract ClassName`, `interface ClassName`, `enum ClassName`
-      if (/^(abstract|interface|enum)\s+[A-Z][A-Za-z0-9_]*/i.test(trimmed)) {
-        hasModifier = true;
-        hasClassDecl = true;
-      }
-      // Check for old modifier pattern: ClassName [abstract|interface|enum]
-      if (
-        /^[A-Z][A-Za-z0-9_]*\s+\[(abstract|interface|enum)\]/i.test(trimmed)
-      ) {
-        hasModifier = true;
-        hasClassDecl = true;
-      }
-      // Check for inline extends/implements in class declaration
-      if (/^[A-Z][A-Za-z0-9_]*\s+(extends|implements)\s+[A-Z]/.test(trimmed)) {
-        hasRelationship = true;
-        hasClassDecl = true;
-      }
-      // Check for relationship arrows
-      if (REL_ARROW_RE.test(trimmed)) {
-        hasRelationship = true;
-      }
-      // Check for plain class declaration (capitalized name only)
-      if (CLASS_DECL_RE.test(trimmed)) {
-        hasClassDecl = true;
-      }
-    } else {
-      // Indented lines that look like members
-      if (/^[+\-#]?\s*\w+.*[:(]/.test(trimmed)) {
-        hasIndentedMember = true;
-      }
-      // Indented relationship arrows
-      if (INDENT_REL_ARROW_RE.test(trimmed)) {
-        hasRelationship = true;
-      }
-    }
-  }
-
-  // Require modifier OR (relationship + class-like declarations)
-  // Modifier alone is strong enough signal
-  if (hasModifier) return true;
-
-  // Relationship keywords/arrows + at least one class declaration + member
-  if (hasRelationship && hasClassDecl && hasIndentedMember) return true;
-
-  return false;
-}
-
-// ============================================================
-// Symbol extraction (for completion API)
-// ============================================================
-
-import type { DiagramSymbols } from '../completion-types';
-
-/**
- * Extract class names (entities) from class diagram document text.
- * Used by the dgmo completion API for ghost hints and popup completions.
- */
-export function extractSymbols(docText: string): DiagramSymbols {
-  const entities: string[] = [];
-  let inMetadata = true;
-  for (const rawLine of docText.split('\n')) {
-    const line = rawLine.trim();
-    // Skip old-style colon metadata and new-style first line / space-separated options
-    if (
-      inMetadata &&
-      (/^[a-z-]+\s*:/i.test(line) || /^class(\s|$)/i.test(line))
-    )
-      continue;
-    if (inMetadata && line.toLowerCase() === 'no-auto-color') continue;
-    if (inMetadata && /^[a-z]/.test(line) && OPTION_NOCOLON_RE.test(line)) {
-      const key = line.match(OPTION_NOCOLON_RE)![1]!.toLowerCase();
-      if (key !== 'abstract' && key !== 'interface' && key !== 'enum') continue;
-    }
-    inMetadata = false;
-    if (line.length === 0 || /^\s/.test(rawLine)) continue;
-    const m = CLASS_DECL_RE.exec(line);
-    if (m) {
-      const name = (m[2] ?? m[3] ?? '').trim();
-      if (name && !entities.includes(name)) entities.push(name);
-    }
-  }
-  return {
-    kind: 'class',
-    entities,
-  };
-}