mystmd 1.3.5__py3-none-any.whl → 1.3.6__py3-none-any.whl

{mystmd-1.3.5.dist-info → mystmd-1.3.6.dist-info}/METADATA

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

mystmd-1.3.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+mystmd_py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mystmd_py/main.py,sha256=BaPniv8thshA5DKIBoq2huFUs1Jb0zFkMxN2UIHXUkw,1511
+mystmd_py/myst.cjs,sha256=FxEBSPoYyXHIws693tzyrUqdWGKTKrIeWQN38ZQSPcc,13103855
+mystmd-1.3.6.dist-info/METADATA,sha256=edCiMgoJBMsYUhBcw_gfIGm94Cwfwno7-zpdcXdxLMU,2954
+mystmd-1.3.6.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+mystmd-1.3.6.dist-info/entry_points.txt,sha256=eC2ol2gqS2q5E-ktkMrBSvV0tckGUcNGS-c4hEQ-_V4,45
+mystmd-1.3.6.dist-info/licenses/LICENSE,sha256=4BcikqvulW5nh_MxaocO-lC7ydIX23dMbcqtNTUSxr4,1082
+mystmd-1.3.6.dist-info/RECORD,,

mystmd_py/myst.cjs

@@ -193562,7 +193562,7 @@ var {
 } = import_index.default;
 
 // src/version.ts
-var version = "1.3.5";
+var version = "1.3.6";
 var version_default = version;
 
 // ../myst-cli/dist/build/build.js
@@ -195821,21 +195821,35 @@ function validateJupytext(input3, opts) {
 }
 
 // ../myst-frontmatter/dist/kernelspec/validators.js
