mdeval 1.0.0 → 1.1.0

package/README.md

@@ -26,7 +26,7 @@ const pkg = JSON.parse(await fs.readFile('package.json', 'utf8'));
 -->
 ```
 
-Full Node.js, ESM imports, and top-level `await` are supported.
+Full Node.js, ESM imports, top-level `await`, and shell commands via [`$`](https://google.github.io/zx/) are supported.
 
 A **value marker** is where the result appears. It starts with `<!--mdeval ` (with a space) followed by a JavaScript expression:
 
@@ -54,6 +54,14 @@ The file is updated in-place. You can pass multiple files at once: `mdeval READM
 
   In large documents, this IIFE pattern lets you keep logic next to the marker it serves instead of in a distant script block.
 
+- Marker expressions are **auto-awaited** — promises resolve automatically, so you can use `fetch()` or any async API directly in a marker without wrapping it in a script block.
+
+- **`$`** from [zx](https://google.github.io/zx/) is available as a global — run shell commands directly in markers:
+
+  ```markdown
+  <!--mdeval $`git branch --show-current`-->main<!--/mdeval-->
+  ```
+
 - If your value starts with a heading, list, or other block element, wrap it with **`block()`** so it renders on its own line. `block()` is a global helper that adds newlines before and after the value.
 
 - You can **import from other `.md` files**. Only the script blocks are executed — no markers are processed:
@@ -81,9 +89,13 @@ The file is updated in-place. You can pass multiple files at once: `mdeval READM
 ```markdown
 <!--mdeval
 import { table, bold, link } from 'md-pen';
-const deps = [['cleye', '^2.3.0'], ['md-pen', '^0.0.2']];
-const depsTable = table(deps.map(([name, v]) => [
-  link(`https://npm.im/${name}`, bold(name)), v
+const deps = [
+  ['cleye', '^2.3.0'],
+  ['md-pen', '^0.0.2'],
+];
+const depsTable = table(deps.map(([name, version]) => [
+  link(`https://npm.im/${name}`, bold(name)),
+  version,
 ]));
 -->
 
@@ -98,3 +110,7 @@ const depsTable = table(deps.map(([name, v]) => [
 ## Agent Skills
 
 This package ships with a built-in [agent skill](./skills/mdeval/SKILL.md) for AI coding assistants. Set up [`skills-npm`](https://github.com/antfu/skills-npm) to automatically discover it.
+
+## Related
+
+- [comment-mark](https://github.com/privatenumber/comment-mark) — Same idea of using HTML comment placeholders, but you write the script externally and pass values in via a JavaScript API. Useful when you want to keep the logic separate from the Markdown.

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-var h=Object.defineProperty;var a=(r,o)=>h(r,"name",{value:o,configurable:!0});import{register as g}from"node:module";import u from"node:fs/promises";import w from"node:path";import{cli as E}from"cleye";import{pathToFileURL as y}from"node:url";import{p as M,b as $,E as R,M as b,C,a as S}from"./parse-markdown-ChGEvmW3.mjs";import"md4x";const k=a(r=>{if(r==null)throw new Error(`Cannot interpolate ${r} \u2014 this is likely a bug in your script`);return typeof r=="string"?r:typeof r=="object"?JSON.stringify(r):String(r)},"coerceValue"),v=a(async(r,o)=>{const{markers:e}=M(r);if(e.length===0)return r;const n=await import(y(o).href),f=$(e),m=new Map,d=a((t,l)=>{const i=m.get(t);if(i!==void 0)return i;const s=k(n[`${R}${t}`]);if(s.includes(b)||s.includes(`${C}
-`)||s.includes(S))throw new Error(`Expression "${l}" produced a value containing mdeval comment syntax, which would corrupt the document on re-parse`);return m.set(t,s),s},"resolveValue"),c=[];let p=0;for(const t of e){const l=f.get(t.expression),i=d(l,t.expression);c.push(r.slice(p,t.contentStart),i),p=t.contentEnd}return c.push(r.slice(p)),c.join("")},"processSource");g("#md-loader",import.meta.url),globalThis.block=r=>`
+var d=Object.defineProperty;var p=(r,o)=>d(r,"name",{value:o,configurable:!0});import{register as u}from"node:module";import l from"node:fs/promises";import g from"node:path";import{cli as h}from"cleye";import{$ as w}from"zx";import{pathToFileURL as E}from"node:url";import{p as y,b as $,E as b,M as x,C as M,a as S}from"./parse-markdown-ChGEvmW3.mjs";import"md4x";const P=p(r=>{if(r==null)throw new Error(`Cannot interpolate ${r} \u2014 this is likely a bug in your script`);return typeof r=="string"?r:typeof r=="object"?Symbol.toPrimitive in r?String(r):JSON.stringify(r):String(r)},"coerceValue"),R=p(async(r,o)=>{const{markers:t}=y(r);if(t.length===0)return r;const s=await import(E(o).href),m=$(t),f=await Promise.all(Array.from(m).map(async([e,c])=>{const i=P(await s[`${b}${c}`]);if(i.includes(x)||i.includes(`${M}
+`)||i.includes(S))throw new Error(`Expression "${e}" produced a value containing mdeval comment syntax, which would corrupt the document on re-parse`);return i})),n=[];let a=0;for(const e of t){const c=m.get(e.expression);n.push(r.slice(a,e.contentStart),f[c]),a=e.contentEnd}return n.push(r.slice(a)),n.join("")},"processSource");u("#md-loader",import.meta.url),globalThis.block=r=>`
 ${String(r)}
-`;const x=E({name:"mdeval",parameters:["<files...>"]});await Promise.all(x._.files.map(async r=>{try{const o=w.resolve(r),e=await u.readFile(o,"utf8"),n=await v(e,o);n!==e&&(await u.writeFile(o,n,"utf8"),console.log(`Updated: ${r}`))}catch(o){console.error(`Error processing ${r}:`,o instanceof Error?o.message:o),process.exitCode=1}}));
+`,globalThis.$=w;const T=h({name:"mdeval",parameters:["<files...>"]});await Promise.all(T._.files.map(async r=>{try{const o=g.resolve(r),t=await l.readFile(o,"utf8"),s=await R(t,o);s!==t&&(await l.writeFile(o,s,"utf8"),console.log(`Updated: ${r}`))}catch(o){console.error(`Error processing ${r}:`,o instanceof Error?o.message:o),process.exitCode=1}}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdeval",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Evaluate JavaScript in markdown HTML comments and interpolate results in-place",
   "keywords": [
     "markdown",
@@ -29,6 +29,7 @@
   },
   "dependencies": {
     "cleye": "^2.3.0",
-    "md4x": "^0.0.25"
+    "md4x": "^0.0.25",
+    "zx": "8.8.5-lite"
   }
 }