support space between # and | for yaml options

Author: jjallaire

src/core/handlers/base.ts

@@ -28,7 +28,7 @@ import {
 } from "../lib/mapped-text.ts";
 import {
   addLanguageComment,
-  optionCommentPrefixFromLanguage,
+  optionCommentPatternFromLanguage,
 } from "../lib/partition-cell-options.ts";
 import { ConcreteSchema } from "../lib/yaml-schema/types.ts";
 import {
@@ -516,10 +516,11 @@ export const baseHandler: LanguageHandler = {
     // split content into front matter vs input
     const contentLines = mappedLines(cell.sourceWithYaml!, true);
     const frontMatterLines: MappedString[] = [];
-    const comment: string = optionCommentPrefixFromLanguage(this.languageName);
+    const commentPattern = optionCommentPatternFromLanguage(this.languageName);
     let inputIndex = 0;
     for (const contentLine of contentLines) {
-      if (contentLine.value.startsWith(comment)) {
+      const commentMatch = contentLine.value.match(commentPattern);
+      if (commentMatch) {
         if (contentLine.value.indexOf("echo: fenced") === -1) {
           frontMatterLines.push(contentLine);
         }

src/core/lib/partition-cell-options.ts

@@ -41,16 +41,17 @@ export function partitionCellOptions(
   source: string[],
 ) {
   const commentChars = langCommentChars(language);
-  const optionPrefix = optionCommentPrefix(commentChars[0]);
+  const optionPattern = optionCommentPattern(commentChars[0]);
   const optionSuffix = commentChars[1] || "";
 
   // find the yaml lines
   const optionsSource: string[] = [];
   const yamlLines: string[] = [];
   for (const line of source) {
-    if (line.startsWith(optionPrefix)) {
+    const optionMatch = line.match(optionPattern);
+    if (optionMatch) {
       if (!optionSuffix || line.trimRight().endsWith(optionSuffix)) {
-        let yamlOption = line.substring(optionPrefix.length);
+        let yamlOption = line.substring(optionMatch[0].length);
         if (optionSuffix) {
           yamlOption = yamlOption.trimRight();
           yamlOption = yamlOption.substring(
@@ -150,7 +151,7 @@ export function partitionCellOptionsText(
   source: MappedString,
 ) {
   const commentChars = langCommentChars(language);
-  const optionPrefix = optionCommentPrefix(commentChars[0]);
+  const optionPattern = optionCommentPattern(commentChars[0]);
   const optionSuffix = commentChars[1] || "";
 
   // find the yaml lines
@@ -159,22 +160,24 @@ export function partitionCellOptionsText(
 
   let endOfYaml = 0;
   for (const line of rangedLines(source.value, true)) {
-    if (line.substring.startsWith(optionPrefix)) {
+    const optionMatch = line.substring.match(optionPattern);
+    if (optionMatch) {
       if (!optionSuffix || line.substring.trimRight().endsWith(optionSuffix)) {
-        let yamlOption = line.substring.substring(optionPrefix.length);
+        let yamlOption = line.substring.substring(optionMatch[0].length);
         if (optionSuffix) {
           yamlOption = yamlOption.trimRight();
           yamlOption = yamlOption.substring(
             0,
             yamlOption.length - optionSuffix.length,
           );
         }
-        endOfYaml = line.range.start + optionPrefix.length + yamlOption.length -
+        endOfYaml = line.range.start + optionMatch[0].length +
+          yamlOption.length -
           optionSuffix.length;
         const rangedYamlOption = {
           substring: yamlOption,
           range: {
-            start: line.range.start + optionPrefix.length,
+            start: line.range.start + optionMatch[0].length,
             end: endOfYaml,
           },
         };
@@ -252,8 +255,8 @@ export function langCommentChars(lang: string): string[] {
     return chars;
   }
 }
-export function optionCommentPrefix(comment: string) {
-  return comment + "| ";
+export function optionCommentPattern(comment: string) {
+  return new RegExp("^" + comment + "\\s*\\| ");
 }
 
 // FIXME this is an awkward spot for this particular entry point
@@ -264,8 +267,8 @@ export function addLanguageComment(
   kLangCommentChars[language] = comment;
 }
 
-export function optionCommentPrefixFromLanguage(language: string) {
-  return optionCommentPrefix(langCommentChars(language)[0]);
+export function optionCommentPatternFromLanguage(language: string) {
+  return optionCommentPattern(langCommentChars(language)[0]);
 }
 
 export const kLangCommentChars: Record<string, string | [string, string]> = {

src/resources/jupyter/notebook.py

@@ -1,6 +1,7 @@
 # pyright: reportMissingImports=false
 
 import os
+import re
 import atexit
 import glob
 import sys
@@ -464,15 +465,16 @@ def nb_cell_yaml_options(lang, cell):
 def nb_cell_yaml_lines(lang, source):
    # determine language comment chars
    comment_chars = nb_language_comment_chars(lang)
-   option_prefix = comment_chars[0] + "| "
+   option_pattern = "^" + comment_chars[0] + "\\s*\\| "
    option_suffix = comment_chars[1] if len(comment_chars) > 1 else None
 
    # go through the lines until we've found all of the yaml
    yaml_lines = []
    for line in source.splitlines():
-      if line.startswith(option_prefix):
+      option_match = re.match(option_pattern, line) 
+      if option_match:
          if (not option_suffix) or line.rstrip().endswith(option_suffix):
-            yaml_option = line[len(option_prefix):]
+            yaml_option = line[len(option_match.group()):]
             if (option_suffix):
                yaml_option = yaml_option.rstrip()[:-len(option_suffix)]
             yaml_lines.append(yaml_option)