-var KERNELSPEC_KEYS = ["name", "language", "display_name", "argv", "env"];
+var KERNELSPEC_KEYS = ["name", "display_name", "language", "argv", "env"];
 function validateKernelSpec(input3, opts) {
   const value = validateObjectKeys(input3, { optional: KERNELSPEC_KEYS }, opts);
   if (value === void 0)
     return void 0;
-  const output2 = {};
+  let name3;
   if (defined(value.name)) {
-    output2.name = validateString(value.name, incrementOptions("name", opts));
+    const validatedName = validateString(value.name, incrementOptions("name", opts));
+    if (validatedName === void 0)
+      return void 0;
+    name3 = validatedName;
+  } else {
+    name3 = "python3";
+    validationWarning(`"name" key is required; using '${name3}' as placeholder value`, opts);
+  }
+  let displayName;
+  if (defined(value.display_name)) {
+    const validatedDisplayName = validateString(value.display_name, incrementOptions("display_name", opts));
+    if (validatedDisplayName === void 0)
+      return void 0;
+    displayName = validatedDisplayName;
+  } else {
+    displayName = `${name3} Kernel`;
+    validationWarning(`"display_name" key is required; using '${displayName}' as placeholder value`, opts);
   }
+  const output2 = { name: name3, display_name: displayName };
   if (defined(value.language)) {
     output2.language = validateString(value.language, incrementOptions("language", opts));
   }
-  if (defined(value.display_name)) {
-    output2.display_name = validateString(value.display_name, incrementOptions("display_name", opts));
-  }
   if (defined(value.env)) {
     output2.env = validateObject(value.env, incrementOptions("env", opts));
   }
@@ -241223,9 +241237,12 @@ function addWarningForFile(session, file, message, severity = "warn", opts) {
       session.log.error(`\u26D4\uFE0F ${prefix2}${formatted}`);
       break;
     case "warn":
-    default:
       session.log.warn(`\u26A0\uFE0F  ${prefix2}${formatted}`);
       break;
+    case "debug":
+    default:
+      session.log.debug(`${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`);
@@ -285686,7 +285703,7 @@ var citeRole = {
   run(data) {
     const content3 = data.body;
     const labels = content3.split(/[,;]/).map((s5) => s5.trim());
-    const kind = data.name.startsWith("cite:p") || data.name.includes("par") ? "parenthetical" : "narrative";
+    const kind = data.name.startsWith("cite:p") || data.name.includes("par") || data.name.includes("cite:alp") ? "parenthetical" : "narrative";
     const children = labels.map((c) => {
       var _a6, _b;
       const groups = /^(?:\{([^{]*)\})?([^{]*)(?:\{([^{]*)\})?$/;
@@ -285713,6 +285730,9 @@ var citeRole = {
     if (data.name === "cite" && children.length === 1) {
       return children;
     }
+    if (data.name.includes("cite:alp")) {
+      return children;
+    }
     return [
       {
         type: "citeGroup",
@@ -289018,7 +289038,7 @@ var import_node_path15 = __toESM(require("path"), 1);
 var import_nbtx = __toESM(require_cjs2(), 1);
 
 // ../myst-cli/dist/version.js
-var version2 = "1.3.5";
+var version2 = "1.3.6";
 var version_default2 = version2;
 
 // ../myst-cli/dist/utils/headers.js
@@ -289439,7 +289459,7 @@ async function convertImageToWebp(session, image6, { quality = 80, overwrite = f
       minimumFractionDigits: 2,
       maximumFractionDigits: 2
     });
-    addWarningForFile(session, image6, `Image is too large (${inMB} MB) to convert to webp (build will be slow).`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+    addWarningForFile(session, image6, `Image is too large (${inMB} MB) to convert to webp (build will be slow).`, isGif2webpAvailable() && imageExt === ".gif" || isWebpAvailable() ? "warn" : "debug", { ruleId: RuleId.imageFormatOptimizes });
     return null;
   }
   const dirname8 = import_node_path13.default.dirname(image6);
@@ -289479,7 +289499,7 @@ imagemagick and cwebp are required
       if (!isGif2webpAvailable()) {
         addWarningForFile(session, image6, `Could not convert from image ${image6} to webp:
 gif2webp is required
-`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+`, "debug", { ruleId: RuleId.imageFormatOptimizes });
         return null;
       }
       await convertGif();
@@ -289487,7 +289507,7 @@ gif2webp is required
       if (!isWebpAvailable()) {
         addWarningForFile(session, image6, `Could not convert from image ${image6} to webp:
 cwebp is required
-`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+`, "debug", { ruleId: RuleId.imageFormatOptimizes });
         return null;
       }
       await convertImg();
@@ -302218,7 +302238,7 @@ async function evaluateExpression(kernel, expr) {
   (0, import_node_assert.default)(result !== void 0);
   return { status: result.status, result };
 }
-function buildCacheKey(nodes) {
+function buildCacheKey(kernelSpec, nodes) {
   var _a6, _b, _c;
   const hashableItems = [];
   for (const node3 of nodes) {
@@ -302237,8 +302257,7 @@ function buildCacheKey(nodes) {
       });
     }
   }
-  const hashableString = JSON.stringify(hashableItems);
-  return (0, import_node_crypto4.createHash)("md5").update(hashableString).digest("hex");
+  return (0, import_node_crypto4.createHash)("md5").update(kernelSpec.name).update(JSON.stringify(hashableItems)).digest("hex");
 }
 function isCellBlock(node3) {
   return node3.type === "block" && select("code", node3) !== null && select("output", node3) !== null;
@@ -302298,13 +302317,16 @@ function applyComputedOutputsToNodes(nodes, computedResult) {
   }
 }
 async function kernelExecutionTransform(tree, vfile2, opts) {
-  var _a6, _b, _c, _d2;
+  var _a6;
   const log = (_a6 = opts.log) !== null && _a6 !== void 0 ? _a6 : console;
+  if (opts.frontmatter.kernelspec === void 0) {
+    return fileError(vfile2, `Notebook does not declare the necessary 'kernelspec' frontmatter key required for execution`);
+  }
   const executableNodes = selectAll(`block[kind=${NotebookCell.code}],inlineExpression`, tree);
   if (executableNodes.length === 0) {
     return;
   }
-  const cacheKey = buildCacheKey(executableNodes);
+  const cacheKey = buildCacheKey(opts.frontmatter.kernelspec, executableNodes);
   let cachedResults = opts.cache.get(cacheKey);
   if (opts.ignoreCache || cachedResults === void 0) {
     log.info(`\u{1F4BF} Executing Notebook (${vfile2.path}) ${opts.ignoreCache ? "[cache ignored]" : "[no execution cache found]"}`);
@@ -302320,7 +302342,7 @@ async function kernelExecutionTransform(tree, vfile2, opts) {
         type: "notebook",
         name: import_node_path34.default.basename(vfile2.path),
         kernel: {
-          name: (_d2 = (_c = (_b = opts.frontmatter) === null || _b === void 0 ? void 0 : _b.kernelspec) === null || _c === void 0 ? void 0 : _c.name) !== null && _d2 !== void 0 ? _d2 : "python3"
+          name: opts.frontmatter.kernelspec.name
         }
       };
       await sessionManager.startNew(sessionOpts).catch((err) => {
@@ -323419,14 +323441,21 @@ ${errors4}`);
 function assertNever() {
   throw new Error("unreachable code");
 }
-function convertNoFormat(dir, data) {
-  const rootEntry = { file: (0, import_node_path59.relative)(dir, resolveExtension((0, import_node_path59.join)(dir, data.root))) };
+function maybeResolveDocument(dir, name3, session) {
+  const resolved = resolveExtension((0, import_node_path59.join)(dir, name3));
+  if (resolved) {
+    return (0, import_node_path59.relative)(dir, resolved);
+  }
+  session.log.error(`Could not find a file named ${name3} (declared in table of contents)`);
+  return name3;
+}
+function convertNoFormat(session, dir, data) {
+  const rootEntry = { file: maybeResolveDocument(dir, data.root, session) };
   const convertEntry = (item) => {
     let entry;
     if ("file" in item) {
-      const resolved = resolveExtension((0, import_node_path59.join)(dir, item.file));
       entry = {
-        file: (0, import_node_path59.relative)(dir, resolved),
+        file: maybeResolveDocument(dir, item.file, session),
         title: item.title
       };
     } else if ("url" in item) {
@@ -323543,7 +323572,7 @@ function convertArticleToNoFormat(data) {
   }
   return result;
 }
-function upgradeTOC(data) {
+function upgradeTOC(session, data) {
   const dir = (0, import_node_process6.cwd)();
   let dataNoFormat;
   if ("format" in data) {
@@ -323562,7 +323591,7 @@ function upgradeTOC(data) {
   } else {
     dataNoFormat = data;
   }
-  return convertNoFormat(dir, dataNoFormat);
+  return convertNoFormat(session, dir, dataNoFormat);
 }
 
 // ../myst-cli/dist/init/jupyter-book/syntax.js
@@ -323758,13 +323787,15 @@ async function upgradeJupyterBook(session, configFile) {
   const configContent = await import_promises4.default.readFile("_config.yml", { encoding: "utf-8" });
   const configData2 = validateJupyterBookConfig(js_yaml_default.load(configContent));
   if (defined2(configData2)) {
+    session.log.info(`Migrating Jupyter Book configuration to ${source_default.blue("myst.yml")}`);
     ({ site: config3.site, project: config3.project } = upgradeConfig(configData2));
   }
   if (await fsExists("_toc.yml")) {
     const tocContent = await import_promises4.default.readFile("_toc.yml", { encoding: "utf-8" });
     const tocData = validateSphinxExternalTOC(js_yaml_default.load(tocContent));
     if (defined2(tocData)) {
-      config3.project.toc = upgradeTOC(tocData);
+      session.log.info(`Migrating TOC to ${source_default.blue("myst.yml")}`);
+      config3.project.toc = upgradeTOC(session, tocData);
     }
   }
   await upgradeProjectSyntax(session);

mystmd-1.3.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-mystmd_py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mystmd_py/main.py,sha256=BaPniv8thshA5DKIBoq2huFUs1Jb0zFkMxN2UIHXUkw,1511
-mystmd_py/myst.cjs,sha256=5ABMC9ewfoAf0T1gHbV3DMoMv88hpUP_MtdLcA86nmY,13102599
-mystmd-1.3.5.dist-info/METADATA,sha256=XsHqRibAIZHhL_t8zqFtzRSX2zF5tH-q-8pGIFehbkY,2954
-mystmd-1.3.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-mystmd-1.3.5.dist-info/entry_points.txt,sha256=eC2ol2gqS2q5E-ktkMrBSvV0tckGUcNGS-c4hEQ-_V4,45
-mystmd-1.3.5.dist-info/licenses/LICENSE,sha256=4BcikqvulW5nh_MxaocO-lC7ydIX23dMbcqtNTUSxr4,1082
-mystmd-1.3.5.dist-info/RECORD,,