@savvy-web/silk-effects 9.6.0 → 10.0.0

package/changesets/remark/plugins/normalize-format.js

@@ -1,46 +0,0 @@
-import { getVersionBlocks } from "../../utils/version-blocks.js";
-import { toString } from "mdast-util-to-string";
-
-// src/changesets/remark/plugins/normalize-format.ts
-/**
-* Check if a node is a heading at one of the given depths.
-*
-* @param node - The AST node to check
-* @param depths - Allowed heading depths
-* @returns `true` if the node is a heading at one of the specified depths
-*
-* @internal
-*/
-function isHeadingAtDepth(node, depths) {
-	return node.type === "heading" && depths.includes(node.depth);
-}
-const NormalizeFormatPlugin = () => {
-	return (tree) => {
-		const blocks = getVersionBlocks(tree);
-		const indicesToRemove = /* @__PURE__ */ new Set();
-		for (const block of blocks) for (let i = block.startIndex; i < block.endIndex; i++) {
-			const node = tree.children[i];
-			if (node.type === "list" && node.children.length === 0) {
-				indicesToRemove.add(i);
-				continue;
-			}
-			if (!isHeadingAtDepth(node, [3])) continue;
-			let hasContent = false;
-			for (let j = i + 1; j < block.endIndex; j++) {
-				const next = tree.children[j];
-				if (next.type === "paragraph" && toString(next).trim() === "") {
-					indicesToRemove.add(j);
-					continue;
-				}
-				if (isHeadingAtDepth(next, [2, 3])) break;
-				hasContent = true;
-				break;
-			}
-			if (!hasContent) indicesToRemove.add(i);
-		}
-		const sorted = [...indicesToRemove].sort((a, b) => b - a);
-		for (const idx of sorted) tree.children.splice(idx, 1);
-	};
-};
-
-export { NormalizeFormatPlugin };

package/changesets/remark/plugins/reorder-sections.js

@@ -1,48 +0,0 @@
-import { fromHeading } from "../../categories/index.js";
-import { getBlockSections, getHeadingText, getVersionBlocks } from "../../utils/version-blocks.js";
-
-// src/changesets/remark/plugins/reorder-sections.ts
-/**
-* Default priority for unrecognized headings (sorts after all known categories).
-*
-* @internal
-*/
-const UNKNOWN_PRIORITY = 999;
-/**
-* Priority for the `Thanks` section emitted by {@link ContributorFootnotesPlugin}.
-* Sorts after everything — including unknown headings — so the contributor
-* credits always close the version block.
-*
-* @internal
-*/
-const THANKS_PRIORITY = 1e3;
-/**
-* Resolve the sort priority for a section heading.
-*
-* @internal
-*/
-function headingPriority(text) {
-	if (text.trim().toLowerCase() === "thanks") return THANKS_PRIORITY;
-	return fromHeading(text)?.priority ?? UNKNOWN_PRIORITY;
-}
-const ReorderSectionsPlugin = () => {
-	return (tree) => {
-		const blocks = getVersionBlocks(tree);
-		for (let b = blocks.length - 1; b >= 0; b--) {
-			const block = blocks[b];
-			const sections = getBlockSections(tree, block);
-			if (sections.length <= 1) continue;
-			const preamble = [];
-			for (let i = block.startIndex; i < block.endIndex; i++) if (i < sections[0].headingIndex) preamble.push(tree.children[i]);
-			else break;
-			const sorted = [...sections].sort((a, b) => headingPriority(getHeadingText(a.heading)) - headingPriority(getHeadingText(b.heading)));
-			if (sorted.every((s, i) => s.headingIndex === sections[i].headingIndex)) continue;
-			const newChildren = [...preamble];
-			for (const section of sorted) newChildren.push(section.heading, ...section.contentNodes);
-			const blockLength = block.endIndex - block.startIndex;
-			tree.children.splice(block.startIndex, blockLength, ...newChildren);
-		}
-	};
-};
-
-export { ReorderSectionsPlugin };

package/changesets/remark/presets.js

