mystmd 1.1.53__tar.gz → 1.1.54__tar.gz

{mystmd-1.1.53 → mystmd-1.1.54}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mystmd
-Version: 1.1.53
+Version: 1.1.54
 Summary: Command line tools for MyST Markdown
 Project-URL: Homepage, https://github.com/executablebooks/mystmd
 Project-URL: Bug Tracker, https://github.com/executablebooks/mystmd/issues

{mystmd-1.1.53 → mystmd-1.1.54}/_package.json

@@ -1,6 +1,6 @@
 {
   "name": "mystmd",
-  "version": "1.1.53",
+  "version": "1.1.54",
   "description": "Command line tools for MyST Markdown",
   "author": "Rowan Cockett <rowan@curvenote.com>",
   "license": "MIT",
@@ -45,6 +45,6 @@
     "commander": "^10.0.1",
     "core-js": "^3.31.1",
     "js-yaml": "^4.1.0",
-    "myst-cli": "^1.1.53"
+    "myst-cli": "^1.1.54"
   }
 }

{mystmd-1.1.53 → mystmd-1.1.54}/src/mystmd_py/myst.cjs

@@ -193279,7 +193279,7 @@ var {
 } = import_index.default;
 
 // src/version.ts
-var version = "1.1.53";
+var version = "1.1.54";
 var version_default = version;
 
 // ../myst-cli/dist/build/build.js
