@orderful/droid 0.48.0 → 0.50.0

package/src/tools/codex/skills/codex/scripts/normalize-frontmatter.test.ts

@@ -0,0 +1,331 @@
+import { describe, it, expect } from 'bun:test';
+import {
+  extractFrontmatter,
+  needsQuoting,
+  quoteValue,
+  unquoteDate,
+  normalizeFrontmatter,
+  normalizeFile,
+} from './normalize-frontmatter';
+
+describe('extractFrontmatter', () => {
+  it('extracts frontmatter from valid markdown', () => {
+    const content = '---\ntitle: Test\nstatus: active\n---\n\n# Body';
+    const { frontmatter, body } = extractFrontmatter(content);
+    expect(frontmatter).toEqual(['title: Test', 'status: active']);
+    expect(body).toBe('\n\n# Body');
+  });
+
+  it('returns null for files without frontmatter', () => {
+    const content = '# Just a heading\n\nSome text.';
+    const { frontmatter, body } = extractFrontmatter(content);
+    expect(frontmatter).toBeNull();
+    expect(body).toBe(content);
+  });
+
+  it('returns null for unclosed frontmatter', () => {
+    const content = '---\ntitle: Test\nstatus: active\n';
+    const { frontmatter } = extractFrontmatter(content);
+    expect(frontmatter).toBeNull();
+  });
+});
+
+describe('needsQuoting', () => {
+  it('does not quote simple strings', () => {
+    expect(needsQuoting('active')).toBe(false);
+    expect(needsQuoting('hello world')).toBe(false);
+  });
+
+  it('does not quote booleans or null', () => {
+    expect(needsQuoting('true')).toBe(false);
+    expect(needsQuoting('false')).toBe(false);
+    expect(needsQuoting('null')).toBe(false);
+  });
+
+  it('does not quote dates', () => {
+    expect(needsQuoting('2026-03-04')).toBe(false);
+  });
+
+  it('quotes strings with em dashes', () => {
+    expect(needsQuoting('AI-powered — fast delivery')).toBe(true);
+  });
+
+  it('quotes strings with en dashes', () => {
+    expect(needsQuoting('pages 1\u20135')).toBe(true);
+  });
+
+  it('quotes strings with accented characters', () => {
+    expect(needsQuoting('résumé of changes')).toBe(true);
+  });
+
+  it('quotes strings with @ symbol', () => {
+    expect(needsQuoting('@tylerfry')).toBe(true);
+  });
+
+  it('quotes strings with colon-space', () => {
+    expect(needsQuoting('Note: this is important')).toBe(true);
+  });
+
+  it('quotes strings with inline # comment', () => {
+    expect(needsQuoting('value #comment')).toBe(true);
+  });
+
+  it('quotes strings starting with special YAML chars', () => {
+    expect(needsQuoting('*bold*')).toBe(true);
+    expect(needsQuoting('!important')).toBe(true);
+  });
+});
+
+describe('quoteValue', () => {
+  it('wraps value in double quotes', () => {
+    expect(quoteValue('hello')).toBe('"hello"');
+  });
+
+  it('escapes internal double quotes', () => {
+    expect(quoteValue('say "hello"')).toBe('"say \\"hello\\""');
+  });
+
+  it('does not double-quote already quoted values', () => {
+    expect(quoteValue('"already quoted"')).toBe('"already quoted"');
+    expect(quoteValue("'single quoted'")).toBe("'single quoted'");
+  });
+});
+
+describe('unquoteDate', () => {
+  it('unquotes a quoted date', () => {
+    expect(unquoteDate('"2026-03-04"')).toBe('2026-03-04');
+    expect(unquoteDate("'2026-03-04'")).toBe('2026-03-04');
+  });
+
+  it('leaves non-date quoted values alone', () => {
+    expect(unquoteDate('"not a date"')).toBe('"not a date"');
+  });
+
+  it('leaves bare dates alone', () => {
+    expect(unquoteDate('2026-03-04')).toBe('2026-03-04');
+  });
+});
+
+describe('normalizeFrontmatter', () => {
+  it('flattens folded scalar (>) into single line', () => {
+    const lines = [
+      'title: >',
+      '  This is a long',
+      '  description that spans',
+      '  multiple lines',
+      'status: active',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'title: This is a long description that spans multiple lines',
+      'status: active',
+    ]);
+  });
+
+  it('flattens literal scalar (|) into single line', () => {
+    const lines = [
+      'description: |',
+      '  Line one',
+      '  Line two',
+      'status: active',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'description: Line one Line two',
+      'status: active',
+    ]);
+  });
+
+  it('flattens >- (strip) into single line', () => {
+    const lines = [
+      'title: >-',
+      '  Stripped trailing',
+      '  newline content',
+      'status: active',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'title: Stripped trailing newline content',
+      'status: active',
+    ]);
+  });
+
+  it('quotes values with em dashes after flattening', () => {
+    const lines = [
+      'description: >',
+      '  AI-powered platform —',
+      '  fast and reliable',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'description: "AI-powered platform \u2014 fast and reliable"',
+    ]);
+  });
+
+  it('quotes inline values with special characters', () => {
+    const lines = [
+      'title: Overview — EDI Platform',
+      'author: @tylerfry',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'title: "Overview \u2014 EDI Platform"',
+      'author: "@tylerfry"',
+    ]);
+  });
+
+  it('unquotes dates that are wrapped in quotes', () => {
+    const lines = [
+      'created: "2026-03-04"',
+      "updated: '2026-01-15'",
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'created: 2026-03-04',
+      'updated: 2026-01-15',
+    ]);
+  });
+
+  it('preserves already-correct frontmatter', () => {
+    const lines = [
+      'title: Simple Title',
+      'type: domain',
+      'status: active',
+      'created: 2026-03-04',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual(lines);
+  });
+
+  it('preserves list items', () => {
+    const lines = [
+      'related_domains:',
+      '- overview',
+      '- transaction',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'related_domains:',
+      '- overview',
+      '- transaction',
+    ]);
+  });
+
+  it('preserves comments', () => {
+    const lines = [
+      '# This is a comment',
+      'title: Test',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual(lines);
+  });
+
+  it('preserves blank lines', () => {
+    const lines = [
+      'title: Test',
+      '',
+      'status: active',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual(lines);
+  });
+
+  it('handles key with empty value (list follows)', () => {
+    const lines = [
+      'codebase_paths:',
+      '- ~/src/app',
+      '- ~/src/lib',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual(lines);
+  });
+
+  it('quotes list items with special characters', () => {
+    const lines = [
+      'participants:',
+      '- @tylerfry',
+      '- @thea',
+    ];
+    const result = normalizeFrontmatter(lines);
+    expect(result).toEqual([
+      'participants:',
+      '- "@tylerfry"',
+      '- "@thea"',
+    ]);
+  });
+});
+
+describe('normalizeFile', () => {
+  it('returns null when no changes needed', () => {
+    const content = '---\ntitle: Test\nstatus: active\ncreated: 2026-03-04\n---\n\n# Body';
+    expect(normalizeFile(content)).toBeNull();
+  });
+
+  it('returns null when no frontmatter exists', () => {
+    const content = '# Just a heading';
+    expect(normalizeFile(content)).toBeNull();
+  });
+
+  it('normalizes and reassembles the file', () => {
+    const content = '---\ntitle: "2026-03-04"\ndescription: >\n  A long\n  description\n---\n\n# Body';
+    const result = normalizeFile(content);
+    expect(result).toBe('---\ntitle: 2026-03-04\ndescription: A long description\n---\n\n# Body');
+  });
+
+  it('is idempotent — second run returns null', () => {
+    const content = '---\ntitle: >\n  Hello — world\nstatus: active\n---\n\n# Body';
+    const first = normalizeFile(content);
+    expect(first).not.toBeNull();
+
+    const second = normalizeFile(first!);
+    expect(second).toBeNull();
+  });
+
+  it('handles real-world codex frontmatter', () => {
+    const content = [
+      '---',
+      'title: Droid - AI Workflow Toolkit',
+      'type: context',
+      'status: active',
+      'created: 2025-12-09',
+      'updated: 2026-01-29',
+      'source: implementation',
+      'participants:',
+      '  tech_lead: tylerfry',
+      'codebase_paths:',
+      '- ~/src/github.com/droid',
+      'slack:',
+      '  channel: \'#droid\'',
+      '  canvas_id: F0AD41VF71V',
+      '---',
+      '',
+      '# Droid',
+    ].join('\n');
+
+    // Already well-formed — should return null
+    expect(normalizeFile(content)).toBeNull();
+  });
+
+  it('normalizes multiline scalar in real-world pattern', () => {
+    const content = [
+      '---',
+      'title: >',
+      '  Automated Partner Testing —',
+      '  End-to-end EDI validation',
+      'type: project',
+      'status: active',
+      'created: 2026-02-01',
+      '---',
+      '',
+      '# Content',
+    ].join('\n');
+
+    const result = normalizeFile(content);
+    expect(result).toContain('title: "Automated Partner Testing \u2014 End-to-end EDI validation"');
+    expect(result).toContain('type: project');
+    expect(result).toContain('created: 2026-02-01');
+
+    // Idempotent
+    expect(normalizeFile(result!)).toBeNull();
+  });
+});