@@ -1,118 +0,0 @@
-import { ContentStructureRule } from "./rules/content-structure.js";
-import { DependencyTableFormatRule } from "./rules/dependency-table-format.js";
-import { HeadingHierarchyRule } from "./rules/heading-hierarchy.js";
-import { RequiredSectionsRule } from "./rules/required-sections.js";
-import { UncategorizedContentRule } from "./rules/uncategorized-content.js";
-import { ContributorFootnotesPlugin } from "./plugins/contributor-footnotes.js";
-import { AggregateDependencyTablesPlugin } from "./plugins/aggregate-dependency-tables.js";
-import { DeduplicateItemsPlugin } from "./plugins/deduplicate-items.js";
-import { IssueLinkRefsPlugin } from "./plugins/issue-link-refs.js";
-import { MergeSectionsPlugin } from "./plugins/merge-sections.js";
-import { NormalizeFormatPlugin } from "./plugins/normalize-format.js";
-import { ReorderSectionsPlugin } from "./plugins/reorder-sections.js";
-
-// src/changesets/remark/presets.ts
-/**
-* Remark preset collections for changeset lint rules and transform plugins.
-*
-* @remarks
-* Presets bundle related remark plugins into ordered arrays for convenient
-* consumption. Each preset is a `readonly` tuple so that TypeScript can
-* narrow element types. Iterate and `.use()` each entry with `unified()`.
-*
-* @see {@link SilkChangesetPreset} for lint rules
-* @see {@link SilkChangesetTransformPreset} for transform plugins
-*/
-/**
-* Preset combining all changeset lint rules for convenient consumption.
-*
-* @remarks
-* Includes the following rules in order:
-*
-* 1. {@link HeadingHierarchyRule} (CSH001) -- no h1, no depth skips
-* 2. {@link RequiredSectionsRule} (CSH002) -- h2 headings must match a known category
-* 3. {@link ContentStructureRule} (CSH003) -- non-empty sections, code fence languages, non-empty list items
-* 4. {@link UncategorizedContentRule} (CSH004) -- no content before the first h2 heading
-* 5. {@link DependencyTableFormatRule} (CSH005) -- dependency table column/value validation
-*
-* Rule execution order is not significant for lint rules; all rules run
-* independently over the same AST and report warnings to the virtual file.
-*
-* @example
-* ```typescript
-* import { SilkChangesetPreset } from "\@savvy-web/changesets/remark";
-* import remarkParse from "remark-parse";
-* import { unified } from "unified";
-* import { read } from "to-vfile";
-*
-* const processor = unified().use(remarkParse);
-* for (const rule of SilkChangesetPreset) {
-*   processor.use(rule);
-* }
-*
-* const file = await read("changeset.md");
-* const result = await processor.process(file);
-* console.log(result.messages); // lint warnings
-* ```
-*
-* @see {@link SilkChangesetTransformPreset} for the corresponding transform preset
-*
-* @public
-*/
-const SilkChangesetPreset = [
-	HeadingHierarchyRule,
-	RequiredSectionsRule,
-	ContentStructureRule,
-	UncategorizedContentRule,
-	DependencyTableFormatRule
-];
-/**
-* Ordered array of all transform plugins in the correct execution order.
-*
-* @remarks
-* Plugin ordering is significant -- each plugin may depend on the output of
-* earlier plugins in the pipeline:
-*
-* 1. {@link AggregateDependencyTablesPlugin} -- merge duplicate dependency sections (must run first so downstream plugins see a single Dependencies section)
-* 2. {@link MergeSectionsPlugin} -- merge duplicate h3 headings (must run before reorder so that priority is computed on consolidated sections)
-* 3. {@link ReorderSectionsPlugin} -- sort sections by category priority (Breaking Changes first, Other last)
-* 4. {@link DeduplicateItemsPlugin} -- remove duplicate list items within each section
-* 5. {@link ContributorFootnotesPlugin} -- extract inline `Thanks \@user!` attributions and aggregate them into a summary paragraph per version block
-* 6. {@link IssueLinkRefsPlugin} -- convert inline `[#N](url)` links to reference-style `[#N]` with definitions at the end of each version block
-* 7. {@link NormalizeFormatPlugin} -- final cleanup removing empty sections and empty lists
-*
-* @example
-* ```typescript
-* import { SilkChangesetTransformPreset } from "\@savvy-web/changesets/remark";
-* import remarkGfm from "remark-gfm";
-* import remarkParse from "remark-parse";
-* import remarkStringify from "remark-stringify";
-* import { unified } from "unified";
-* import { read } from "to-vfile";
-*
-* const processor = unified().use(remarkParse).use(remarkGfm);
-* for (const plugin of SilkChangesetTransformPreset) {
-*   processor.use(plugin);
-* }
-* processor.use(remarkStringify);
-*
-* const file = await read("CHANGELOG.md");
-* const result = await processor.process(file);
-* console.log(String(result));
-* ```
-*
-* @see {@link SilkChangesetPreset} for the corresponding lint preset
-*
-* @public
-*/
-const SilkChangesetTransformPreset = [
-	AggregateDependencyTablesPlugin,
-	MergeSectionsPlugin,
-	ReorderSectionsPlugin,
-	DeduplicateItemsPlugin,
-	ContributorFootnotesPlugin,
-	IssueLinkRefsPlugin,
-	NormalizeFormatPlugin
-];
-
-export { SilkChangesetPreset, SilkChangesetTransformPreset };

