mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-28 06:23:01 +00:00
The code-fence-wrap detector in lintContent used the /m multiline flag, so ^/$ matched start/end of any line. The rule fired on any page that simply contained a ```markdown code block, not only pages wrapped end-to-end. The matching fixer in fixContent has no /m flag, so it can only strip whole-file wrappers. Result: detected issues were marked fixable: true, yet fixContent could never strip them. `gbrain dream` reported "0 fix(es) applied, N remaining" perpetually for the rule. Drops the /m flag from the detector so detector and fixer stay in sync. Whole-file wrapper detection is preserved; inner code blocks no longer trigger the rule. Real-world impact: a brain with 5 docs pages containing markdown examples (skill READMEs, decision registry, journal templates) reports 5 phantom "fixable: true" issues every dream cycle, never converging. After this fix, the dream-cycle lint phase reports only real-and-unfixable issues (missing frontmatter, missing title/type) which is the intended behavior. Two regression tests added in test/lint.test.ts: - Page contains a single inner ```markdown block - Page contains multiple inner ```markdown blocks Both assert no code-fence-wrap issue is reported. The existing "detects wrapping code fences" test (true-positive case) continues to pass; total tests in the file are 18 -> 20. Co-authored-by: Thomas Chung <thomaschung@macbookair.lan> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Time Attakc <89218912+time-attack@users.noreply.github.com>
142 lines
6.3 KiB
TypeScript
142 lines
6.3 KiB
TypeScript
import { describe, test, expect } from 'bun:test';
|
|
import { lintContent, fixContent } from '../src/commands/lint.ts';
|
|
|
|
describe('lintContent', () => {
|
|
test('detects LLM preamble "Of course"', () => {
|
|
const content = 'Of course. Here is a detailed brain page for Jane Doe.\n\n# Jane Doe\n\nContent.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'llm-preamble')).toBe(true);
|
|
});
|
|
|
|
test('detects LLM preamble "I\'ve created"', () => {
|
|
const content = "I've created a comprehensive brain page for the company.\n\n# Acme\n\nContent.";
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'llm-preamble')).toBe(true);
|
|
});
|
|
|
|
test('detects LLM preamble "Certainly"', () => {
|
|
const content = 'Certainly. Here is the brain page.\n\n# Page\n\nContent.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'llm-preamble')).toBe(true);
|
|
});
|
|
|
|
test('no false positive on normal content', () => {
|
|
const content = '---\ntitle: Test\ntype: person\ncreated: 2026-04-11\n---\n\n# Test\n\nNormal content.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.filter(i => i.rule === 'llm-preamble')).toHaveLength(0);
|
|
});
|
|
|
|
test('detects wrapping code fences', () => {
|
|
const content = '```markdown\n---\ntitle: Test\n---\n\n# Test\n\nContent.\n```';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'code-fence-wrap')).toBe(true);
|
|
});
|
|
|
|
test('no false positive: page CONTAINS an inner ```markdown code block', () => {
|
|
// Real-world case: a docs/SKILL page that shows a markdown example inline.
|
|
// Before this fix, the detector used the /m flag so ^/$ matched start/end
|
|
// of any line, which fired on any file that simply contained a ```markdown
|
|
// line. But fixContent's regex has no /m flag and can only strip whole-file
|
|
// wrappers, so the issue was reported as "fixable: true" yet never fixed.
|
|
const content =
|
|
'---\ntitle: Skill\n---\n\n# Skill\n\nExample input shape:\n\n' +
|
|
'```markdown\n# Inner page\nContent.\n```\n\nThat ends the example.\n';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.filter(i => i.rule === 'code-fence-wrap')).toHaveLength(0);
|
|
});
|
|
|
|
test('no false positive: multiple inner ```markdown blocks', () => {
|
|
// Documentation pages frequently include several markdown examples.
|
|
const content =
|
|
'---\ntitle: Examples\n---\n\n# Examples\n\nFirst:\n\n' +
|
|
'```markdown\nfoo\n```\n\nSecond:\n\n' +
|
|
'```markdown\nbar\n```\n\nDone.\n';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.filter(i => i.rule === 'code-fence-wrap')).toHaveLength(0);
|
|
});
|
|
|
|
test('detects placeholder dates', () => {
|
|
const content = '---\ntitle: Test\ntype: person\ncreated: YYYY-MM-DD\n---\n\n# Test';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'placeholder-date')).toBe(true);
|
|
});
|
|
|
|
test('detects XX-XX placeholder dates', () => {
|
|
const content = '---\ntitle: Test\ntype: person\ncreated: 2026-04-11\n---\n\n# Test\n\n- 2026-XX-XX | Something happened';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'placeholder-date')).toBe(true);
|
|
});
|
|
|
|
test('detects missing frontmatter title', () => {
|
|
const content = '---\ntype: person\ncreated: 2026-04-11\n---\n\n# Test';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'missing-title')).toBe(true);
|
|
});
|
|
|
|
test('detects missing frontmatter type', () => {
|
|
const content = '---\ntitle: Test\ncreated: 2026-04-11\n---\n\n# Test';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'missing-type')).toBe(true);
|
|
});
|
|
|
|
test('detects no frontmatter at all', () => {
|
|
const content = '# Test\n\nContent without frontmatter.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'no-frontmatter')).toBe(true);
|
|
});
|
|
|
|
test('detects empty sections', () => {
|
|
const content = '---\ntitle: Test\ntype: person\ncreated: 2026-04-11\n---\n\n# Test\n\n## What They Believe\n\n[No data yet]\n\n## State\n\nReal content here.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'empty-section' && i.message.includes('What They Believe'))).toBe(true);
|
|
});
|
|
|
|
test('detects agent placeholder sections', () => {
|
|
const content = '---\ntitle: Test\ntype: person\ncreated: 2026-04-11\n---\n\n# Test\n\n## Summary\n\n*[To be filled by agent]*\n\n## State\n\nContent.';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues.some(i => i.rule === 'empty-section' && i.message.includes('Summary'))).toBe(true);
|
|
});
|
|
|
|
test('clean page has no issues', () => {
|
|
const content = '---\ntitle: Jane Doe\ntype: person\ncreated: 2026-04-11\n---\n\n# Jane Doe\n\n## State\n\nCTO of Acme Corp.\n\n## Timeline\n\n- **2026-04-11** | Met at event [Source: User]';
|
|
const issues = lintContent(content, 'test.md');
|
|
expect(issues).toHaveLength(0);
|
|
});
|
|
});
|
|
|
|
describe('fixContent', () => {
|
|
test('removes LLM preamble', () => {
|
|
const input = 'Of course. Here is a detailed brain page for Jane.\n\n# Jane Doe\n\nContent.';
|
|
const fixed = fixContent(input);
|
|
expect(fixed).not.toContain('Of course');
|
|
expect(fixed).toContain('# Jane Doe');
|
|
expect(fixed).toContain('Content.');
|
|
});
|
|
|
|
test('removes wrapping code fences', () => {
|
|
const input = '```markdown\n# Title\n\nContent.\n```';
|
|
const fixed = fixContent(input);
|
|
expect(fixed).not.toContain('```');
|
|
expect(fixed).toContain('# Title');
|
|
});
|
|
|
|
test('cleans up excessive blank lines after fix', () => {
|
|
const input = 'Of course. Here is the brain page.\n\n\n\n# Title\n\nContent.';
|
|
const fixed = fixContent(input);
|
|
expect(fixed).not.toMatch(/\n{3,}/);
|
|
});
|
|
|
|
test('preserves content that needs no fixing', () => {
|
|
const input = '# Normal Title\n\nNormal content.\n';
|
|
expect(fixContent(input)).toBe(input);
|
|
});
|
|
|
|
test('handles multiple preambles', () => {
|
|
const input = 'Sure! Here is the page.\nCertainly. Here is the brain page.\n\n# Title\n\nContent.';
|
|
const fixed = fixContent(input);
|
|
expect(fixed).not.toContain('Sure');
|
|
expect(fixed).not.toContain('Certainly');
|
|
expect(fixed).toContain('# Title');
|
|
});
|
|
});
|