oast-to-hast 4.5.2 → 4.6.0

package/lib/handlers/headline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"headline.d.ts","sourceRoot":"","sources":["headline.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,gCAJW,OAAO,aAAa,EAAE,KAAK,QAC3B,OAAO,MAAM,EAAE,QAAQ,GACrB,OAAO,MAAM,EAAE,OAAO,CASlC"}
+{"version":3,"file":"headline.d.ts","sourceRoot":"","sources":["headline.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,gCAJW,OAAO,aAAa,EAAE,KAAK,QAC3B,OAAO,MAAM,EAAE,QAAQ,GACrB,OAAO,MAAM,EAAE,OAAO,CAUlC"}

package/lib/handlers/headline.js

@@ -4,10 +4,11 @@
  * @returns {import('hast').Element}
  */
 export function headline(state, node) {
+	const id = state.ids.byNode.get(node)
 	return state.patch(node, {
 		type: 'element',
 		tagName: `h${node.level}`,
-		properties: {},
+		properties: id ? { id } : {},
 		children: state.all(node)
 	})
 }

package/lib/handlers/section.d.ts

@@ -4,4 +4,10 @@
  * @returns {import('hast').Element|undefined}
  */
 export function section(state: import("../state.js").State, node: import("orga").Section): import("hast").Element | undefined;
+/**
+ * @param {Pick<import('../state.js').Config, 'selectTags' | 'excludeTags'>} config
+ * @param {string[]} tags
+ * @returns {boolean}
+ */
+export function shouldSkip({ selectTags, excludeTags }: Pick<import("../state.js").Config, "selectTags" | "excludeTags">, tags: string[]): boolean;
 //# sourceMappingURL=section.d.ts.map

package/lib/handlers/section.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["section.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,+BAJW,OAAO,aAAa,EAAE,KAAK,QAC3B,OAAO,MAAM,EAAE,OAAO,GACpB,OAAO,MAAM,EAAE,OAAO,GAAC,SAAS,CA6B5C"}
+{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["section.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,+BAJW,OAAO,aAAa,EAAE,KAAK,QAC3B,OAAO,MAAM,EAAE,OAAO,GACpB,OAAO,MAAM,EAAE,OAAO,GAAC,SAAS,CA6B5C;AAED;;;;GAIG;AACH,wDAJW,IAAI,CAAC,OAAO,aAAa,EAAE,MAAM,EAAE,YAAY,GAAG,aAAa,CAAC,QAChE,MAAM,EAAE,GACN,OAAO,CAYnB"}

package/lib/handlers/section.js

@@ -33,11 +33,11 @@ export function section(state, node) {
 }
 
 /**
- * @param {import('../state.js').Config} config
+ * @param {Pick<import('../state.js').Config, 'selectTags' | 'excludeTags'>} config
  * @param {string[]} tags
  * @returns {boolean}
  */
-function shouldSkip({ selectTags = [], excludeTags = [] }, tags) {
+export function shouldSkip({ selectTags = [], excludeTags = [] }, tags) {
 	if (selectTags.length > 0) {
 		return !tags.some((tag) => selectTags.includes(tag))
 	}

package/lib/ids.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Slug of heading text: lowercased, punctuation dropped, spaces as dashes.
+ *
+ * @param {string} text
+ * @returns {string}
+ */
+export function slug(text: string): string;
+/**
+ * Assign every rendered headline a unique id: its section's `CUSTOM_ID` when
+ * set, otherwise a slug of its text (`-1`, `-2`… on repeats). Sections skipped
+ * by `selectTags`/`excludeTags` are left out, as they are when rendering.
+ *
+ * @param {Nodes} tree
+ * @param {Pick<Config, 'selectTags' | 'excludeTags'>} config
+ */
+export function headingIds(tree: Nodes, config: Pick<Config, "selectTags" | "excludeTags">): {
+    byNode: Map<Headline, string>;
+    byText: Map<string, string>;
+};
+import type { Nodes } from 'orga';
+import type { Config } from './state.js';
+import type { Headline } from 'orga';
+//# sourceMappingURL=ids.d.ts.map

package/lib/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["ids.js"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,2BAHW,MAAM,GACJ,MAAM,CAQlB;AAED;;;;;;;GAOG;AACH,iCAHW,KAAK,UACL,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,CAAC;;;EAiDpD;2BA3EiC,MAAM;4BACf,YAAY;8BADH,MAAM"}

package/lib/ids.js

@@ -0,0 +1,90 @@
+/**
+ * @import {Headline, Nodes} from 'orga'
+ * @import {Config} from './state.js'
+ */
+
+import { shouldSkip } from './handlers/section.js'
+
+/**
+ * Slug of heading text: lowercased, punctuation dropped, spaces as dashes.
+ *
+ * @param {string} text
+ * @returns {string}
+ */
+export function slug(text) {
+	return text
+		.toLowerCase()
+		.trim()
+		.replace(/[^\p{L}\p{N}\s_-]/gu, '')
+		.replace(/\s+/g, '-')
+}
+
+/**
+ * Assign every rendered headline a unique id: its section's `CUSTOM_ID` when
+ * set, otherwise a slug of its text (`-1`, `-2`… on repeats). Sections skipped
+ * by `selectTags`/`excludeTags` are left out, as they are when rendering.
+ *
+ * @param {Nodes} tree
+ * @param {Pick<Config, 'selectTags' | 'excludeTags'>} config
+ */
+export function headingIds(tree, config) {
+	/** @type {Array<{headline: Headline, customId: string | undefined}>} */
+	const headlines = []
+	collect(tree)
+
+	const used = new Set(headlines.map((h) => h.customId).filter(Boolean))
+	/** @type {Map<Headline, string>} */
+	const byNode = new Map()
+	/** @type {Map<string, string>} first heading with this text slug → its id */
+	const byText = new Map()
+
+	for (const { headline, customId } of headlines) {
+		const base = slug(text(headline))
+		let id = customId
+		if (!id && base) {
+			id = base
+			for (let n = 1; used.has(id); n++) id = `${base}-${n}`
+			used.add(id)
+		}
+		if (!id) continue
+		byNode.set(headline, id)
+		if (base && !byText.has(base)) byText.set(base, id)
+	}
+
+	return { byNode, byText }
+
+	/**
+	 * @param {Nodes} node
+	 * @param {Nodes} [parent]
+	 */
+	function collect(node, parent) {
+		if (node.type === 'headline') {
+			const customId =
+				parent?.type === 'section' ? parent.properties.custom_id : undefined
+			headlines.push({
+				headline: node,
+				customId: typeof customId === 'string' ? customId : undefined
+			})
+			return
+		}
+		if (!('children' in node)) return
+		if (node.type === 'section') {
+			const headline = node.children.find((n) => n.type === 'headline')
+			if (headline && shouldSkip(config, headline.tags || [])) return
+		}
+		for (const child of node.children) collect(child, node)
+	}
+}
+
+const skip = new Set(['stars', 'todo', 'priority', 'tags'])
+
+/**
+ * @param {Nodes} node
+ * @returns {string}
+ */
+function text(node) {
+	if (skip.has(node.type)) return ''
+	if ('children' in node) return node.children.map(text).join('')
+	if (node.type === 'text') return node.value
+	return ''
+}

package/lib/state.d.ts

@@ -1,14 +1,17 @@
 /**
- * @param {OastNodes} _tree
+ * @param {OastNodes} tree
  * @param {Partial<Config> | null | undefined} [options = {}]
  */
-export function createState(_tree: OastNodes, options?: Partial<Config> | null | undefined): {
+export function createState(tree: OastNodes, options?: Partial<Config> | null | undefined): {
     one: (node: OastNodes, parent?: OastParent | undefined) => HastRoot | HastElementContent | HastElementContent[] | undefined;
+    ids: {
+        byNode: Map<import("orga").Headline, string>;
+        byText: Map<string, string>;
+    };
     all: (parent: OastNodes) => Array<HastElementContent>;
     handlers: Partial<Record<"newline" | "document" | "headline" | "paragraph" | "keyword" | "block" | "list" | "html" | "jsx" | "stars" | "todo" | "link" | "section" | "drawer" | "planning" | "table" | "hr" | "latex" | "footnote" | "table.row" | "table.hr" | "table.cell" | "list.item" | "text" | "footnote.reference" | "emptyLine" | "priority" | "tags" | "planning.keyword" | "planning.timestamp" | "list.item.tag" | "list.item.checkbox" | "list.item.bullet" | "table.columnSeparator" | "footnote.label" | "block.begin" | "block.end" | "latex.begin" | "latex.end" | "drawer.begin" | "drawer.end" | "comment" | "opening" | "closing" | "link.path", Handler>>;
     getAttrHtml: (node: OastNodes) => Record<string, string> | undefined;
     patch: <T extends HastNodes>(from: OastNodes, to: T) => T;
-    /** @type {Config} */
     options: Config;
 };
 export type HastNodes = import("hast").Nodes;

package/lib/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["state.js"],"names":[],"mappings":"AAiCA;;;GAGG;AACH,mCAHW,SAAS,YACT,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS;gBAqDjC,SAAS,WACT,UAAU,GAAG,SAAS;kBAzBtB,SAAS,KACP,KAAK,CAAC,kBAAkB,CAAC;;wBAgC3B,SAAS,KACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS;YAYtB,CAAC,SAAZ,SAAU,QACb,SAAS,MACT,CAAC,KACC,CAAC;IA/Db,qBAAqB;aAAV,MAAM;EAuElB;wBAxHY,OAAO,MAAM,EAAE,KAAK;yBAEpB,OAAO,MAAM,EAAE,MAAM;wBACrB,OAAO,MAAM,EAAE,KAAK;;cAKnB,QAAQ;gBACR,MAAM;cACN,CAAC,IAAI,EAAE,OAAO,MAAM,EAAE,IAAI,KAAK,MAAM;;;;gBACrC,MAAM,EAAE;;;;iBACR,MAAM,EAAE;;oBAIT,UAAU,CAAC,OAAO,WAAW,CAAC;8BAGhC,KAAK,QACL,GAAG,UACH,UAAU,GAAG,SAAS,KACpB,KAAK,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,GAAG,QAAQ,GAAG,SAAS;;;;uBAGrE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;sCAxBe,MAAM;0DAAN,MAAM"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["state.js"],"names":[],"mappings":"AAkCA;;;GAGG;AACH,kCAHW,SAAS,YACT,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS;gBA+EjC,SAAS,WACT,UAAU,GAAG,SAAS;;;;;kBAzBtB,SAAS,KACP,KAAK,CAAC,kBAAkB,CAAC;;wBAgC3B,SAAS,KACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS;YAYtB,CAAC,SAAZ,SAAU,QACb,SAAS,MACT,CAAC,KACC,CAAC;;EAQd;wBAnJY,OAAO,MAAM,EAAE,KAAK;yBAEpB,OAAO,MAAM,EAAE,MAAM;wBACrB,OAAO,MAAM,EAAE,KAAK;;cAKnB,QAAQ;gBACR,MAAM;cACN,CAAC,IAAI,EAAE,OAAO,MAAM,EAAE,IAAI,KAAK,MAAM;;;;gBACrC,MAAM,EAAE;;;;iBACR,MAAM,EAAE;;oBAIT,UAAU,CAAC,OAAO,WAAW,CAAC;8BAGhC,KAAK,QACL,GAAG,UACH,UAAU,GAAG,SAAS,KACpB,KAAK,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,GAAG,QAAQ,GAAG,SAAS;;;;uBAGrE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;sCAxBe,MAAM;0DAAN,MAAM"}

package/lib/state.js

@@ -30,37 +30,64 @@
 
 import { position } from 'unist-util-position'
 import { handlers as defaultHandlers } from './handlers/index.js'
+import { headingIds, slug } from './ids.js'
 
 /**
- * @param {OastNodes} _tree
+ * @param {OastNodes} tree
  * @param {Partial<Config> | null | undefined} [options = {}]
  */
-export function createState(_tree, options = {}) {
+export function createState(tree, options = {}) {
 	/** @type {Handlers} */
 	let handlers = { ...defaultHandlers }
 	if (options?.handlers) {
 		handlers = { ...handlers, ...options.handlers }
 	}
 
+	/** @type {Config} */
+	const config = {
+		handlers,
+		linkTarget: '_self',
+		selectTags: [],
+		excludeTags: ['noexport'],
+		linkHref: defaultLinkHref,
+		...options
+	}
+	const ids = headingIds(tree, config)
+
 	const state = {
 		one,
+		ids,
 		all,
 		handlers,
 		getAttrHtml,
 		patch,
-		/** @type {Config} */
-		options: {
-			handlers,
-			linkTarget: '_self',
-			selectTags: [],
-			excludeTags: ['noexport'],
-			linkHref: (link) => link.path.value,
-			...options
-		}
+		options: config
 	}
 
 	return state
 
+	/**
+	 * @param {import('orga').Link} link
+	 * @returns {string}
+	 */
+	function defaultLinkHref(link) {
+		const { protocol, value, search } = link.path
+		if (protocol === 'internal' && value.startsWith('*')) {
+			const target = slug(value.slice(1))
+			return `#${ids.byText.get(target) ?? target}`
+		}
+		if (!protocol || protocol === 'internal') {
+			return value
+		}
+		if (protocol === 'file') {
+			return value + fragment(search)
+		}
+		if (protocol === 'http' || protocol === 'https') {
+			return value
+		}
+		return `${protocol}:${value}`
+	}
+
 	/**
 	 * @param {OastNodes} parent
 	 * @returns {Array<HastElementContent>}
@@ -121,6 +148,20 @@ export function createState(_tree, options = {}) {
 	}
 }
 
+/**
+ * URL fragment for a `file:` link's search option: `*Heading` and `#custom-id`
+ * target a heading; other searches (line numbers, text) are dropped.
+ *
+ * @param {string | number | undefined} search
+ * @returns {string}
+ */
+function fragment(search) {
+	if (typeof search !== 'string') return ''
+	if (search.startsWith('#')) return search
+	if (search.startsWith('*')) return `#${slug(search.slice(1))}`
+	return ''
+}
+
 /** @type {Handler} */
 function unkownHandler(state, node) {
 	if (node?.children) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oast-to-hast",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "Transform OAST to HAST",
   "files": [
     "lib",