feat: Knotenbeschreibungen — "-Zeilen und ----Beschreibungsteil (SPEC §1/§9, D40)

Parser: `"`-Zeilen (Leerraum-Regel, nur ohne Zerlegungszeichen) hängen am
vorangehenden Knoten; hinter einem `---`-Trenner eröffnen #id-Zeilen
Blöcke, deren eingerückte Zeilen der Text sind (Leerzeilen = Absätze,
weitere Trenner bedeutungslos). Freitext ohne §1-Extraktion, nur %% fällt
weiter weg. Warnungen: unknownDesc (ID ohne Knoten, Blocktext wird still
geschluckt) und descStray je verwaister Zeile — ein versehentlicher
Trenner meldet die verschluckten Knotenzeilen zeilengenau. Anzeige im
Tooltip (Text zuerst, mehrzeilig) + aria-label, ”-Marke am Knoten
(nicht im Export — eine Marke ohne Ziel wäre Rauschen). i18n in allen
9 Sprachen; SPEC-§11-Abschnitt in §1/§9 überführt; 16 neue Tests
(tests/desc.test.js).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
mhoennig
2026-08-22 19:01:02 +02:00
co-authored by Claude Fable 5
parent c4abd24ce8
commit a42710b38f
10 changed files with 320 additions and 67 deletions
+114
View File
@@ -0,0 +1,114 @@
import { describe, it, expect } from 'vitest';
import { parse } from '../src/parser.js';
import { renderTreeHtml } from '../src/render.js';
const t = key => key;
const roots = txt => parse(txt).roots;
const render = txt => renderTreeHtml(roots(txt),
{t, showDiscarded: false, cheapPath: false, cheapSet: new Set()});
/* Knotenbeschreibungen (SPEC §1/§9, D40): `"`-Zeilen (Kurzform) und
ID-Blöcke hinter `---` (Langform). */
describe('Kurzform — `"`-Zeile unter dem Knoten', () => {
it('hängt die Zeile an den vorangehenden Knoten, ohne einen Knoten zu erzeugen', () => {
const [wurzel] = roots(`[ ] Auth\n " Kapselt Login und Tokens.`);
expect(wurzel.desc).toBe('Kapselt Login und Tokens.');
expect(wurzel.children).toEqual([]);
});
it('setzt mehrere `"`-Zeilen zur selben Beschreibung fort', () => {
const [wurzel] = roots(`[ ] Auth\n " Zeile eins.\n " Zeile zwei.`);
expect(wurzel.desc).toBe('Zeile eins.\nZeile zwei.');
});
it('verlangt folgenden Leerraum — `"Zitat"` bleibt ein Label', () => {
const [wurzel] = roots(`"Zitat" als Label`);
expect([wurzel.label, wurzel.desc]).toEqual(['"Zitat" als Label', null]);
});
it('gilt nicht auf Zeilen mit Zerlegungszeichen', () => {
const [wurzel] = roots(`[ ] W\n - " Zitat" als Label`);
expect(wurzel.children[0].label).toBe('" Zitat" als Label');
});
it('warnt bei einer `"`-Zeile ohne vorangehenden Knoten', () => {
const {warnings} = parse(`" verwaist`);
expect(warnings).toEqual([{type: 'descStray', line: 1}]);
});
it('extrahiert im Freitext nichts — (M), @name und #id bleiben Text', () => {
const [wurzel] = roots(`[ ] W\n " Kostet (M), fragt @ana wegen #auth.`);
expect(wurzel.desc).toBe('Kostet (M), fragt @ana wegen #auth.');
expect([wurzel.size, wurzel.tags, wurzel.id]).toEqual([null, [], null]);
});
it('entfernt %%-Kommentare auch in Beschreibungszeilen', () => {
const [wurzel] = roots(`[ ] W\n " Sichtbar. %% unsichtbar`);
expect(wurzel.desc).toBe('Sichtbar.');
});
});
describe('Langform — ID-Blöcke hinter `---`', () => {
const TXT = `[ ] Auth #auth
[ ] API #api
---
#auth
Erster Absatz.
Zweiter Absatz.
#api
Kurz.`;
it('ordnet Blöcke über die ID zu, mit Leerzeilen als Absatztrennern', () => {
const [auth, api] = roots(TXT);
expect(auth.desc).toBe('Erster Absatz.\n\nZweiter Absatz.');
expect(api.desc).toBe('Kurz.');
});
it('erzeugt hinter dem Trenner keine Knoten mehr', () => {
expect(roots(TXT).map(n => n.label)).toEqual(['Auth', 'API']);
});
it('akzeptiert auch längere Trenner und ignoriert weitere im Beschreibungsteil', () => {
const [w] = roots(`[ ] W #w\n-----\n#w\n Text.\n---\n#w\n Mehr.`);
expect(w.desc).toBe('Text.\nMehr.');
});
it('hängt Kurz- und Langform in Dokumentreihenfolge aneinander', () => {
const [w] = roots(`[ ] W #w\n " Kurz.\n---\n#w\n Lang.`);
expect(w.desc).toBe('Kurz.\nLang.');
});
it('warnt bei einer ID ohne Knoten — und schluckt deren Blocktext still', () => {
const {roots: r, warnings} = parse(`[ ] W\n---\n#fehlt\n Text dazu.\n Noch mehr.`);
expect(warnings).toEqual([{type: 'unknownDesc', line: 3, id: 'fehlt'}]);
expect(r[0].desc).toBe(null);
});
it('meldet verwaiste Zeilen einzeln — der versehentliche Trenner wird laut', () => {
const {warnings} = parse(`[ ] W\n---\n- [ ] Verschluckt\n - [ ] Kind`);
expect(warnings).toEqual([
{type: 'descStray', line: 3},
{type: 'descStray', line: 4}
]);
});
it('lässt `- --` als gewöhnlichen Knoten stehen', () => {
expect(roots(`- --`)[0].label).toBe('--');
});
});
describe('Darstellung — Tooltip, ”-Marke, aria', () => {
it('stellt die Beschreibung an den Anfang des Tooltips und setzt die Marke', () => {
const {html} = render(`[ ] Auth #auth\n " Kapselt Login.`);
expect(html).toContain('title="Kapselt Login. · #auth · st_geplant · jumpHint"');
expect(html).toContain('<span class="desc-mark" aria-hidden="true">”</span>');
expect(html).toContain('aria-label="Auth, a11yStatus, a11yId, Kapselt Login."');
});
it('ändert Knoten ohne Beschreibung nicht', () => {
const {html} = render(`[ ] Ohne`);
expect(html).not.toContain('desc-mark');
});
});