package/changesets/remark/rules/content-structure.js

@@ -1,21 +0,0 @@
-import { RULE_DOCS } from "../../constants.js";
-import { toString } from "mdast-util-to-string";
-import { lintRule } from "unified-lint-rule";
-import { visit } from "unist-util-visit";
-
-// src/changesets/remark/rules/content-structure.ts
-const ContentStructureRule = lintRule("remark-lint:changeset-content-structure", (tree, file) => {
-	visit(tree, "heading", (node, index, parent) => {
-		if (node.depth !== 2 || parent == null || index == null) return;
-		const next = parent.children[index + 1];
-		if (!next || next.type === "heading" && next.depth === 2) file.message(`Empty section: heading has no content before the next section or end of file. Add a list of changes (e.g., "- Added feature X") under this heading, or remove the empty heading. See: ${RULE_DOCS.CSH003}`, node);
-	});
-	visit(tree, "code", (node) => {
-		if (!node.lang) file.message(`Code block is missing a language identifier. Add a language after the opening fence (e.g., \`\`\`ts, \`\`\`json, \`\`\`bash). See: ${RULE_DOCS.CSH003}`, node);
-	});
-	visit(tree, "listItem", (node) => {
-		if (!toString(node).trim()) file.message(`Empty list item. Each list item must contain descriptive text (e.g., "- Fixed login timeout issue"). See: ${RULE_DOCS.CSH003}`, node);
-	});
-});
-
-export { ContentStructureRule };

package/changesets/remark/rules/dependency-table-format.js

@@ -1,37 +0,0 @@
-import { parseDependencyTable } from "../../utils/dependency-table.js";
-import { RULE_DOCS } from "../../constants.js";
-import { scanDependencySection } from "../../utils/dependency-section.js";
-import { toString } from "mdast-util-to-string";
-import { lintRule } from "unified-lint-rule";
-import { visit } from "unist-util-visit";
-
-// src/changesets/remark/rules/dependency-table-format.ts
-/** @internal */
-const EM_DASH = "—";
-const DependencyTableFormatRule = lintRule("remark-lint:changeset-dependency-table-format", (tree, file) => {
-	visit(tree, "heading", (node, index) => {
-		if (node.depth !== 2) return;
-		if (toString(node).toLowerCase() !== "dependencies") return;
-		if (index === void 0) return;
-		const scan = scanDependencySection(tree.children, index + 1, {
-			isHeading: (n) => n.type === "heading",
-			isTable: (n) => n.type === "table"
-		});
-		if (scan.table === void 0) {
-			file.message(`Dependencies section must contain a table, not a list or paragraph. See: ${RULE_DOCS.CSH005}`, node);
-			return;
-		}
-		const table = scan.table;
-		try {
-			const rows = parseDependencyTable(table);
-			for (const row of rows) {
-				if (row.action === "added" && row.from !== EM_DASH) file.message(`'from' must be '\u2014' when action is 'added' (got '${row.from}'). See: ${RULE_DOCS.CSH005}`, table);
-				if (row.action === "removed" && row.to !== EM_DASH) file.message(`'to' must be '\u2014' when action is 'removed' (got '${row.to}'). See: ${RULE_DOCS.CSH005}`, table);
-			}
-		} catch (error) {
-			file.message(`${error instanceof Error ? error.message : String(error)}. See: ${RULE_DOCS.CSH005}`, table);
-		}
-	});
-});
-
-export { DependencyTableFormatRule };

package/changesets/remark/rules/heading-hierarchy.js