@@ -194861,6 +194861,8 @@ var FRONTMATTER_ALIASES = {
   part: "parts",
   ack: "acknowledgments",
   acknowledgements: "acknowledgments",
+  acknowledgment: "acknowledgments",
+  acknowledgement: "acknowledgments",
   availability: "data_availability",
   dataAvailability: "data_availability",
   "data-availability": "data_availability",
@@ -198266,7 +198268,7 @@ function validatePageFrontmatterKeys(value, opts) {
   const partsOptions = incrementOptions("parts", opts);
   let parts;
   if (defined(value.parts)) {
-    parts = validateObject(value.parts, partsOptions);
+    parts = validateObjectKeys(value.parts, { optional: PAGE_KNOWN_PARTS, alias: FRONTMATTER_ALIASES }, { keepExtraKeys: true, suppressWarnings: true, ...partsOptions });
   }
   PAGE_KNOWN_PARTS.forEach((partKey) => {
     if (defined(value[partKey])) {
@@ -199958,7 +199960,21 @@ function coercePart(part) {
   if (!part) {
     return [];
   }
-  return typeof part === "string" ? [part.toLowerCase()] : part.map((s5) => s5.toLowerCase());
+  if (typeof part === "string")
+    return coercePart([part]);
+  const parts = [];
+  part.map((p5) => p5.toLowerCase()).forEach((p5) => {
+    parts.push(p5);
+    Object.entries(FRONTMATTER_ALIASES).forEach(([alias, value]) => {
+      if (p5 === alias || p5 === value) {
+        if (!parts.includes(value))
+          parts.unshift(value);
+        if (!parts.includes(alias))
+          parts.push(alias);
+      }
+    });
+  });
+  return parts;
 }
 function selectBlockParts(tree, part) {
   const parts = coercePart(part);
@@ -202921,9 +202937,55 @@ var jsYaml = {
 };
 var js_yaml_default = jsYaml;
 
+// ../myst-config/dist/errorRules/validators.js
+var ERROR_RULE_KEY_OBJECT = {
+  required: ["id"],
+  optional: ["severity", "keys"],
+  alias: {
+    rule: "id",
+    key: "keys"
+  }
+};
+function validateErrorRule(input3, opts) {
+  if (typeof input3 === "string") {
+    input3 = { id: input3 };
+  }
+  const value = validateObjectKeys(input3, ERROR_RULE_KEY_OBJECT, {
+    ...opts
+  });
+  if (value === void 0)
+    return void 0;
+  const id = validateString(value.id, incrementOptions("id", opts));
+  const severity = validateChoice(value.severity || "ignore", {
+    ...incrementOptions("severity", opts),
+    choices: ["ignore", "warn", "error"]
+  });
+  if (!id || !severity)
+    return void 0;
+  const output2 = { id, severity };
+  if (!defined(value.keys))
+    return [output2];
+  const keyList = validateList(value.keys, { ...incrementOptions("keys", opts), coerce: true }, (key2, ind) => {
+    return validateString(key2, incrementOptions(`keys.${ind}`, opts));
+  });
+  if (!keyList)
+    return void 0;
+  return keyList.map((key2) => ({ ...output2, key: key2 }));
+}
+function validateErrorRuleList(input3, opts) {
+  if (input3 === void 0)
+    return void 0;
+  const output2 = validateList(input3, { coerce: true, ...incrementOptions("error_rules", opts) }, (exp, ind) => {
+    return validateErrorRule(exp, incrementOptions(`error_rules.${ind}`, opts));
+  });
+  if (!output2)
+    return void 0;
+  return output2.flat();
+}
+
 // ../myst-config/dist/project/validators.js
 var PROJECT_CONFIG_KEYS = {
-  optional: ["remote", "index", "exclude", "plugins", ...PROJECT_FRONTMATTER_KEYS],
+  optional: ["remote", "index", "exclude", "plugins", "error_rules", ...PROJECT_FRONTMATTER_KEYS],
   alias: FRONTMATTER_ALIASES
 };
 function validateProjectConfigKeys(value, opts) {
@@ -202944,6 +203006,11 @@ function validateProjectConfigKeys(value, opts) {
       return validateString(file, incrementOptions(`plugins.${index4}`, opts));
     });
   }
+  if (defined(value.error_rules)) {
+    const error_rules = validateErrorRuleList(value.error_rules, opts);
+    if (error_rules)
+      output2.error_rules = error_rules;
+  }
   return output2;
 }
 function validateProjectConfig(input3, opts) {
@@ -236414,6 +236481,7 @@ var SUBFIGURE_TYPES = [
   "block",
   "container",
   "image",
+  "mermaid",
   "iframe",
   "table",
   "code",
@@ -239600,8 +239668,8 @@ var rootReducer = combineReducers({
 });
 
 // ../myst-cli/dist/utils/addWarningForFile.js
-function addWarningForFile(session, file, message, kind = "warn", opts) {
-  var _a6, _b, _c;
+function addWarningForFile(session, file, message, severity = "warn", opts) {
+  var _a6, _b, _c, _d2, _e;
   const line2 = ((_a6 = opts === null || opts === void 0 ? void 0 : opts.position) === null || _a6 === void 0 ? void 0 : _a6.start.line) ? `:${opts === null || opts === void 0 ? void 0 : opts.position.start.line}` : "";
   const column = ((_b = opts === null || opts === void 0 ? void 0 : opts.position) === null || _b === void 0 ? void 0 : _b.start.column) && ((_c = opts === null || opts === void 0 ? void 0 : opts.position) === null || _c === void 0 ? void 0 : _c.start.column) > 1 ? `:${opts === null || opts === void 0 ? void 0 : opts.position.start.column}` : "";
   const note = (opts === null || opts === void 0 ? void 0 : opts.note) ? `
@@ -239611,7 +239679,23 @@ function addWarningForFile(session, file, message, kind = "warn", opts) {
 `) : "";
   const prefix2 = file ? `${file}${line2}${column} ` : "";
   const formatted = `${message}${note}${url}`;
-  switch (kind) {
+  if (opts === null || opts === void 0 ? void 0 : opts.ruleId) {
+    const config2 = selectCurrentProjectConfig(session.store.getState());
+    const handler = (_d2 = config2 === null || config2 === void 0 ? void 0 : config2.error_rules) === null || _d2 === void 0 ? void 0 : _d2.find((rule) => {
+      if (rule.key) {
+        return rule.id === opts.ruleId && rule.key === opts.key;
+      }
+      return rule.id === opts.ruleId;
+    });
+    if (handler) {
+      if (handler.severity === "ignore") {
+        session.log.debug(`${prefix2}${formatted}`);
+        return;
+      }
+      severity = (_e = handler.severity) !== null && _e !== void 0 ? _e : severity;
+    }
+  }
+  switch (severity) {
     case "info":
       session.log.info(`\u2139\uFE0F  ${prefix2}${formatted}`);
       break;
@@ -239623,11 +239707,14 @@ function addWarningForFile(session, file, message, kind = "warn", opts) {
       session.log.warn(`\u26A0\uFE0F  ${prefix2}${formatted}`);
       break;
   }
+  if (opts === null || opts === void 0 ? void 0 : opts.ruleId) {
+    session.log.debug(`To suppress this message, add rule: "${opts.ruleId}"${opts.key ? ` with key: "${opts.key}"` : ""} to "error_rules" in your project config`);
+  }
   if (file) {
     session.store.dispatch(warnings.actions.addWarning({
       file,
       message,
-      kind,
+      kind: severity,
       url: opts === null || opts === void 0 ? void 0 : opts.url,
       note: opts === null || opts === void 0 ? void 0 : opts.note,
       position: opts === null || opts === void 0 ? void 0 : opts.position,
@@ -282591,7 +282678,8 @@ var defaultMdast = {
         args: (_a6 = t2.meta) === null || _a6 === void 0 ? void 0 : _a6.arg,
         options: (_b = t2.meta) === null || _b === void 0 ? void 0 : _b.options,
         value: t2.content || void 0,
-        tight: ((_c = t2.meta) === null || _c === void 0 ? void 0 : _c.tight) || void 0
+        tight: ((_c = t2.meta) === null || _c === void 0 ? void 0 : _c.tight) || void 0,
+        processed: false
       };
     }
   },
@@ -282629,7 +282717,8 @@ var defaultMdast = {
     getAttrs(t2) {
       return {
         name: t2.info,
-        value: t2.content
+        value: t2.content,
+        processed: false
       };
     }
   },
@@ -282852,8 +282941,9 @@ function applyRoles(tree, specs, vfile2) {
       }
     });
   });
-  const nodes = selectAll("mystRole", tree);
+  const nodes = selectAll("mystRole[processed=false]", tree);
   nodes.forEach((node3) => {
+    delete node3.processed;
     const { name: name3 } = node3;
     const spec = specLookup[name3];
     if (!spec) {
@@ -282896,7 +282986,7 @@ function applyRoles(tree, specs, vfile2) {
 }
 
 // ../myst-parser/dist/directives.js
-function applyDirectives(tree, specs, vfile2) {
+function applyDirectives(tree, specs, vfile2, ctx) {
   const specLookup = {};
   specs.forEach((spec) => {
     const names = [spec.name];
@@ -282913,9 +283003,10 @@ function applyDirectives(tree, specs, vfile2) {
       }
     });
   });
-  const nodes = selectAll("mystDirective", tree);
+  const nodes = selectAll("mystDirective[processed=false]", tree);
   nodes.forEach((node3) => {
     var _a6, _b, _c, _d2;
+    delete node3.processed;
     const { name: name3 } = node3;
     const spec = specLookup[name3];
     if (!spec) {
@@ -283042,7 +283133,10 @@ ${node3.value}` : "";
     if (validate5) {
       data = validate5(data, vfile2);
     }
-    node3.children = run(data, vfile2);
+    node3.children = run(data, vfile2, {
+      // Implement a parseMyst function that accepts _relative_ line numbers
+      parseMyst: (source2, offset = 0) => ctx.parseMyst(source2, offset + node3.position.start.line)
+    });
   });
 }
 
@@ -283120,7 +283214,18 @@ function mystParse(content3, opts) {
   const parsedOpts = parseOptions(opts);
   const tokenizer = createTokenizer(parsedOpts);
   const tree = tokensToMyst(content3, tokenizer.parse(content3, { vfile: vfile2 }), parsedOpts.mdast);
-  applyDirectives(tree, parsedOpts.directives, parsedOpts.vfile);
+  applyDirectives(tree, parsedOpts.directives, parsedOpts.vfile, {
+    parseMyst: (source2, offset = 0) => {
+      const mdast2 = mystParse(source2, opts);
+      visit(mdast2, (node3) => {
+        if (node3.position) {
+          node3.position.start.line += offset;
+          node3.position.end.line += offset;
+        }
+      });
+      return mdast2;
+    }
+  });
   applyRoles(tree, parsedOpts.roles, parsedOpts.vfile);
   return tree;
 }
@@ -283668,7 +283773,7 @@ var import_node_path17 = __toESM(require("path"), 1);
 var import_nbtx = __toESM(require_cjs2(), 1);
 
 // ../myst-cli/dist/version.js
-var version2 = "1.1.53";
+var version2 = "1.1.54";
 var version_default2 = version2;
 
 // ../myst-cli/dist/utils/headers.js
@@ -295803,7 +295908,8 @@ async function checkLinksTransform(session, file, mdast2) {
     const status = check2.status ? ` (${check2.status}, ${check2.statusText})` : "";
     addWarningForFile(session, file, `Link for "${url}" did not resolve.${status}`, "error", {
       position: position6,
-      ruleId: RuleId.linkResolves
+      ruleId: RuleId.linkResolves,
+      key: url
     });
     return url;
   })));
@@ -296247,7 +296353,7 @@ async function kernelExecutionTransform(tree, vfile2, opts) {
     } else {
       let sessionConnection;
       const sessionOpts = {
-        path: vfile2.path,
+        path: import_node_path36.default.relative(opts.basePath, vfile2.path),
         type: "notebook",
         name: import_node_path36.default.basename(vfile2.path),
         kernel: {
@@ -296812,12 +296918,16 @@ async function launchJupyterServer(contentPath, log) {
   const pythonPath = import_which3.default.sync("python");
   const proc2 = (0, import_node_child_process.spawn)(pythonPath, ["-m", "jupyter_server", "--ServerApp.root_dir", contentPath]);
   const reader = proc2.stderr;
+  let timerID;
   const settings = await new Promise((resolve7, reject) => {
-    const id = setTimeout(() => {
-      log.error(`\u{1FA90} ${source_default3.redBright("Jupyter server did not respond")}
-   ${source_default3.dim(url)}`);
+    timerID = setTimeout(() => {
+      log.error(`\u{1FA90} ${source_default3.redBright("Jupyter server did not respond")}`);
       reject();
     }, 2e4);
+    proc2.on("exit", () => {
+      log.error(`\u{1FA90} ${source_default3.redBright("Jupyter server did not start")}`);
+      reject();
+    });
     reader.on("data", (buf) => {
       const data = buf.toString();
       const match3 = data.match(/([^\s]*?)\?token=([^\s]*)/);
@@ -296825,7 +296935,6 @@ async function launchJupyterServer(contentPath, log) {
         return;
       }
       const [, addr, token] = match3;
-      clearTimeout(id);
       resolve7({
         baseUrl: addr,
         token
@@ -296833,7 +296942,13 @@ async function launchJupyterServer(contentPath, log) {
     });
   }).finally(
     // Don't keep listening to messages
-    () => reader.removeAllListeners("data")
+    () => {
+      reader.removeAllListeners("data");
+      proc2.removeAllListeners("exit");
+      if (timerID !== void 0) {
+        clearTimeout(timerID);
+      }
+    }
   );
   const url = `${settings.baseUrl}?token=${settings.token}`;
   log.info(`\u{1FA90} ${source_default3.greenBright("Jupyter server started")}
@@ -296969,6 +297084,7 @@ async function transformMdast(session, opts) {
   if (execute) {
     const cachePath = import_node_path38.default.join(session.buildPath(), "execute");
     await kernelExecutionTransform(mdast2, vfile2, {
+      basePath: session.sourcePath(),
       cache: new LocalDiskCache(cachePath),
       sessionFactory: () => session.jupyterSessionManager(),
       frontmatter,
@@ -297380,7 +297496,8 @@ ${page.file}
     if (hasWarnings[0] > 0) {
       const pluralE = hasWarnings[0] > 1 ? "s" : "";
       const pluralW = hasWarnings[1] > 1 ? "s" : "";
-      throw new Error(`Site has ${hasWarnings[0]} error${pluralE} and ${hasWarnings[1]} warning${pluralW}, stopping build.`);
+      session.log.error(`Site has ${hasWarnings[0]} error${pluralE} and ${hasWarnings[1]} warning${pluralW}, stopping build.`);
+      process.exit(1);
     }
   }
   if ((_b = opts === null || opts === void 0 ? void 0 : opts.writeFiles) !== null && _b !== void 0 ? _b : true) {
@@ -297714,7 +297831,7 @@ async function currentSiteRoutes(session, host, baseurl, opts) {
         };
       }),
       // Download other assets
-      ...["robots.txt", "sitemap.xml", "sitemap_style.xsl"].map((asset) => ({
+      ...["favicon.ico", "robots.txt"].map((asset) => ({
         url: `${host}/${asset}`,
         path: asset
       }))
@@ -312418,6 +312535,7 @@ var SITE_CONFIG = `site:
   template: book-theme
   # title:
   # options:
+  #   favicon: favicon.ico
   #   logo: site_logo.png
   nav: []
   actions: