From 1791542b3cc4b885816cad5bfd767717e6b0ffc8 Mon Sep 17 00:00:00 2001 From: Lilleman auf Larv Date: Sat, 3 Oct 2026 16:19:09 +0200 Subject: [PATCH] Rename isPlainText to isBareText, apart from the plain flavour, and say truly what it admits --- src/adf/document.ts | 4 ++-- src/markdown/adjacent-text.ts | 4 ++-- src/markdown/emit/adf-to-markdown.ts | 4 ++-- src/markdown/emit/inline-line.ts | 6 +++--- src/markdown/parse/directive-nodes.ts | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/adf/document.ts b/src/adf/document.ts index 42da38e..b84f6ff 100644 --- a/src/adf/document.ts +++ b/src/adf/document.ts @@ -64,8 +64,8 @@ export function emptyKeys(held: { attrs?: AdfAttributes; content?: AdfNode[]; ma return keys } -// A text node holding its text and marks alone: a format spells it as text, where anything more rides a carry. -export function isPlainText(node: AdfNode): boolean { +// A text node holding no attrs or content key and no empty marks: a format spells it as text, where anything more rides a carry. +export function isBareText(node: AdfNode): boolean { return node.type === 'text' && node.attrs === undefined && node.content === undefined && node.marks?.length !== 0 } diff --git a/src/markdown/adjacent-text.ts b/src/markdown/adjacent-text.ts index 9b1547e..bea9d7b 100644 --- a/src/markdown/adjacent-text.ts +++ b/src/markdown/adjacent-text.ts @@ -1,6 +1,6 @@ import type { AdfAttributes, AdfMark, AdfNode } from '../adf/document.ts' import type { JsonValue } from '../json-value.ts' -import { identicalMark, identicalMarks, isPlainText, nodeAttrs, nodeMarks } from '../adf/document.ts' +import { identicalMark, identicalMarks, isBareText, nodeAttrs, nodeMarks } from '../adf/document.ts' import { spellInlineLeafDirective } from './directive-syntax.ts' type JsonContainer = JsonValue[] | { [key: string]: JsonValue } @@ -11,7 +11,7 @@ export const textBreakSpelling = spellInlineLeafDirective(textBreakName, '') // The lossless reader's rule: CommonMark reads the pair back as one text run (spec/flavour.md, Inline nodes). export function joinsWhenRead(previous: AdfNode, node: AdfNode): boolean { - return isPlainText(previous) && isPlainText(node) && identicalMarks(nodeMarks(previous), nodeMarks(node)) + return isBareText(previous) && isBareText(node) && identicalMarks(nodeMarks(previous), nodeMarks(node)) } // The editor's rule, differing from the reader's only on shapes editor-normal ADF erases: an empty attrs, content or marks, and -0 in a mark. diff --git a/src/markdown/emit/adf-to-markdown.ts b/src/markdown/emit/adf-to-markdown.ts index e134aba..936a646 100644 --- a/src/markdown/emit/adf-to-markdown.ts +++ b/src/markdown/emit/adf-to-markdown.ts @@ -1,7 +1,7 @@ import type { AdfDocument, AdfNode } from '../../adf/document.ts' import type { BlockNodeModel } from '../../adf/block-nodes.ts' import type { Flavour } from '../plain/conventions.ts' -import { adfDocumentFault, holdsOnlyAttributes, isPlainText, nodeAttrs, nodeContent } from '../../adf/document.ts' +import { adfDocumentFault, holdsOnlyAttributes, isBareText, nodeAttrs, nodeContent } from '../../adf/document.ts' import { alertMarker, foldedAlertMarker, leadingMarker, readAlertMarker, readTaskMarker, taskMarker } from '../plain/conventions.ts' import { blockDirectiveForm, documentSpelling, listBreakSpelling } from '../block-directive.ts' import { blockNodeModel, blockNodes } from '../../adf/block-nodes.ts' @@ -278,7 +278,7 @@ function emitCodeDirective(node: AdfNode, model: BlockNodeModel, path: ConvertEr // The text each fence holds, or `undefined` where a child is no plain text node, which the carry holds instead. function fencedTexts(node: AdfNode, path: ConvertErrorPath): Result { if (node.content === undefined) return success(['']) - if (node.content.some((child) => !isPlainText(child) || child.marks !== undefined)) return success(undefined) + if (node.content.some((child) => !isBareText(child) || child.marks !== undefined)) return success(undefined) const texts: string[] = [] for (const [index, child] of node.content.entries()) { const childPath = [...path, 'content', index] diff --git a/src/markdown/emit/inline-line.ts b/src/markdown/emit/inline-line.ts index bcd3be4..77c4afe 100644 --- a/src/markdown/emit/inline-line.ts +++ b/src/markdown/emit/inline-line.ts @@ -6,7 +6,7 @@ import { assembleInlineLine, isSyntax, type InlineEscaping, type InlineSegment, import { carriedInline } from '../opaque-carry.ts' import { claimsLine, holdsNullCharacter, trimTrailingSpace } from '../commonmark/grammar.ts' import { commonMarkLink, linkHref, markSpelling, spellMarkAttributes } from '../mark-spellings.ts' -import { identicalMark, isPlainText, nodeAttrs, nodeContent, nodeMarks } from '../../adf/document.ts' +import { identicalMark, isBareText, nodeAttrs, nodeContent, nodeMarks } from '../../adf/document.ts' import { escapeUnbalanced, spellDestination } from '../commonmark/link-syntax.ts' import { failure, faulted, success, type ConvertErrorPath, type Result } from '../../result.ts' import { highlightDelimiter } from '../plain/conventions.ts' @@ -269,7 +269,7 @@ function emitInlineDirective(node: AdfNode, model: InlineNodeModel, index: numbe function emitText(node: AdfNode, context: InlineContext, index: number, path: ConvertErrorPath): Result { if (nodeContent(node).length > 0) return failure('unsupported-node-shape', 'a text node holds no content: this one holds some', path) - if (!isPlainText(node)) return success({ carry: { first: index, last: index } }) + if (!isBareText(node)) return success({ carry: { first: index, last: index } }) if (typeof node.text !== 'string' || node.text === '') return failure('unsupported-node-shape', 'a text node holds text: this one has none', path) if (/\r/.test(node.text)) return failure('unspellable-character', 'a text node holds a carriage return CommonMark rewrites', path) if (holdsNullCharacter(node.text)) return failure('unspellable-character', 'a text node holds a null character CommonMark replaces', path) @@ -324,7 +324,7 @@ function emitCodeSpan(nodes: readonly AdfNode[], depth: number, range: NodeRange const spans: string[] = [] for (const node of nodes) { if (node.type === 'text' && nodeContent(node).length > 0) return failure('unsupported-node-shape', 'a text node holds no content: this one holds some', path) - if (!isPlainText(node) || nodeMarks(node).length !== depth + 1) return success({ carry: range }) + if (!isBareText(node) || nodeMarks(node).length !== depth + 1) return success({ carry: range }) const { text } = node if (typeof text !== 'string' || text === '') return failure('unsupported-node-shape', 'a text node holds text: this one has none', path) if (/[\n\r]/.test(text)) return success({ carry: range }) diff --git a/src/markdown/parse/directive-nodes.ts b/src/markdown/parse/directive-nodes.ts index 61c1471..3af6098 100644 --- a/src/markdown/parse/directive-nodes.ts +++ b/src/markdown/parse/directive-nodes.ts @@ -3,7 +3,7 @@ import type { BlockNodeModel } from '../../adf/block-nodes.ts' import type { ConvertFault } from '../../result.ts' import type { DirectiveAttributes, DirectiveValue } from '../directive-syntax.ts' import type { Elsewhere } from './directive-attributes.ts' -import { attributeNestingMessage, isPlainText } from '../../adf/document.ts' +import { attributeNestingMessage, isBareText } from '../../adf/document.ts' import { attributeValue, directivePrefix, spellAttributeValue, unknownDirectiveFault } from '../directive-syntax.ts' import { blockArgument, blockDirectiveForm, marksAttribute, readMarkValues } from '../block-directive.ts' import { blockNodeModel } from '../../adf/block-nodes.ts' @@ -92,7 +92,7 @@ function blockSpellingFault(name: string): ConvertFault | undefined { function slotText(content: readonly AdfNode[]): string | undefined { if (content.length === 0) return '' const only = content.length === 1 ? content[0] : undefined - if (only === undefined || !isPlainText(only) || only.marks !== undefined || typeof only.text !== 'string') return undefined + if (only === undefined || !isBareText(only) || only.marks !== undefined || typeof only.text !== 'string') return undefined return only.text }