refactor: move things around

src/MySTMarkdownCell.tsx

@@ -4,11 +4,11 @@ import { ActivityMonitor } from '@jupyterlab/coreutils';
 import { AttachmentsResolver } from '@jupyterlab/attachments';
 import { IMapChange } from '@jupyter/ydoc';
 import { IMySTMarkdownCell } from './types';
-import { getUserExpressions, metadataSection } from './metadata';
+import { getUserExpressions, metadataSection } from './userExpressions';
 import { IMySTModel, MySTModel, MySTWidget } from './widget';
 import { markdownParse, processCellMDAST, renderNotebook } from './myst';
 import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
-import { ITaskItemChange } from './TaskItemControllerProvider';
+import { ITaskItemChange } from './providers';
 
 class IMySTWidget {}
 

src/actions.ts

@@ -8,7 +8,7 @@ import {
   getUserExpressions,
   setUserExpressions,
   deleteUserExpressions
-} from './metadata';
+} from './userExpressions';
 import {
   INotebookTracker,
   Notebook,

src/components/index.tsx

@@ -0,0 +1,2 @@
+export * from './inlineExpression';
+export * from './listItem';

src/inlineExpression.tsx → src/components/inlineExpression.tsx

@@ -1,14 +1,14 @@
 import React, { useEffect, useRef, useState } from 'react';
-import { useUserExpressions } from './UserExpressionsProvider';
+import { useUserExpressions } from '../providers';
 import { SingletonLayout, Widget } from '@lumino/widgets';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import {
+  IUserExpressionMetadata,
   IExpressionError,
   IExpressionResult,
   isError,
   isOutput
-} from './userExpressions';
-import { IUserExpressionMetadata } from './metadata';
+} from '../userExpressions';
 
 export interface IRenderedExpressionOptions {
   expression: string;
@@ -213,7 +213,7 @@ function MIMEBundleRenderer({
   return <div ref={ref} className="not-prose inline-block" />;
 }
 
-export function InlineRenderer({ value }: { value?: string }): JSX.Element {
+export function InlineExpression({ value }: { value?: string }): JSX.Element {
   const { expressions, rendermime, trusted } = useUserExpressions();
 
   if (!expressions || !rendermime) {

src/taskItem.tsx → src/components/listItem.tsx

@@ -1,7 +1,5 @@
 import React from 'react';
-import { NodeRenderer } from '@myst-theme/providers';
-import type { ListItem } from 'myst-spec-ext';
-import { useTaskItemController } from './TaskItemControllerProvider';
+import { useTaskItemController } from '../providers';
 import { MyST } from 'myst-to-react';
 
 function TaskItem({
@@ -10,7 +8,7 @@ function TaskItem({
   children
 }: {
   checked?: boolean;
-  children: React.ReactNode;
+  children?: React.ReactNode;
   line?: number;
 }) {
   // The rendering waiting on promises from Jupyter is slow
@@ -38,23 +36,29 @@ function TaskItem({
   );
 }
 
-export const listItem: NodeRenderer<ListItem & { checked?: boolean }> = ({
-  node
-}) => {
-  if (node.checked === null) {
+export function ListItem({
+  checked,
+  line,
+  children
+}: {
+     checked?: boolean,
+     line?: number,
+     children?: any[]
+
+   }): JSX.Element {
+  if (checked === null) {
     return (
-      <li key={node.key}>
-        <MyST ast={node.children} />
+      <li>
+        <MyST ast={children} />
       </li>
     );
   }
   return (
     <TaskItem
-      key={node.key}
-      checked={node.checked}
-      line={node.position?.start.line}
+      checked={checked}
+      line={line}
     >
-      <MyST ast={node.children} />
+      <MyST ast={children} />
     </TaskItem>
   );
 };

src/myst.ts

@@ -30,10 +30,8 @@ import { exerciseDirectives } from 'myst-ext-exercise';
 import { StaticNotebook } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
-import { imageUrlSourceTransform } from './images';
-import { internalLinksTransform } from './links';
-import { addCiteChildrenPlugin } from './citations';
-import { IUserExpressionMetadata } from './metadata';
+import { imageUrlSourceTransform, internalLinksTransform, addCiteChildrenPlugin } from './transforms';
+import { IUserExpressionMetadata } from './userExpressions';
 import { IMySTMarkdownCell } from './types';
 import { Cell, ICellModel } from '@jupyterlab/cells';
 import { MySTModel } from './widget';

src/providers/index.tsx

@@ -0,0 +1,3 @@
+export * from './sanitizer';
+export * from './taskItem';
+export * from './userExpressions';

src/UserExpressionsProvider.tsx → src/providers/userExpressions.tsx

@@ -1,5 +1,5 @@
 import React, { createContext, useContext } from 'react';
-import { IUserExpressionMetadata } from './metadata';
+import { IUserExpressionMetadata } from '../userExpressions';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 
 type UserExpressionsState = {

src/renderers.tsx

@@ -2,17 +2,18 @@ import React from 'react';
 import { DEFAULT_RENDERERS } from 'myst-to-react';
 import { MermaidNodeRenderer } from '@myst-theme/diagrams';
 import { NodeRenderer } from '@myst-theme/providers';
-import { InlineRenderer } from './inlineExpression';
-import { listItem } from './taskItem';
-import { useSanitizer } from './SanitizerProvider';
+import { InlineExpression,  ListItem } from './components';
+import { useSanitizer } from './providers';
 
 export const renderers: Record<string, NodeRenderer> = {
   ...DEFAULT_RENDERERS,
   mermaid: MermaidNodeRenderer,
   inlineExpression: ({ node }) => {
-    return <InlineRenderer value={node.value} />;
+    return <InlineExpression value={node.value} />;
+  },
+  listItem: ({ node }) => {
+    return <ListItem checked={node.checked} line={node.position?.start.line} children={node.children}/>;
   },
-  listItem,
   html: ({ node }, children) => {
     const { sanitizer } = useSanitizer();
     if (sanitizer !== undefined) {

src/transforms/index.ts

@@ -0,0 +1,3 @@
+export * from './citations';
+export * from './images';
+export * from './links';

src/types.ts

@@ -2,6 +2,7 @@ import { MarkdownCell } from '@jupyterlab/cells';
 import { IMySTModel } from './widget';
 import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
 
+
 export type IMySTMarkdownCell = MarkdownCell & {
   readonly fragmentMDAST: any | undefined;
   readonly attachmentsResolver: IRenderMime.IResolver;

src/userExpressions.ts

@@ -1,4 +1,9 @@
 import { PartialJSONObject } from '@lumino/coreutils';
+import { Cell } from '@jupyterlab/cells';
+import type { IMySTMarkdownCell } from './types';
+
+
+export const metadataSection = 'user_expressions';
 
 /**
  * Interfaces for `IExecuteReplyMsg.user_expressisons`
@@ -32,3 +37,64 @@ export function isOutput(
 export function isError(output: IExpressionResult): output is IExpressionError {
   return output.status === 'error';
 }
+
+
+export interface IUserExpressionMetadata extends PartialJSONObject {
+  expression: string;
+  result: IExpressionResult;
+}
+
+export interface IUserExpressionsMetadata extends PartialJSONObject {
+  [metadataSection]: IUserExpressionMetadata[];
+}
+
+
+export function getUserExpressions(
+  cell: IMySTMarkdownCell | Cell
+): IUserExpressionMetadata[] | undefined {
+  if (!cell.model.getMetadata) {
+    // this is JupyterLab 3.6
+    return (cell.model.metadata as any)?.get(metadataSection) as
+      | IUserExpressionMetadata[]
+      | undefined;
+  }
+  return cell.model.getMetadata(metadataSection) as
+    | IUserExpressionMetadata[]
+    | undefined;
+}
+
+export function setUserExpressions(
+  cell: IMySTMarkdownCell | Cell,
+  expressions: IUserExpressionMetadata[]
+) {
+  if (!cell) {
+    return;
+  }
+  if (!cell.model.setMetadata) {
+    // this is JupyterLab 3.6
+    (cell.model.metadata as any).set(metadataSection, expressions);
+  } else {
+    cell.model.setMetadata(metadataSection, expressions);
+  }
+}
+
+export function deleteUserExpressions(cell: IMySTMarkdownCell | Cell) {
+  if (!cell) {
+    return;
+  }
+  if (!cell.model.setMetadata) {
+    // this is JupyterLab 3.6
+    (cell.model.metadata as any).delete(metadataSection);
+  } else {
+    cell.model.deleteMetadata(metadataSection);
+  }
+}
+
+export interface IUserExpressionMetadata extends PartialJSONObject {
+  expression: string;
+  result: IExpressionResult;
+}
+
+export interface IUserExpressionsMetadata extends PartialJSONObject {
+  [metadataSection]: IUserExpressionMetadata[];
+}

src/widget.tsx

@@ -13,16 +13,14 @@ import {
 } from '@myst-theme/providers';
 import { MyST } from 'myst-to-react';
 import React from 'react';
-import { UserExpressionsProvider } from './UserExpressionsProvider';
-import {
+import { UserExpressionsProvider,
   ITaskItemChange,
   ITaskItemController,
-  TaskItemControllerProvider
-} from './TaskItemControllerProvider';
+  TaskItemControllerProvider,
+  SanitizerProvider } from './providers';
 import { renderers } from './renderers';
-import { IUserExpressionMetadata } from './metadata';
-import { linkFactory } from './links';
-import { SanitizerProvider } from './SanitizerProvider';
+import { IUserExpressionMetadata } from './userExpressions';
+import { linkFactory } from './transforms';
 
 /**
  * The MIME type for Markdown.

tsconfig.json

@@ -19,5 +19,5 @@
     "strictNullChecks": true,
     "target": "ES2018"
   },
-  "include": ["src/*"]
+  "include": ["src/**/*"]
 }