directives -> shortcodes

src/core/handlers/base.ts

@@ -220,7 +220,7 @@ export async function handleLanguageCells(
       // directive handler
       for (const cell of cells) {
         const directiveCellType = cell.source.cell_type as DirectiveCell;
-        const innerLanguage = directiveCellType.tag;
+        const innerLanguage = directiveCellType.name;
         const innerLanguageHandler = handlers[innerLanguage]!;
 
         if (
@@ -235,12 +235,7 @@ export async function handleLanguageCells(
           innerLanguageHandler.type === "cell"
         ) {
           // if no handler is present (or a directive was included for something
-          // that responds to cells instead), just create a div tag
-          newCells[cell.index] = mappedReplace(
-            cell.source.source,
-            new RegExp(`<${directiveCellType.tag}`, "i"),
-            `<div quarto-directive="${directiveCellType.tag}"`,
-          );
+          // that responds to cells instead), we're a no-op
           continue;
         }
         if (innerLanguageHandler.directive === undefined) {
@@ -257,7 +252,7 @@ export async function handleLanguageCells(
 
         newCells[cell.index] = asMappedString(innerLanguageHandler.directive(
           innerHandler.context,
-          directiveCellType.attrs,
+          directiveCellType,
         ));
 
         results = mergeConfigs(results, innerHandler.results);

src/core/handlers/include.ts

@@ -17,7 +17,12 @@ import {
 import { dirname, join, normalize, relative } from "path/mod.ts";
 import { encodeMetadata } from "../encode-metadata.ts";
 import { rangedLines } from "../lib/ranged-text.ts";
-import { isDirectiveTag } from "../lib/parse-directive-tag.ts";
+import {
+  getShortcodeNamedParams,
+  getShortcodeUnnamedParams,
+  isBlockShortcode,
+} from "../lib/parse-shortcode.ts";
+import { DirectiveCell } from "../lib/break-quarto-md-types.ts";
 
 const includeHandler: LanguageHandler = {
   ...baseHandler,
@@ -29,7 +34,7 @@ const includeHandler: LanguageHandler = {
 
   directive(
     handlerContext: LanguageCellHandlerContext,
-    options: Record<string, string>,
+    directive: DirectiveCell,
   ) {
     const sourceDir = dirname(handlerContext.options.source);
     const retrievedFiles: string[] = [handlerContext.options.source];
@@ -94,20 +99,24 @@ const includeHandler: LanguageHandler = {
 
       let rangeStart = 0;
       for (const { substring, range } of rangedLines(includeSrc.value)) {
-        const m = isDirectiveTag(substring);
+        const m = isBlockShortcode(substring);
         if (m && m.name.toLocaleLowerCase() === "include") {
           textFragments.push(
             mappedString(includeSrc, [{ start: rangeStart, end: range.start }]),
           );
           rangeStart = range.end;
-          if (typeof m.attributes.file !== "string") {
-            throw new Error("Include directive needs attribute `file`");
+          const params = getShortcodeUnnamedParams(m);
+          const options = getShortcodeNamedParams(m);
+          if (params.length === 0) {
+            throw new Error("Include directive needs file parameter");
           }
-          const fixup = m.attributes.fixup === undefined
+          const file = params[0];
+          const fixup = options.fixup === undefined
             ? undefined
-            : ((m.attributes.fixup as string).toLocaleLowerCase() !== "false");
+            : (options.fixup.toLocaleLowerCase() !== "false");
+
           retrieveInclude(
-            join(...[...retrievedDirectories, m.attributes.file]),
+            join(...[...retrievedDirectories, file]),
             fixup,
           );
         }
@@ -128,17 +137,16 @@ const includeHandler: LanguageHandler = {
       addFixup(filename);
     };
 
-    const fileName = options?.["file"];
-    if (fileName === undefined) {
-      throw new Error("Include directive needs attribute `file`");
+    const params = getShortcodeUnnamedParams(directive);
+    const options = getShortcodeNamedParams(directive);
+    if (params.length === 0) {
+      throw new Error("Include directive needs filename as a parameter");
     }
-
-    const includeName = join(sourceDir, fileName as string);
+    const includeName = join(sourceDir, params[0]);
 
     const fixup = options.fixup === undefined
       ? undefined
-      : ((typeof options.fixup === "string") &&
-        (options.fixup.toLocaleLowerCase() !== "false"));
+      : (options.fixup.toLocaleLowerCase() !== "false");
 
     retrieveInclude(includeName, fixup);
 

src/core/handlers/pagebreak.ts

@@ -7,6 +7,7 @@
 
 import { LanguageCellHandlerContext, LanguageHandler } from "./types.ts";
 import { baseHandler, install } from "./base.ts";
+import { DirectiveCell } from "../lib/break-quarto-md-types.ts";
 
 const includeHandler: LanguageHandler = {
   ...baseHandler,
@@ -17,7 +18,7 @@ const includeHandler: LanguageHandler = {
 
   directive(
     _handlerContext: LanguageCellHandlerContext,
-    _options: Record<string, string>,
+    _directive: DirectiveCell,
   ) {
     return "\n\n\\pagebreak\n\n";
   },

src/core/handlers/types.ts

@@ -5,7 +5,7 @@ import {
 } from "../../config/constants.ts";
 import { DependencyFile, Format, FormatExtras } from "../../config/types.ts";
 import { PandocIncludes } from "../../execute/types.ts";
-import { QuartoMdCell } from "../lib/break-quarto-md-types.ts";
+import { DirectiveCell, QuartoMdCell } from "../lib/break-quarto-md-types.ts";
 import { EitherString, MappedString } from "../lib/text-types.ts";
 import { ConcreteSchema } from "../lib/yaml-schema/types.ts";
 import { TempContext } from "../temp-types.ts";
@@ -53,7 +53,7 @@ export interface LanguageHandler {
 
   directive?: (
     handlerContext: LanguageCellHandlerContext,
-    options: Record<string, string>,
+    directiveCell: DirectiveCell,
   ) => EitherString;
 
   comment?: LanguageComment;

src/core/lib/break-quarto-md-types.ts

@@ -15,8 +15,8 @@ export interface CodeCellType {
 
 export interface DirectiveCell {
   language: "_directive";
-  tag: string;
-  attrs: Record<string, string>;
+  name: string;
+  params: { name?: string; value: string }[];
 }
 
 export interface QuartoMdCell {

src/core/lib/break-quarto-md.ts

@@ -14,12 +14,8 @@ import { asMappedString, EitherString, mappedString } from "./mapped-text.ts";
 
 import { partitionCellOptionsMapped } from "./partition-cell-options.ts";
 
-import {
-  DirectiveCell,
-  QuartoMdCell,
-  QuartoMdChunks,
-} from "./break-quarto-md-types.ts";
-import { isDirectiveTag } from "./parse-directive-tag.ts";
+import { QuartoMdCell, QuartoMdChunks } from "./break-quarto-md-types.ts";
+import { isBlockShortcode } from "./parse-shortcode.ts";
 
 export type { QuartoMdCell, QuartoMdChunks } from "./break-quarto-md-types.ts";
 
@@ -46,8 +42,13 @@ export async function breakQuartoMd(
   const delimitMathBlockRegEx = /^\$\$/;
 
   let language = ""; // current language block
-  let tagName = "";
-  let tagOptions: Record<string, string> = {}; // tag options needs to be a stack to remember the options as we close the tag
+  let directiveParams: {
+    name: string;
+    params: {
+      name?: string;
+      value: string;
+    }[];
+  } | undefined = undefined;
   let cellStartLine = 0;
 
   // line buffer
@@ -87,8 +88,8 @@ export async function breakQuartoMd(
         ) {
           return {
             language: "_directive",
-            tag: tagName,
-            attrs: tagOptions,
+            name: directiveParams!.name,
+            params: directiveParams!.params,
           };
         } else {
           return cell_type;
@@ -142,8 +143,6 @@ export async function breakQuartoMd(
       } else if (cell_type === "directive") {
         // directives only carry tag source in sourceVerbatim, analogously to code
         cell.source = mappedString(src, mappedChunks.slice(1, -1));
-        // directives carry options in cell_type, use that
-        cell.options = (cell.cell_type as DirectiveCell).attrs;
       }
       // if the source is empty then don't add it
       if (
@@ -172,11 +171,11 @@ export async function breakQuartoMd(
 
   for (let i = 0; i < srcLines.length; ++i) {
     const line = srcLines[i];
-    const directiveMatch = isDirectiveTag(line.substring);
+    const directiveMatch = isBlockShortcode(line.substring);
     // yaml front matter
     if (
       yamlRegEx.test(line.substring) && !inCodeCell && !inCode &&
-      !inMathBlock && tagName.length === 0
+      !inMathBlock
     ) {
       if (inYaml) {
         lineBuffer.push(line);
@@ -190,8 +189,7 @@ export async function breakQuartoMd(
     } // found empty directive
     else if (inPlainText() && directiveMatch) {
       await flushLineBuffer("markdown", i);
-      tagName = directiveMatch.name;
-      tagOptions = directiveMatch.attributes;
+      directiveParams = directiveMatch;
       lineBuffer.push(line);
       await flushLineBuffer("directive", i);
     } // begin code cell: ^```python
@@ -228,7 +226,7 @@ export async function breakQuartoMd(
         lineBuffer.push(line);
         await flushLineBuffer("math", i);
       } else {
-        if (inYaml || inCode || inCodeCell || tagName.length > 0) {
+        if (inYaml || inCode || inCodeCell) {
           // TODO signal a parse error?
           // for now, we just skip.
         } else {