feat: extension point for myst options

src/MySTContentFactory.ts

@@ -1,15 +1,25 @@
 import { MarkdownCell } from '@jupyterlab/cells';
 import { NotebookPanel, StaticNotebook } from '@jupyterlab/notebook';
 import { MySTMarkdownCell } from './MySTMarkdownCell';
+import { MySTOptionsProvider, MySTNotebookDefaults } from './myst';
 
 export class MySTContentFactory extends NotebookPanel.ContentFactory {
+
+  mystOptions: MySTOptionsProvider<StaticNotebook>;
+
+  constructor(options = {},
+              mystOptions = new MySTNotebookDefaults() as MySTOptionsProvider<StaticNotebook>) {
+    super(options);
+    this.mystOptions = mystOptions;
+  }
+
   createMarkdownCell(
     options: MarkdownCell.IOptions,
     parent: StaticNotebook
   ): MarkdownCell {
     if (!options.contentFactory) {
       options.contentFactory = this;
     }
-    return new MySTMarkdownCell(options).initializeState();
+    return new MySTMarkdownCell(options, this.mystOptions).initializeState();
   }
 }

src/MySTMarkdownCell.tsx

@@ -14,7 +14,7 @@ import {
 } from '@myst-theme/providers';
 import { render } from 'react-dom';
 import { useParse } from 'myst-to-react';
-import { parseContent } from './myst';
+import { parseContent, MySTOptionsProvider } from './myst';
 import { IMySTMarkdownCell } from './types';
 import { linkFactory } from './links';
 import { selectAll } from 'unist-util-select';
