-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(contented-pipeline-md): restrict what remark can be parsed
- Loading branch information
Showing
6 changed files
with
188 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
48 changes: 48 additions & 0 deletions
48
packages/contented-pipeline-md/fixtures/RemarkDirective.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # RemarkDirective | ||
|
|
||
| ::::codeblock-group | ||
|
|
||
| :::codeblock-header{filename="example.ts" language="TypeScript"} | ||
|
|
||
| ```ts | ||
| const a: number = 1; | ||
| const b: number = 2; | ||
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| :::codeblock-header{filename="example.js" language="JavaScript"} | ||
|
|
||
| ```js | ||
| const a = 1; | ||
| const b = 2; | ||
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ```txt | ||
| case 'div': | ||
| case 'table': | ||
| case 'tr': | ||
| case 'td': | ||
| case 'th': | ||
| case 'tbody': | ||
| case 'thead': | ||
| case 'tfoot': | ||
| ``` | ||
|
|
||
| Should only parse the tags above. | ||
|
|
||
| :::div{onClick="alert('clicked')"} | ||
| Should not parse onClick. | ||
| ::: | ||
|
|
||
| :::script | ||
| Should not parse script tags. | ||
| ::: | ||
|
|
||
| :::div{.admonitions.green} | ||
| This is `div{.admonitions.green}`. | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
packages/contented-pipeline-md/src/plugins/RemarkDirectiveRehype.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import { h } from 'hastscript'; | ||
| import type { Directive as DirectiveNode } from 'mdast-util-directive'; | ||
| import type { Plugin } from 'unified'; | ||
| import type { Node } from 'unist'; | ||
| import type { MapFunction } from 'unist-util-map'; | ||
| import { map } from 'unist-util-map'; | ||
|
|
||
| const isDirectiveNode = (node: Node): node is DirectiveNode => { | ||
| const { type } = node; | ||
| return type === 'textDirective' || type === 'leafDirective' || type === 'containerDirective'; | ||
| }; | ||
|
|
||
| function parseHastProperties(node: DirectiveNode): { tagName: string; properties: Record<string, string> } { | ||
| // @ts-ignore | ||
| return h(node.name, node.attributes); | ||
| } | ||
|
|
||
| function isTagAllowed(tagName: string): boolean { | ||
| switch (tagName) { | ||
| case 'div': | ||
| case 'table': | ||
| case 'tr': | ||
| case 'td': | ||
| case 'th': | ||
| case 'tbody': | ||
| case 'thead': | ||
| case 'tfoot': | ||
| return true; | ||
| default: | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| const mapDirectiveNode: MapFunction = (node) => { | ||
| if (isDirectiveNode(node)) { | ||
| const { tagName, properties } = parseHastProperties(node); | ||
|
|
||
| if (!isTagAllowed(tagName)) { | ||
| return node; | ||
| } | ||
|
|
||
| return { | ||
| ...node, | ||
| data: { | ||
| hName: tagName, | ||
| hProperties: { | ||
| className: properties?.className, | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| return node; | ||
| }; | ||
|
|
||
| export function remarkDirectiveRehype(): Plugin { | ||
| return (nodeTree) => map(nodeTree, mapDirectiveNode); | ||
| } |