🐛 Use colonFence from myst-extras

Author: rowanc1

package-lock.json

@@ -76,6 +76,7 @@
     "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.5.1",
     "markdown-it": "^12.3.2",
+    "markdown-it-myst-extras": "^0.2.0",
     "npm-run-all": "^4.1.5",
     "postcss": "^8.4.6",
     "postcss-cli": "^9.1.0",

package.json

@@ -9,7 +9,6 @@ import {
   IDirectiveData
 } from "./directives"
 import statePlugin from "./state/plugin"
-import { colonFencePlugin } from "./colonFence"
 
 export { rolesDefault, rolePlugin, Role }
 export { directivesDefault, directivePlugin, Directive, directiveOptions }
@@ -19,13 +18,11 @@ export type { IRoleData, IRoleOptions, IDirectiveData, IDirectiveOptions }
 /** Allowed options for docutils plugin */
 export interface IOptions extends IDirectiveOptions, IRoleOptions {
   // TODO new token render rules
-  colonFences: boolean
 }
 
 /** Default options for docutils plugin */
 const OptionDefaults: IOptions = {
   parseRoles: true,
-  colonFences: true,
   replaceFences: true,
   rolesAfter: "inline",
   directivesAfter: "block",
@@ -39,7 +36,6 @@ const OptionDefaults: IOptions = {
 export function docutilsPlugin(md: MarkdownIt, options?: IOptions): void {
   const fullOptions = { ...OptionDefaults, ...options }
 
-  if (fullOptions.colonFences) md.use(colonFencePlugin)
   md.use(rolePlugin, fullOptions)
   md.use(directivePlugin, fullOptions)
   md.use(statePlugin, fullOptions)

src/colonFence.ts

@@ -1,16 +1,19 @@
 /* eslint-disable jest/valid-title */
 import MarkdownIt from "markdown-it"
+import { colonFencePlugin } from "markdown-it-myst-extras"
 import docutils_plugin from "../src"
 import readFixtures from "./readFixtures"
 
+// We have to test compatibility with colonFences here!
+
 describe("Parses colonFences", () => {
   test("colon fences parse", () => {
-    const mdit = MarkdownIt().use(docutils_plugin)
+    const mdit = MarkdownIt().use(colonFencePlugin).use(docutils_plugin)
     const parse = mdit.parse(`:::{tip}\nThis is a tip in a fence!\n:::`, {})
     expect(parse[0].type).toBe("parsed_directive_open")
   })
   test("colon fences render", () => {
-    const mdit = MarkdownIt().use(docutils_plugin)
+    const mdit = MarkdownIt().use(colonFencePlugin).use(docutils_plugin)
     const rendered = mdit.render(`:::{tip}\nfence\n:::`)
     expect(rendered.trim()).toEqual(
       '<aside class="admonition tip">\n<header class="admonition-title">Tip</header>\n<p>fence</p>\n</aside>'
@@ -20,7 +23,7 @@ describe("Parses colonFences", () => {
 
 describe("Parses fenced directives", () => {
   readFixtures("directives.fence").forEach(([name, text, expected]) => {
-    const mdit = MarkdownIt().use(docutils_plugin)
+    const mdit = MarkdownIt().use(colonFencePlugin).use(docutils_plugin)
     const rendered = mdit.render(text)
     it(name, () => expect(rendered.trim()).toEqual((expected || "").trim()))
   })