@@ -29,22 +29,35 @@ export class MySTMarkdownCell
   implements IMySTMarkdownCell
 {
   private _doneRendering = new PromiseDelegate<void>();
+  private _doRendering = false;
+
+  mystOptions: MySTOptionsProvider<StaticNotebook>;
 
   myst: {
     pre?: GenericParent;
     post?: GenericParent;
     node?: HTMLDivElement;
   } = {};
 
-  constructor(options: MarkdownCell.IOptions) {
+  constructor(options: MarkdownCell.IOptions, mystOptions: MySTOptionsProvider<StaticNotebook>) {
     super(options);
+    this.mystOptions = mystOptions;
+
+    // BUG: if renderInput() was attempted from super constructor, now it can be done
+    if (this._doRendering) this.renderInput(null as unknown as Widget);
+    this._doRendering = true;
 
     // Listen for changes to the cell trust
     const trusted = this.model.modelDB.get('trusted') as ObservableValue;
     trusted.changed.connect(this.mystRender, this);
   }
 
   renderInput(_: Widget): void {
+    if (!this._doRendering) {
+      // BUG: super constructor calls renderInput() but (of course) object isn't fully constructed
+      this._doRendering = true;
+      return;
+    }
     if (!this.myst || !this.myst.node) {
       // Create the node if it does not exist
       const node = document.createElement('div');
@@ -54,7 +67,7 @@ export class MySTMarkdownCell
     this._doneRendering = new PromiseDelegate<void>();
     const notebook = this.parent as StaticNotebook;
     this.myst.pre = undefined;
-    const parseComplete = parseContent(notebook);
+    const parseComplete = parseContent(notebook, this.mystOptions.get(notebook));
     const widget = new Widget({ node: this.myst.node });
     widget.addClass('myst');
     widget.addClass('jp-MarkdownOutput');

src/index.ts

@@ -3,6 +3,7 @@ import {
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 
+import { Token } from '@lumino/coreutils';
 import { IEditorServices } from '@jupyterlab/codeeditor';
 
 import {
@@ -11,9 +12,11 @@ import {
   NotebookPanel,
   NotebookWidgetFactory,
   NotebookActions,
-  Notebook
+  Notebook,
+  StaticNotebook
 } from '@jupyterlab/notebook';
 import { Cell } from '@jupyterlab/cells';
+import { MySTOptionsProvider } from './myst';
 import { MySTContentFactory } from './MySTContentFactory';
 
 import { ISessionContextDialogs } from '@jupyterlab/apputils';
@@ -30,18 +33,25 @@ const mystIcon = new LabIcon({
   svgstr: mystIconSvg
 });
 
+/**
+ * Extension point for MyST options to be defined given a notebook.
+ * A null provider results in default parser options appropriate to all notebooks.
+ */
+export const IMySTNotebookOptions = new Token<MySTOptionsProvider<StaticNotebook>>('jupyterlab-myst:IMySTNotebookOptions');
+
 /**
  * The notebook content factory provider.
  */
 const plugin: JupyterFrontEndPlugin<NotebookPanel.IContentFactory> = {
   id: 'jupyterlab-myst:plugin',
   provides: NotebookPanel.IContentFactory,
   requires: [IEditorServices],
+  optional: [IMySTNotebookOptions],
   autoStart: true,
-  activate: (app: JupyterFrontEnd, editorServices: IEditorServices) => {
+  activate: (app: JupyterFrontEnd, editorServices: IEditorServices, mystOptions: MySTOptionsProvider<StaticNotebook>) => {
     console.log('JupyterLab extension jupyterlab-myst is activated!');
     const editorFactory = editorServices.factoryService.newInlineEditor;
-    return new MySTContentFactory({ editorFactory });
+    return new MySTContentFactory({ editorFactory }, mystOptions || undefined);
   }
 };
 

src/myst.ts

@@ -1,4 +1,4 @@
-import { mystParse } from 'myst-parser';
+import { mystParse, AllOptions } from 'myst-parser';
 import { liftChildren } from 'myst-common';
 import {
   mathPlugin,
@@ -36,6 +36,28 @@ import { imageUrlSourceTransform } from './images';
 import { internalLinksPlugin } from './links';
 import { addCiteChildrenPlugin } from './citations';
 
+export interface MySTOptions {
+
+  parserOptions: Partial<AllOptions>;
+}
+
+export interface MySTOptionsProvider<Widget> {
+
+  get(widget: Widget): MySTOptions;
+}
+
+export class MySTNotebookDefaults implements MySTOptionsProvider<StaticNotebook> {
+
+  get(notebook: StaticNotebook): MySTOptions {
+    return {
+      parserOptions: {
+        directives: [cardDirective, gridDirective, ...tabDirectives],
+        roles: [evalRole],
+      },
+    };
+  }
+}
+
 const evalRole: RoleSpec = {
   name: 'eval',
   body: {
@@ -48,11 +70,8 @@ const evalRole: RoleSpec = {
   }
 };
 
-export function markdownParse(text: string): Root {
-  const mdast = mystParse(text, {
-    directives: [cardDirective, gridDirective, ...tabDirectives],
-    roles: [evalRole]
-  });
+export function markdownParse(text: string, options: Partial<AllOptions>): Root {
+  const mdast = mystParse(text, options);
   // Parsing individually here requires that link and footnote references are contained to the cell
   // This is consistent with the current Jupyter markdown renderer
   unified()
@@ -73,7 +92,10 @@ export function markdownParse(text: string): Root {
   return mdast as Root;
 }
 
-export function parseContent(notebook: StaticNotebook): Promise<void> {
+export function parseContent(
+  notebook: StaticNotebook,
+  options: MySTOptions
+): Promise<void> {
   const cells = getCellList(notebook)?.filter(
     // In the future, we may want to process the code cells as well, but not now
     cell => cell.model.type === 'markdown'
@@ -87,7 +109,7 @@ export function parseContent(notebook: StaticNotebook): Promise<void> {
     const text = cell.model?.value.text ?? '';
     if (!cell.myst.pre) {
       // This will be cleared when the cell is executed, and parsed again here
-      cell.myst.pre = markdownParse(text);
+      cell.myst.pre = markdownParse(text, options.parserOptions);
     }
     return { type: 'block', children: copyNode(cell.myst.pre).children };
   });