mirror of
https://github.com/Funkoala14/knowledgebase_law.git
synced 2025-06-09 19:58:16 +08:00
176 lines
5.2 KiB
JavaScript
176 lines
5.2 KiB
JavaScript
|
/**
|
|||
|
* @import {Root as HastRoot} from 'hast'
|
|||
|
* @import {Root as MdastRoot} from 'mdast'
|
|||
|
* @import {Options as ToHastOptions} from 'mdast-util-to-hast'
|
|||
|
* @import {Processor} from 'unified'
|
|||
|
* @import {VFile} from 'vfile'
|
|||
|
*/
|
|||
|
|
|||
|
/**
|
|||
|
* @typedef {Omit<ToHastOptions, 'file'>} Options
|
|||
|
*
|
|||
|
* @callback TransformBridge
|
|||
|
* Bridge-mode.
|
|||
|
*
|
|||
|
* Runs the destination with the new hast tree.
|
|||
|
* Discards result.
|
|||
|
* @param {MdastRoot} tree
|
|||
|
* Tree.
|
|||
|
* @param {VFile} file
|
|||
|
* File.
|
|||
|
* @returns {Promise<undefined>}
|
|||
|
* Nothing.
|
|||
|
*
|
|||
|
* @callback TransformMutate
|
|||
|
* Mutate-mode.
|
|||
|
*
|
|||
|
* Further transformers run on the hast tree.
|
|||
|
* @param {MdastRoot} tree
|
|||
|
* Tree.
|
|||
|
* @param {VFile} file
|
|||
|
* File.
|
|||
|
* @returns {HastRoot}
|
|||
|
* Tree (hast).
|
|||
|
*/
|
|||
|
|
|||
|
import {toHast} from 'mdast-util-to-hast'
|
|||
|
|
|||
|
/**
|
|||
|
* Turn markdown into HTML.
|
|||
|
*
|
|||
|
* ##### Notes
|
|||
|
*
|
|||
|
* ###### Signature
|
|||
|
*
|
|||
|
* * if a processor is given,
|
|||
|
* runs the (rehype) plugins used on it with a hast tree,
|
|||
|
* then discards the result (*bridge mode*)
|
|||
|
* * otherwise,
|
|||
|
* returns a hast tree,
|
|||
|
* the plugins used after `remarkRehype` are rehype plugins (*mutate mode*)
|
|||
|
*
|
|||
|
* > 👉 **Note**:
|
|||
|
* > It’s highly unlikely that you want to pass a `processor`.
|
|||
|
*
|
|||
|
* ###### HTML
|
|||
|
*
|
|||
|
* Raw HTML is available in mdast as `html` nodes and can be embedded in hast
|
|||
|
* as semistandard `raw` nodes.
|
|||
|
* Most plugins ignore `raw` nodes but two notable ones don’t:
|
|||
|
*
|
|||
|
* * `rehype-stringify` also has an option `allowDangerousHtml` which will
|
|||
|
* output the raw HTML.
|
|||
|
* This is typically discouraged as noted by the option name but is useful if
|
|||
|
* you completely trust authors
|
|||
|
* * `rehype-raw` can handle the raw embedded HTML strings by parsing them
|
|||
|
* into standard hast nodes (`element`, `text`, etc);
|
|||
|
* this is a heavy task as it needs a full HTML parser,
|
|||
|
* but it is the only way to support untrusted content
|
|||
|
*
|
|||
|
* ###### Footnotes
|
|||
|
*
|
|||
|
* Many options supported here relate to footnotes.
|
|||
|
* Footnotes are not specified by CommonMark,
|
|||
|
* which we follow by default.
|
|||
|
* They are supported by GitHub,
|
|||
|
* so footnotes can be enabled in markdown with `remark-gfm`.
|
|||
|
*
|
|||
|
* The options `footnoteBackLabel` and `footnoteLabel` define natural language
|
|||
|
* that explains footnotes,
|
|||
|
* which is hidden for sighted users but shown to assistive technology.
|
|||
|
* When your page is not in English,
|
|||
|
* you must define translated values.
|
|||
|
*
|
|||
|
* Back references use ARIA attributes,
|
|||
|
* but the section label itself uses a heading that is hidden with an
|
|||
|
* `sr-only` class.
|
|||
|
* To show it to sighted users,
|
|||
|
* define different attributes in `footnoteLabelProperties`.
|
|||
|
*
|
|||
|
* ###### Clobbering
|
|||
|
*
|
|||
|
* Footnotes introduces a problem,
|
|||
|
* as it links footnote calls to footnote definitions on the page through `id`
|
|||
|
* attributes generated from user content,
|
|||
|
* which results in DOM clobbering.
|
|||
|
*
|
|||
|
* DOM clobbering is this:
|
|||
|
*
|
|||
|
* ```html
|
|||
|
* <p id=x></p>
|
|||
|
* <script>alert(x) // `x` now refers to the DOM `p#x` element</script>
|
|||
|
* ```
|
|||
|
*
|
|||
|
* Elements by their ID are made available by browsers on the `window` object,
|
|||
|
* which is a security risk.
|
|||
|
* Using a prefix solves this problem.
|
|||
|
*
|
|||
|
* More information on how to handle clobbering and the prefix is explained in
|
|||
|
* *Example: headings (DOM clobbering)* in `rehype-sanitize`.
|
|||
|
*
|
|||
|
* ###### Unknown nodes
|
|||
|
*
|
|||
|
* Unknown nodes are nodes with a type that isn’t in `handlers` or `passThrough`.
|
|||
|
* The default behavior for unknown nodes is:
|
|||
|
*
|
|||
|
* * when the node has a `value`
|
|||
|
* (and doesn’t have `data.hName`, `data.hProperties`, or `data.hChildren`,
|
|||
|
* see later),
|
|||
|
* create a hast `text` node
|
|||
|
* * otherwise,
|
|||
|
* create a `<div>` element (which could be changed with `data.hName`),
|
|||
|
* with its children mapped from mdast to hast as well
|
|||
|
*
|
|||
|
* This behavior can be changed by passing an `unknownHandler`.
|
|||
|
*
|
|||
|
* @overload
|
|||
|
* @param {Processor} processor
|
|||
|
* @param {Readonly<Options> | null | undefined} [options]
|
|||
|
* @returns {TransformBridge}
|
|||
|
*
|
|||
|
* @overload
|
|||
|
* @param {Readonly<Options> | null | undefined} [options]
|
|||
|
* @returns {TransformMutate}
|
|||
|
*
|
|||
|
* @overload
|
|||
|
* @param {Readonly<Options> | Processor | null | undefined} [destination]
|
|||
|
* @param {Readonly<Options> | null | undefined} [options]
|
|||
|
* @returns {TransformBridge | TransformMutate}
|
|||
|
*
|
|||
|
* @param {Readonly<Options> | Processor | null | undefined} [destination]
|
|||
|
* Processor or configuration (optional).
|
|||
|
* @param {Readonly<Options> | null | undefined} [options]
|
|||
|
* When a processor was given,
|
|||
|
* configuration (optional).
|
|||
|
* @returns {TransformBridge | TransformMutate}
|
|||
|
* Transform.
|
|||
|
*/
|
|||
|
export default function remarkRehype(destination, options) {
|
|||
|
if (destination && 'run' in destination) {
|
|||
|
/**
|
|||
|
* @type {TransformBridge}
|
|||
|
*/
|
|||
|
return async function (tree, file) {
|
|||
|
// Cast because root in -> root out.
|
|||
|
const hastTree = /** @type {HastRoot} */ (
|
|||
|
toHast(tree, {file, ...options})
|
|||
|
)
|
|||
|
await destination.run(hastTree, file)
|
|||
|
}
|
|||
|
}
|
|||
|
|
|||
|
/**
|
|||
|
* @type {TransformMutate}
|
|||
|
*/
|
|||
|
return function (tree, file) {
|
|||
|
// Cast because root in -> root out.
|
|||
|
// To do: in the future, disallow ` || options` fallback.
|
|||
|
// With `unified-engine`, `destination` can be `undefined` but
|
|||
|
// `options` will be the file set.
|
|||
|
// We should not pass that as `options`.
|
|||
|
return /** @type {HastRoot} */ (
|
|||
|
toHast(tree, {file, ...(destination || options)})
|
|||
|
)
|
|||
|
}
|
|||
|
}
|