@@ -1,18 +0,0 @@
-import { RULE_DOCS } from "../../constants.js";
-import { lintRule } from "unified-lint-rule";
-import { visit } from "unist-util-visit";
-
-// src/changesets/remark/rules/heading-hierarchy.ts
-const HeadingHierarchyRule = lintRule("remark-lint:changeset-heading-hierarchy", (tree, file) => {
-	let prevDepth = 0;
-	visit(tree, "heading", (node) => {
-		if (node.depth === 1) {
-			file.message(`h1 headings are not allowed in changeset files. Use h2 (##) for top-level sections like "## Features" or "## Bug Fixes". h1 is reserved for the version title generated by the changelog formatter. See: ${RULE_DOCS.CSH001}`, node);
-			return;
-		}
-		if (prevDepth > 0 && node.depth > prevDepth + 1) file.message(`Heading level skipped: expected h${prevDepth + 1} or lower, found h${node.depth}. Headings must increase sequentially (h2 → h3 → h4). Add the missing intermediate level or reduce this heading's depth. See: ${RULE_DOCS.CSH001}`, node);
-		prevDepth = node.depth;
-	});
-});
-
-export { HeadingHierarchyRule };

package/changesets/remark/rules/required-sections.js

@@ -1,16 +0,0 @@
-import { allHeadings, isValidHeading } from "../../categories/index.js";
-import { RULE_DOCS } from "../../constants.js";
-import { toString } from "mdast-util-to-string";
-import { lintRule } from "unified-lint-rule";
-import { visit } from "unist-util-visit";
-
-// src/changesets/remark/rules/required-sections.ts
-const RequiredSectionsRule = lintRule("remark-lint:changeset-required-sections", (tree, file) => {
-	visit(tree, "heading", (node) => {
-		if (node.depth !== 2) return;
-		const text = toString(node);
-		if (!isValidHeading(text)) file.message(`Unknown section "${text}". Valid h2 headings are: ${allHeadings().join(", ")}. Heading comparison is case-insensitive. See: ${RULE_DOCS.CSH002}`, node);
-	});
-});
-
-export { RequiredSectionsRule };

package/changesets/remark/rules/uncategorized-content.js

@@ -1,30 +0,0 @@
-import { RULE_DOCS } from "../../constants.js";
-import { lintRule } from "unified-lint-rule";
-
-// src/changesets/remark/rules/uncategorized-content.ts
-/**
-* Node types to ignore when detecting uncategorized content (e.g., HTML comments).
-*
-* @internal
-*/
-const IGNORED_TYPES = /* @__PURE__ */ new Set(["html"]);
-/**
-* Determine whether a node is substantive content (not a heading or ignored type).
-*
-* @param node - The AST node to check
-* @returns `true` if the node is content that should be under a heading
-*
-* @internal
-*/
-function isContentNode(node) {
-	if (node.type === "heading") return false;
-	return !IGNORED_TYPES.has(node.type);
-}
-const UncategorizedContentRule = lintRule("remark-lint:changeset-uncategorized-content", (tree, file) => {
-	for (const node of tree.children) {
-		if (node.type === "heading" && node.depth === 2) break;
-		if (isContentNode(node)) file.message(`Content must be placed under a category heading (## heading). Move this content under an appropriate section like "## Features" or "## Bug Fixes". If it doesn't fit an existing category, use "## Other". See: ${RULE_DOCS.CSH004}`, node);
-	}
-});
-
-export { UncategorizedContentRule };

package/changesets/utils/remark-pipeline.js

@@ -1,35 +0,0 @@
-import { emitMarkdown } from "./markdown-emit.js";
-import remarkGfm from "remark-gfm";
-import remarkParse from "remark-parse";
-import { unified } from "unified";
-
-// src/changesets/utils/remark-pipeline.ts
-/**
-* Stringify an MDAST AST back to markdown text synchronously.
-*
-* @remarks
-* Delegates to the canonical `@effected/markdown` emit boundary
-* (`emitMarkdown`), so the output is the kit's canonical form — ATX
-* headings, `-` bullets, `*`/`**` emphasis, `***` thematic breaks, one
-* blank line between blocks, a single trailing newline. GFM constructs
-* (tables, strikethrough) are serialized natively.
-*
-* @param tree - The MDAST root node
-* @returns The serialized markdown string
-*
-* @example
-* ```typescript
-* import { parseMarkdown, stringifyMarkdown } from "../utils/remark-pipeline.js";
-*
-* const tree = parseMarkdown("# Hello\n\nWorld.");
-* const md = stringifyMarkdown(tree);
-* // "# Hello\n\nWorld.\n"
-* ```
-*
-* @internal
-*/
-function stringifyMarkdown(tree) {
-	return emitMarkdown(tree);
-}
-
-export { stringifyMarkdown };

