Files
edentext/tests/unit/list-style.test.ts
T
Steffen Becker e2525237de feat: named list styles — model, editor resolution, ODF round-trip
Fourth style family (LibreOffice's Listenformatvorlagen): per-level model in
styles/listStyles.ts, five probed LO built-ins, listStyleName on the outermost
list, one effective-level resolver shared by the decoration walk and the export.
ODF writes the full named text:list-style into styles.xml and repoints
unoverridden lists at it (overrides keep the resolved automatic clone);
import maps named list styles back to the attr + registry, attr-free.
Probed: LO keeps the named reference and display-name across a re-save.
2026-08-25 20:38:15 +00:00

86 lines
4.1 KiB
TypeScript

import { describe, it, expect } from 'vitest';
import {
builtinListStyles, effectiveListLevel, listStyleMarginCm, listStyleOverridden,
MAX_LIST_LEVELS, type ListStyle,
} from '../../src/lib/styles/listStyles';
const style: ListStyle = {
name: 'Test',
levels: [
{ kind: 'number', numType: 'upper-roman-paren', markerAlign: 'right', indentCm: 0.5 },
{ kind: 'bullet', bulletChar: '✓' },
{ kind: 'number', numType: 'lower-alpha', startAt: 3 },
],
};
describe('effectiveListLevel (attr ?? style level ?? cycle default)', () => {
it('takes the style level where the node has no attr', () => {
const eff = effectiveListLevel({}, true, style, 1);
expect(eff.listStyleType).toBe('upper-roman-paren');
expect(eff.markerAlign).toBe('right');
expect(eff.indent).toBe(0.5);
});
it('lets a node attr override its level', () => {
const eff = effectiveListLevel({ listStyleType: 'decimal', indent: 1 }, true, style, 1);
expect(eff.listStyleType).toBe('decimal');
expect(eff.indent).toBe(1);
expect(eff.markerAlign).toBe('right'); // untouched channel still comes from the style
});
it('serves the bullet level to a bullet node only', () => {
expect(effectiveListLevel({}, false, style, 2).bulletChar).toBe('✓');
// An ordered node over the bullet level keeps the cycle default (null).
expect(effectiveListLevel({}, true, style, 2).listStyleType).toBeNull();
expect(effectiveListLevel({}, false, style, 1).bulletChar).toBeNull();
});
it('falls back to the cycle default past the defined levels and without a style', () => {
expect(effectiveListLevel({}, true, style, 5).listStyleType).toBeNull();
expect(effectiveListLevel({}, true, null, 1).listStyleType).toBeNull();
});
it('a multilevel style renders the chain on every ordered level', () => {
const ml: ListStyle = { name: 'ML', multilevel: true, levels: [{ kind: 'number', numType: 'decimal' }] };
expect(effectiveListLevel({}, true, ml, 1).listStyleType).toBe('multilevel');
expect(effectiveListLevel({}, true, ml, 3).listStyleType).toBe('multilevel');
});
it('carries the level start value for the matching kind', () => {
expect(effectiveListLevel({}, true, style, 3).startAt).toBe(3);
expect(effectiveListLevel({}, false, style, 2).startAt).toBeNull();
});
});
describe('listStyleOverridden', () => {
const li = (...c: unknown[]) => ({ type: 'listItem', content: [{ type: 'paragraph' }, ...c] });
it('a clean subtree is not overridden; `start` is content, not formatting', () => {
expect(listStyleOverridden({ type: 'orderedList', attrs: { listStyleName: 'Test', start: 4 }, content: [li()] })).toBe(false);
});
it('any marker/indent attr anywhere in the subtree overrides', () => {
expect(listStyleOverridden({ type: 'orderedList', attrs: { listStyleType: 'decimal' }, content: [li()] })).toBe(true);
expect(listStyleOverridden({
type: 'orderedList', content: [li({ type: 'bulletList', attrs: { bulletChar: '❖' }, content: [li()] })],
})).toBe(true);
expect(listStyleOverridden({ type: 'bulletList', attrs: { indent: 1.5 }, content: [li()] })).toBe(true);
});
});
describe('the built-ins (probed LibreOffice definitions)', () => {
const builtins = builtinListStyles();
it('ship LibreOffice\'s five, ten levels each', () => {
expect(Object.keys(builtins).sort()).toEqual(['List 1', 'List 2', 'Numbering 123', 'Numbering ABC', 'Numbering IVX']);
for (const s of Object.values(builtins)) expect(s.levels).toHaveLength(MAX_LIST_LEVELS);
});
it('carry LibreOffice\'s level geometry', () => {
// List 1: 0.4cm per level; Numbering 123: 1.33cm then 0.7cm steps.
expect(listStyleMarginCm(builtins['List 1'], 1)).toBeCloseTo(0.4, 3);
expect(listStyleMarginCm(builtins['List 1'], 2)).toBeCloseTo(0.8, 3);
expect(listStyleMarginCm(builtins['Numbering 123'], 1)).toBeCloseTo(1.33, 3);
expect(listStyleMarginCm(builtins['Numbering 123'], 2)).toBeCloseTo(2.03, 3);
});
it('Numbering IVX sets its wide labels against the right edge', () => {
expect(builtins['Numbering IVX'].levels[0]).toMatchObject({ kind: 'number', numType: 'upper-roman', markerAlign: 'right' });
});
});