package/changesets/utils/version-blocks.js

@@ -1,107 +0,0 @@
-import { toString } from "mdast-util-to-string";
-
-// src/changesets/utils/version-blocks.ts
-/**
-* Extract all version blocks from a CHANGELOG AST.
-*
-* @remarks
-* Scans `tree.children` linearly for h2-level headings. Each h2 starts
-* a new version block whose content extends to the next h2 or the end
-* of the document. The `endIndex` of each block is adjusted in a second
-* pass to stop at the next block's `headingIndex`.
-*
-* h1 headings (typically the package name) are ignored and do not
-* create version blocks.
-*
-* @param tree - The MDAST root node of a CHANGELOG document
-* @returns Array of version blocks in document order
-*
-* @example
-* ```typescript
-* import { getVersionBlocks } from "../utils/version-blocks.js";
-* import { parseMarkdown } from "../utils/remark-pipeline.js";
-*
-* const tree = parseMarkdown("# my-pkg\n\n## 1.1.0\n\nChanges.\n\n## 1.0.0\n\nInitial.");
-* const blocks = getVersionBlocks(tree);
-* // blocks.length === 2
-* // blocks[0] covers "## 1.1.0" section
-* // blocks[1] covers "## 1.0.0" section
-* ```
-*
-* @internal
-*/
-function getVersionBlocks(tree) {
-	const blocks = [];
-	for (let i = 0; i < tree.children.length; i++) {
-		const node = tree.children[i];
-		if (node.type === "heading" && node.depth === 2) blocks.push({
-			headingIndex: i,
-			startIndex: i + 1,
-			endIndex: tree.children.length
-		});
-	}
-	for (let i = 0; i < blocks.length - 1; i++) blocks[i].endIndex = blocks[i + 1].headingIndex;
-	return blocks;
-}
-/**
-* Extract h3 sections within a version block.
-*
-* @remarks
-* Iterates over the children of the given version block (from
-* `block.startIndex` to `block.endIndex`). Each h3 heading starts
-* a new section, and subsequent non-heading nodes are collected
-* into that section's `contentNodes` array until the next h3 or
-* the end of the block.
-*
-* Nodes before the first h3 within the block (e.g., a version
-* summary paragraph) are not included in any section.
-*
-* @param tree - The MDAST root node of a CHANGELOG document
-* @param block - The version block to extract sections from
-* @returns Array of sections in document order
-*
-* @example
-* ```typescript
-* import { getVersionBlocks, getBlockSections } from "../utils/version-blocks.js";
-* import { parseMarkdown } from "../utils/remark-pipeline.js";
-*
-* const tree = parseMarkdown("## 1.0.0\n\n### Features\n\n- New API\n\n### Bug Fixes\n\n- Fixed crash");
-* const blocks = getVersionBlocks(tree);
-* const sections = getBlockSections(tree, blocks[0]);
-* // sections.length === 2
-* // sections[0].heading text === "Features"
-* ```
-*
-* @internal
-*/
-function getBlockSections(tree, block) {
-	const sections = [];
-	for (let i = block.startIndex; i < block.endIndex; i++) {
-		const node = tree.children[i];
-		if (node.type === "heading" && node.depth === 3) sections.push({
-			heading: node,
-			headingIndex: i,
-			contentNodes: []
-		});
-		else if (sections.length > 0) sections[sections.length - 1].contentNodes.push(node);
-	}
-	return sections;
-}
-/**
-* Get the plain text content of a heading node.
-*
-* @remarks
-* Delegates to `mdast-util-to-string` to extract concatenated text
-* from all inline children of the heading (handling bold, italic,
-* code spans, etc.).
-*
-* @param heading - The MDAST heading node
-* @returns The heading text content as a plain string
-*
-* @internal
-*/
-function getHeadingText(heading) {
-	return toString(heading);
-}
-
-export { getBlockSections, getHeadingText, getVersionBlocks };