@borrowdev/docval 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lorenzo Bloedow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Borrow DocVal
+
+**Validate your documentation codeblocks at build-time.**
+
+DocVal creates an environment and executes the code in your codeblocks to make sure it works as expected.

package/dist/adapters/index.mjs

@@ -0,0 +1,21 @@
+import javascript_default from "./javascript/index.mjs";
+import jsx_default from "./jsx/index.mjs";
+import rust_default from "./rust/index.mjs";
+import tsx_default from "./tsx/index.mjs";
+import typescript_default from "./typescript/index.mjs";
+
+//#region src/adapters/index.ts
+const map = {
+	javascript: javascript_default,
+	js: javascript_default,
+	typescript: typescript_default,
+	ts: typescript_default,
+	jsx: jsx_default,
+	tsx: tsx_default,
+	rust: rust_default,
+	rs: rust_default
+};
+
+//#endregion
+export { map as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["adapterJavaScript","adapterTypeScript","adapterJSX","adapterTSX","adapterRust"],"sources":["../../src/adapters/index.ts"],"sourcesContent":["import adapterJavaScript from \"./javascript\";\nimport adapterJSX from \"./jsx\";\nimport adapterRust from \"./rust\";\nimport adapterTSX from \"./tsx\";\nimport adapterTypeScript from \"./typescript\";\n\nconst map: { [key: string]: (code: string, metadata: string[]) => Promise<void> } = {\n  javascript: adapterJavaScript,\n  js: adapterJavaScript,\n  typescript: adapterTypeScript,\n  ts: adapterTypeScript,\n  jsx: adapterJSX,\n  tsx: adapterTSX,\n  rust: adapterRust,\n  rs: adapterRust,\n};\n\nexport default map;\n"],"mappings":";;;;;;;AAMA,MAAM,MAA8E;CAClF,YAAYA;CACZ,IAAIA;CACJ,YAAYC;CACZ,IAAIA;CACJ,KAAKC;CACL,KAAKC;CACL,MAAMC;CACN,IAAIA;CACL"}

package/dist/adapters/javascript/constants.mjs

@@ -0,0 +1,10 @@
+//#region src/adapters/javascript/constants.ts
+const ADAPTER_OPTIONS = {
+	env: ".env.docs",
+	installCommand: ["npm", "install"],
+	environment: void 0
+};
+
+//#endregion
+export { ADAPTER_OPTIONS };
+//# sourceMappingURL=constants.mjs.map

package/dist/adapters/javascript/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","names":[],"sources":["../../../src/adapters/javascript/constants.ts"],"sourcesContent":["export const ADAPTER_OPTIONS = {\n  env: \".env.docs\",\n  installCommand: [\"npm\", \"install\"],\n  environment: undefined,\n};\n"],"mappings":";AAAA,MAAa,kBAAkB;CAC7B,KAAK;CACL,gBAAgB,CAAC,OAAO,UAAU;CAClC,aAAa;CACd"}

package/dist/adapters/javascript/index.mjs

@@ -0,0 +1,31 @@
+import { getFilename, getOptions } from "../../remark/utils.mjs";
+import { cleanupEnvironment, execUntilExit } from "../../utils.mjs";
+import { createEnvironment, getEntryPath, getImports } from "./utils.mjs";
+import { ADAPTER_OPTIONS } from "./constants.mjs";
+import { readFile } from "fs/promises";
+import { existsSync } from "fs";
+import { JsxEmit, transpileModule } from "typescript";
+
+//#region src/adapters/javascript/index.ts
+async function adapterJavaScript(code, filename, options, type) {
+	const dotenv = existsSync(options.env) ? await readFile(options.env, { encoding: "utf-8" }) : void 0;
+	const imports = await getImports(code, filename, type);
+	const environmentPath = await createEnvironment(type !== "js" ? transpileModule(code, {
+		fileName: filename + `.${type}`,
+		compilerOptions: { jsx: JsxEmit.React }
+	}).outputText : code, imports, dotenv, {
+		environmentPath: options.environment,
+		installCommand: options.installCommand
+	});
+	try {
+		await execUntilExit(`node ${dotenv ? `--env-file=${environmentPath}/.env` : ""} ${getEntryPath(environmentPath)}`, process.cwd());
+	} finally {
+		if (!options.environment) await cleanupEnvironment(environmentPath);
+	}
+}
+const adapterWrapperJavaScript = (code, metadata, type) => adapterJavaScript(code, getFilename(metadata, code), getOptions(metadata, ADAPTER_OPTIONS), type);
+var javascript_default = (code, metadata) => adapterWrapperJavaScript(code, metadata, "js");
+
+//#endregion
+export { adapterWrapperJavaScript, javascript_default as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/javascript/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/adapters/javascript/index.ts"],"sourcesContent":["import { getFilename, getOptions } from \"@/remark/utils\";\nimport {\n  cleanupEnvironment,\n  createEnvironment,\n  execUntilExit,\n  getEntryPath,\n  getImports,\n  JavaScriptType,\n} from \"./utils\";\nimport { readFile } from \"fs/promises\";\nimport { ADAPTER_OPTIONS } from \"./constants\";\nimport { existsSync } from \"fs\";\nimport { JsxEmit, transpileModule } from \"typescript\";\n\ntype AdapterOptions = {\n  env: string;\n  installCommand: string[];\n  environment?: string;\n};\n\nasync function adapterJavaScript(\n  code: string,\n  filename: string,\n  options: AdapterOptions,\n  type: JavaScriptType,\n): Promise<void> {\n  const dotenv = existsSync(options.env)\n    ? await readFile(options.env, { encoding: \"utf-8\" })\n    : undefined;\n  const imports = await getImports(code, filename, type);\n  const parsedCode =\n    type !== \"js\"\n      ? transpileModule(code, {\n          fileName: filename + `.${type}`,\n          compilerOptions: {\n            jsx: JsxEmit.React,\n          },\n        }).outputText\n      : code;\n  const environmentPath = await createEnvironment(parsedCode, imports, dotenv, {\n    environmentPath: options.environment,\n    installCommand: options.installCommand,\n  });\n\n  try {\n    const envFlag = dotenv ? `--env-file=${environmentPath}/.env` : \"\";\n    await execUntilExit(`node ${envFlag} ${getEntryPath(environmentPath)}`, process.cwd());\n  } finally {\n    if (!options.environment) {\n      await cleanupEnvironment(environmentPath);\n    }\n  }\n}\n\nexport const adapterWrapperJavaScript = (\n  code: string,\n  metadata: string[],\n  type: JavaScriptType,\n): Promise<void> =>\n  adapterJavaScript(code, getFilename(metadata, code), getOptions(metadata, ADAPTER_OPTIONS), type);\nexport default (code: string, metadata: string[]) => adapterWrapperJavaScript(code, metadata, \"js\");\n"],"mappings":";;;;;;;;;AAoBA,eAAe,kBACb,MACA,UACA,SACA,MACe;CACf,MAAM,SAAS,WAAW,QAAQ,IAAI,GAClC,MAAM,SAAS,QAAQ,KAAK,EAAE,UAAU,SAAS,CAAC,GAClD;CACJ,MAAM,UAAU,MAAM,WAAW,MAAM,UAAU,KAAK;CAUtD,MAAM,kBAAkB,MAAM,kBAR5B,SAAS,OACL,gBAAgB,MAAM;EACpB,UAAU,WAAW,IAAI;EACzB,iBAAiB,EACf,KAAK,QAAQ,OACd;EACF,CAAC,CAAC,aACH,MACsD,SAAS,QAAQ;EAC3E,iBAAiB,QAAQ;EACzB,gBAAgB,QAAQ;EACzB,CAAC;AAEF,KAAI;AAEF,QAAM,cAAc,QADJ,SAAS,cAAc,gBAAgB,SAAS,GAC5B,GAAG,aAAa,gBAAgB,IAAI,QAAQ,KAAK,CAAC;WAC9E;AACR,MAAI,CAAC,QAAQ,YACX,OAAM,mBAAmB,gBAAgB;;;AAK/C,MAAa,4BACX,MACA,UACA,SAEA,kBAAkB,MAAM,YAAY,UAAU,KAAK,EAAE,WAAW,UAAU,gBAAgB,EAAE,KAAK;AACnG,0BAAgB,MAAc,aAAuB,yBAAyB,MAAM,UAAU,KAAK"}

package/dist/adapters/javascript/utils.mjs

@@ -0,0 +1,59 @@
+import package_default from "../../assets/package.mjs";
+import { cleanupEnvironment, execUntilExit, logger } from "../../utils.mjs";
+import { randomUUID } from "crypto";
+import { parse } from "oxc-parser";
+import { tmpdir } from "os";
+import { mkdir, writeFile } from "fs/promises";
+import { join } from "path";
+import { isBuiltin } from "module";
+
+//#region src/adapters/javascript/utils.ts
+function getPackage(importSpec) {
+	let packageSpec = importSpec;
+	if (packageSpec.startsWith("npm:")) packageSpec = packageSpec.slice(4);
+	if (packageSpec.startsWith("@")) return packageSpec.split("/").slice(0, 2).join("/");
+	return packageSpec.split("/")[0];
+}
+async function getImports(code, filename, type) {
+	const ast = await parse(filename, code, { lang: type });
+	return [...ast.module.dynamicImports.map((d) => {
+		const packageSpec = getPackage(code.slice(d.moduleRequest.start, d.moduleRequest.end).replaceAll(/['"]/g, ""));
+		return {
+			package: packageSpec,
+			isExternal: !isBuiltin(packageSpec)
+		};
+	}), ...ast.module.staticImports.map((s) => ({
+		package: getPackage(s.moduleRequest.value),
+		isExternal: !isBuiltin(s.moduleRequest.value)
+	}))];
+}
+function getEntryPath(environmentPath) {
+	return `${environmentPath}/dist/index.js`;
+}
+async function createEnvironment(code, imports, env, options = { installCommand: ["npm", "install"] }) {
+	logger.info("Creating environment with imports", imports.map((i) => i.package));
+	if (options.environmentPath) {
+		logger.info("Using explicit environment at", options.environmentPath);
+		await mkdir(`${options.environmentPath}/dist`, { recursive: true });
+		await writeFile(`${options.environmentPath}/dist/index.js`, code);
+		return options.environmentPath;
+	}
+	const path = join(tmpdir(), "docval", randomUUID());
+	await mkdir(`${path}/dist`, { recursive: true });
+	await Promise.all([
+		writeFile(`${path}/package.json`, JSON.stringify(package_default)),
+		writeFile(`${path}/dist/index.js`, code),
+		env ? writeFile(`${path}/.env`, env) : Promise.resolve()
+	]);
+	logger.info("Created environment at", path);
+	const cmd = options.installCommand.concat(imports.filter((i) => i.isExternal).map((i) => i.package)).join(" ");
+	if (imports.length > 0) {
+		logger.info("Installing dependencies with command:", cmd);
+		await execUntilExit(cmd, path);
+	}
+	return path;
+}
+
+//#endregion
+export { createEnvironment, getEntryPath, getImports };
+//# sourceMappingURL=utils.mjs.map

package/dist/adapters/javascript/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":["manifest"],"sources":["../../../src/adapters/javascript/utils.ts"],"sourcesContent":["import { parse } from \"oxc-parser\";\nimport { tmpdir } from \"os\";\nimport { mkdir, writeFile } from \"fs/promises\";\nimport manifest from \"~/assets/package.json\";\nimport { join } from \"path\";\nimport { randomUUID } from \"crypto\";\nimport { isBuiltin } from \"module\";\nimport { cleanupEnvironment, execUntilExit, logger } from \"@/utils\";\n\ntype Import = {\n  isExternal: boolean;\n  package: string;\n};\n\nfunction getPackage(importSpec: string): string {\n  let packageSpec = importSpec;\n  // Deno environment\n  if (packageSpec.startsWith(\"npm:\")) {\n    packageSpec = packageSpec.slice(4);\n  }\n  if (packageSpec.startsWith(\"@\")) {\n    return packageSpec.split(\"/\").slice(0, 2).join(\"/\");\n  }\n  return packageSpec.split(\"/\")[0];\n}\n\nasync function getImports(code: string, filename: string, type: JavaScriptType): Promise<Import[]> {\n  const ast = await parse(filename, code, {\n    lang: type,\n  });\n  return [\n    ...ast.module.dynamicImports.map((d) => {\n      const packageSpec = getPackage(\n        code.slice(d.moduleRequest.start, d.moduleRequest.end).replaceAll(/['\"]/g, \"\"),\n      );\n      return { package: packageSpec, isExternal: !isBuiltin(packageSpec) };\n    }),\n    ...ast.module.staticImports.map((s) => ({\n      package: getPackage(s.moduleRequest.value),\n      isExternal: !isBuiltin(s.moduleRequest.value),\n    })),\n  ];\n}\n\ntype EnvironmentOptions = {\n  environmentPath?: string;\n  installCommand: string[];\n};\n\nfunction getEntryPath(environmentPath: string) {\n  return `${environmentPath}/dist/index.js`;\n}\n\nasync function createEnvironment(\n  code: string,\n  imports: Import[],\n  env: string | undefined,\n  options: EnvironmentOptions = {\n    installCommand: [\"npm\", \"install\"],\n  },\n) {\n  logger.info(\n    \"Creating environment with imports\",\n    imports.map((i) => i.package),\n  );\n  if (options.environmentPath) {\n    logger.info(\"Using explicit environment at\", options.environmentPath);\n    await mkdir(`${options.environmentPath}/dist`, { recursive: true });\n    await writeFile(`${options.environmentPath}/dist/index.js`, code);\n    return options.environmentPath;\n  }\n\n  const path = join(tmpdir(), \"docval\", randomUUID());\n  await mkdir(`${path}/dist`, { recursive: true });\n  await Promise.all([\n    writeFile(`${path}/package.json`, JSON.stringify(manifest)),\n    writeFile(`${path}/dist/index.js`, code),\n    env ? writeFile(`${path}/.env`, env) : Promise.resolve(),\n  ]);\n  logger.info(\"Created environment at\", path);\n  const cmd = options.installCommand\n    .concat(imports.filter((i) => i.isExternal).map((i) => i.package))\n    .join(\" \");\n  if (imports.length > 0) {\n    logger.info(\"Installing dependencies with command:\", cmd);\n    await execUntilExit(cmd, path);\n  }\n  return path;\n}\n\ntype JavaScriptType = \"js\" | \"ts\" | \"tsx\" | \"jsx\";\n\nexport type { JavaScriptType };\nexport { getImports, createEnvironment, cleanupEnvironment, execUntilExit, getEntryPath };\n"],"mappings":";;;;;;;;;;AAcA,SAAS,WAAW,YAA4B;CAC9C,IAAI,cAAc;AAElB,KAAI,YAAY,WAAW,OAAO,CAChC,eAAc,YAAY,MAAM,EAAE;AAEpC,KAAI,YAAY,WAAW,IAAI,CAC7B,QAAO,YAAY,MAAM,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,IAAI;AAErD,QAAO,YAAY,MAAM,IAAI,CAAC;;AAGhC,eAAe,WAAW,MAAc,UAAkB,MAAyC;CACjG,MAAM,MAAM,MAAM,MAAM,UAAU,MAAM,EACtC,MAAM,MACP,CAAC;AACF,QAAO,CACL,GAAG,IAAI,OAAO,eAAe,KAAK,MAAM;EACtC,MAAM,cAAc,WAClB,KAAK,MAAM,EAAE,cAAc,OAAO,EAAE,cAAc,IAAI,CAAC,WAAW,SAAS,GAAG,CAC/E;AACD,SAAO;GAAE,SAAS;GAAa,YAAY,CAAC,UAAU,YAAY;GAAE;GACpE,EACF,GAAG,IAAI,OAAO,cAAc,KAAK,OAAO;EACtC,SAAS,WAAW,EAAE,cAAc,MAAM;EAC1C,YAAY,CAAC,UAAU,EAAE,cAAc,MAAM;EAC9C,EAAE,CACJ;;AAQH,SAAS,aAAa,iBAAyB;AAC7C,QAAO,GAAG,gBAAgB;;AAG5B,eAAe,kBACb,MACA,SACA,KACA,UAA8B,EAC5B,gBAAgB,CAAC,OAAO,UAAU,EACnC,EACD;AACA,QAAO,KACL,qCACA,QAAQ,KAAK,MAAM,EAAE,QAAQ,CAC9B;AACD,KAAI,QAAQ,iBAAiB;AAC3B,SAAO,KAAK,iCAAiC,QAAQ,gBAAgB;AACrE,QAAM,MAAM,GAAG,QAAQ,gBAAgB,QAAQ,EAAE,WAAW,MAAM,CAAC;AACnE,QAAM,UAAU,GAAG,QAAQ,gBAAgB,iBAAiB,KAAK;AACjE,SAAO,QAAQ;;CAGjB,MAAM,OAAO,KAAK,QAAQ,EAAE,UAAU,YAAY,CAAC;AACnD,OAAM,MAAM,GAAG,KAAK,QAAQ,EAAE,WAAW,MAAM,CAAC;AAChD,OAAM,QAAQ,IAAI;EAChB,UAAU,GAAG,KAAK,gBAAgB,KAAK,UAAUA,gBAAS,CAAC;EAC3D,UAAU,GAAG,KAAK,iBAAiB,KAAK;EACxC,MAAM,UAAU,GAAG,KAAK,QAAQ,IAAI,GAAG,QAAQ,SAAS;EACzD,CAAC;AACF,QAAO,KAAK,0BAA0B,KAAK;CAC3C,MAAM,MAAM,QAAQ,eACjB,OAAO,QAAQ,QAAQ,MAAM,EAAE,WAAW,CAAC,KAAK,MAAM,EAAE,QAAQ,CAAC,CACjE,KAAK,IAAI;AACZ,KAAI,QAAQ,SAAS,GAAG;AACtB,SAAO,KAAK,yCAAyC,IAAI;AACzD,QAAM,cAAc,KAAK,KAAK;;AAEhC,QAAO"}

package/dist/adapters/jsx/index.mjs

@@ -0,0 +1,8 @@
+import { adapterWrapperJavaScript } from "../javascript/index.mjs";
+
+//#region src/adapters/jsx/index.ts
+var jsx_default = (code, metadata) => adapterWrapperJavaScript(code, metadata, "jsx");
+
+//#endregion
+export { jsx_default as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/jsx/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/adapters/jsx/index.ts"],"sourcesContent":["import { adapterWrapperJavaScript } from \"../javascript\";\n\nexport default (code: string, metadata: string[]) =>\n  adapterWrapperJavaScript(code, metadata, \"jsx\");\n"],"mappings":";;;AAEA,mBAAgB,MAAc,aAC5B,yBAAyB,MAAM,UAAU,MAAM"}

package/dist/adapters/rust/constants.mjs

@@ -0,0 +1,6 @@
+//#region src/adapters/rust/constants.ts
+const ADAPTER_OPTIONS = { environment: void 0 };
+
+//#endregion
+export { ADAPTER_OPTIONS };
+//# sourceMappingURL=constants.mjs.map

package/dist/adapters/rust/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","names":[],"sources":["../../../src/adapters/rust/constants.ts"],"sourcesContent":["export const ADAPTER_OPTIONS = {\n  environment: undefined,\n};\n"],"mappings":";AAAA,MAAa,kBAAkB,EAC7B,aAAa,QACd"}

package/dist/adapters/rust/index.mjs

@@ -0,0 +1,19 @@
+import { getOptions } from "../../remark/utils.mjs";
+import { cleanupEnvironment, execUntilExit } from "../../utils.mjs";
+import { createEnvironment, getImports } from "./utils.mjs";
+import { ADAPTER_OPTIONS } from "./constants.mjs";
+
+//#region src/adapters/rust/index.ts
+async function adapterRust(code, options) {
+	const environmentPath = await createEnvironment(code, getImports(code), { environmentPath: options.environment });
+	try {
+		await execUntilExit("cargo run", environmentPath);
+	} finally {
+		if (!options.environment) await cleanupEnvironment(environmentPath);
+	}
+}
+var rust_default = (code, metadata) => adapterRust(code, getOptions(metadata, ADAPTER_OPTIONS));
+
+//#endregion
+export { rust_default as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/rust/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/adapters/rust/index.ts"],"sourcesContent":["import { getOptions } from \"@/remark/utils\";\nimport { createEnvironment, getImports } from \"./utils\";\nimport { ADAPTER_OPTIONS } from \"./constants\";\nimport { cleanupEnvironment, execUntilExit } from \"@/utils\";\n\ntype AdapterOptions = {\n  environment?: string;\n};\n\nasync function adapterRust(code: string, options: AdapterOptions): Promise<void> {\n  const imports = getImports(code);\n  const environmentPath = await createEnvironment(code, imports, {\n    environmentPath: options.environment,\n  });\n\n  try {\n    await execUntilExit(\"cargo run\", environmentPath);\n  } finally {\n    if (!options.environment) {\n      await cleanupEnvironment(environmentPath);\n    }\n  }\n}\n\nexport default (code: string, metadata: string[]) =>\n  adapterRust(code, getOptions(metadata, ADAPTER_OPTIONS));\n"],"mappings":";;;;;;AASA,eAAe,YAAY,MAAc,SAAwC;CAE/E,MAAM,kBAAkB,MAAM,kBAAkB,MADhC,WAAW,KAAK,EAC+B,EAC7D,iBAAiB,QAAQ,aAC1B,CAAC;AAEF,KAAI;AACF,QAAM,cAAc,aAAa,gBAAgB;WACzC;AACR,MAAI,CAAC,QAAQ,YACX,OAAM,mBAAmB,gBAAgB;;;AAK/C,oBAAgB,MAAc,aAC5B,YAAY,MAAM,WAAW,UAAU,gBAAgB,CAAC"}

package/dist/adapters/rust/utils.mjs

@@ -0,0 +1,69 @@
+import { execUntilExit, logger } from "../../utils.mjs";
+import { randomUUID } from "crypto";
+import { tmpdir } from "os";
+import { mkdir, readFile, writeFile } from "fs/promises";
+import { join } from "path";
+import Parser from "tree-sitter";
+import Rust from "tree-sitter-rust";
+
+//#region src/adapters/rust/utils.ts
+const BUILTIN_CRATES = new Set([
+	"std",
+	"core",
+	"alloc",
+	"crate"
+]);
+const ERROR_CRATES = new Set([
+	"crate",
+	"super",
+	"self"
+]);
+function getImports(code) {
+	const parser = new Parser();
+	parser.setLanguage(Rust);
+	const tree = parser.parse(code);
+	const imports = [];
+	for (const node of tree.rootNode.children) {
+		let crateName;
+		if (node.type === "use_declaration") {
+			const arg = node.child(1);
+			if (!arg) continue;
+			if (arg.type === "identifier" || arg.type === "scoped_identifier") crateName = arg.text.split("::")[0];
+		}
+		if (crateName) {
+			if (ERROR_CRATES.has(crateName)) throw new Error(`Unsupported import of "${crateName}". Imports of ${Array.from(ERROR_CRATES).map((c) => `"${c}"`).join(", ")} are not supported.`);
+			imports.push({
+				package: crateName,
+				isExternal: !BUILTIN_CRATES.has(crateName)
+			});
+		}
+	}
+	return imports;
+}
+function getEntryPath(environmentPath) {
+	return `${environmentPath}/src/main.rs`;
+}
+async function createEnvironment(code, imports, options = {}) {
+	logger.info("Creating Rust environment with crates", imports.map((i) => i.package));
+	if (options.environmentPath) {
+		logger.info("Using explicit environment at", options.environmentPath);
+		await mkdir(`${options.environmentPath}/src`, { recursive: true });
+		await writeFile(getEntryPath(options.environmentPath), code);
+		return options.environmentPath;
+	}
+	const manifest = await readFile(new URL("../../../assets/Cargo.toml", import.meta.url), "utf-8");
+	const path = join(tmpdir(), "docval", randomUUID());
+	await mkdir(`${path}/src`, { recursive: true });
+	await Promise.all([writeFile(`${path}/Cargo.toml`, manifest), writeFile(`${path}/src/main.rs`, code)]);
+	if (imports.length > 0) {
+		const crates = imports.filter((i) => i.isExternal).map((i) => i.package);
+		logger.info("Installing crates", crates);
+		await execUntilExit(`cargo add ${crates.join(" ")}`, path);
+	}
+	logger.info("Created Rust environment at", path);
+	return path;
+}
+
+//#endregion
+export { createEnvironment, getImports };
+//# sourceMappingURL=utils.mjs.map

package/dist/adapters/rust/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":[],"sources":["../../../src/adapters/rust/utils.ts"],"sourcesContent":["import Parser from \"tree-sitter\";\nimport Rust from \"tree-sitter-rust\";\nimport { tmpdir } from \"os\";\nimport { mkdir, readFile, writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { randomUUID } from \"crypto\";\nimport { execUntilExit, logger } from \"@/utils\";\n\nconst BUILTIN_CRATES = new Set([\"std\", \"core\", \"alloc\", \"crate\"]);\nconst ERROR_CRATES = new Set([\"crate\", \"super\", \"self\"]);\n\ntype Import = {\n  isExternal: boolean;\n  package: string;\n};\n\nfunction getImports(code: string): Import[] {\n  const parser = new Parser();\n  parser.setLanguage(Rust as unknown as Parser.Language);\n  const tree = parser.parse(code);\n  const imports: Import[] = [];\n\n  for (const node of tree.rootNode.children) {\n    let crateName: string | undefined;\n\n    if (node.type === \"use_declaration\") {\n      const arg = node.child(1);\n      if (!arg) continue;\n      if (arg.type === \"identifier\" || arg.type === \"scoped_identifier\") {\n        crateName = arg.text.split(\"::\")[0];\n      }\n    }\n\n    if (crateName) {\n      if (ERROR_CRATES.has(crateName)) {\n        throw new Error(\n          `Unsupported import of \"${crateName}\". ` +\n            `Imports of ${Array.from(ERROR_CRATES)\n              .map((c) => `\"${c}\"`)\n              .join(\", \")} are not supported.`,\n        );\n      }\n\n      imports.push({\n        package: crateName,\n        isExternal: !BUILTIN_CRATES.has(crateName),\n      });\n    }\n  }\n\n  return imports;\n}\n\ntype EnvironmentOptions = {\n  environmentPath?: string;\n};\n\nfunction getEntryPath(environmentPath: string) {\n  return `${environmentPath}/src/main.rs`;\n}\n\nasync function createEnvironment(\n  code: string,\n  imports: Import[],\n  options: EnvironmentOptions = {},\n) {\n  logger.info(\n    \"Creating Rust environment with crates\",\n    imports.map((i) => i.package),\n  );\n\n  if (options.environmentPath) {\n    logger.info(\"Using explicit environment at\", options.environmentPath);\n    await mkdir(`${options.environmentPath}/src`, { recursive: true });\n    await writeFile(getEntryPath(options.environmentPath), code);\n    return options.environmentPath;\n  }\n\n  const manifest = await readFile(new URL(\"../../../assets/Cargo.toml\", import.meta.url), \"utf-8\");\n  const path = join(tmpdir(), \"docval\", randomUUID());\n  await mkdir(`${path}/src`, { recursive: true });\n  await Promise.all([\n    writeFile(`${path}/Cargo.toml`, manifest),\n    writeFile(`${path}/src/main.rs`, code),\n  ]);\n  if (imports.length > 0) {\n    const crates = imports.filter((i) => i.isExternal).map((i) => i.package);\n    logger.info(\"Installing crates\", crates);\n    await execUntilExit(`cargo add ${crates.join(\" \")}`, path);\n  }\n  logger.info(\"Created Rust environment at\", path);\n  return path;\n}\n\nexport { getImports, createEnvironment, getEntryPath };\nexport type { Import };\n"],"mappings":";;;;;;;;;AAQA,MAAM,iBAAiB,IAAI,IAAI;CAAC;CAAO;CAAQ;CAAS;CAAQ,CAAC;AACjE,MAAM,eAAe,IAAI,IAAI;CAAC;CAAS;CAAS;CAAO,CAAC;AAOxD,SAAS,WAAW,MAAwB;CAC1C,MAAM,SAAS,IAAI,QAAQ;AAC3B,QAAO,YAAY,KAAmC;CACtD,MAAM,OAAO,OAAO,MAAM,KAAK;CAC/B,MAAM,UAAoB,EAAE;AAE5B,MAAK,MAAM,QAAQ,KAAK,SAAS,UAAU;EACzC,IAAI;AAEJ,MAAI,KAAK,SAAS,mBAAmB;GACnC,MAAM,MAAM,KAAK,MAAM,EAAE;AACzB,OAAI,CAAC,IAAK;AACV,OAAI,IAAI,SAAS,gBAAgB,IAAI,SAAS,oBAC5C,aAAY,IAAI,KAAK,MAAM,KAAK,CAAC;;AAIrC,MAAI,WAAW;AACb,OAAI,aAAa,IAAI,UAAU,CAC7B,OAAM,IAAI,MACR,0BAA0B,UAAU,gBACpB,MAAM,KAAK,aAAa,CACnC,KAAK,MAAM,IAAI,EAAE,GAAG,CACpB,KAAK,KAAK,CAAC,qBACjB;AAGH,WAAQ,KAAK;IACX,SAAS;IACT,YAAY,CAAC,eAAe,IAAI,UAAU;IAC3C,CAAC;;;AAIN,QAAO;;AAOT,SAAS,aAAa,iBAAyB;AAC7C,QAAO,GAAG,gBAAgB;;AAG5B,eAAe,kBACb,MACA,SACA,UAA8B,EAAE,EAChC;AACA,QAAO,KACL,yCACA,QAAQ,KAAK,MAAM,EAAE,QAAQ,CAC9B;AAED,KAAI,QAAQ,iBAAiB;AAC3B,SAAO,KAAK,iCAAiC,QAAQ,gBAAgB;AACrE,QAAM,MAAM,GAAG,QAAQ,gBAAgB,OAAO,EAAE,WAAW,MAAM,CAAC;AAClE,QAAM,UAAU,aAAa,QAAQ,gBAAgB,EAAE,KAAK;AAC5D,SAAO,QAAQ;;CAGjB,MAAM,WAAW,MAAM,SAAS,IAAI,IAAI,8BAA8B,OAAO,KAAK,IAAI,EAAE,QAAQ;CAChG,MAAM,OAAO,KAAK,QAAQ,EAAE,UAAU,YAAY,CAAC;AACnD,OAAM,MAAM,GAAG,KAAK,OAAO,EAAE,WAAW,MAAM,CAAC;AAC/C,OAAM,QAAQ,IAAI,CAChB,UAAU,GAAG,KAAK,cAAc,SAAS,EACzC,UAAU,GAAG,KAAK,eAAe,KAAK,CACvC,CAAC;AACF,KAAI,QAAQ,SAAS,GAAG;EACtB,MAAM,SAAS,QAAQ,QAAQ,MAAM,EAAE,WAAW,CAAC,KAAK,MAAM,EAAE,QAAQ;AACxE,SAAO,KAAK,qBAAqB,OAAO;AACxC,QAAM,cAAc,aAAa,OAAO,KAAK,IAAI,IAAI,KAAK;;AAE5D,QAAO,KAAK,+BAA+B,KAAK;AAChD,QAAO"}

package/dist/adapters/tsx/index.mjs

@@ -0,0 +1,8 @@
+import { adapterWrapperJavaScript } from "../javascript/index.mjs";
+
+//#region src/adapters/tsx/index.ts
+var tsx_default = (code, metadata) => adapterWrapperJavaScript(code, metadata, "tsx");
+
+//#endregion
+export { tsx_default as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/tsx/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/adapters/tsx/index.ts"],"sourcesContent":["import { adapterWrapperJavaScript } from \"../javascript\";\n\nexport default (code: string, metadata: string[]) =>\n  adapterWrapperJavaScript(code, metadata, \"tsx\");\n"],"mappings":";;;AAEA,mBAAgB,MAAc,aAC5B,yBAAyB,MAAM,UAAU,MAAM"}

package/dist/adapters/typescript/index.mjs

@@ -0,0 +1,8 @@
+import { adapterWrapperJavaScript } from "../javascript/index.mjs";
+
+//#region src/adapters/typescript/index.ts
+var typescript_default = (code, metadata) => adapterWrapperJavaScript(code, metadata, "ts");
+
+//#endregion
+export { typescript_default as default };
+//# sourceMappingURL=index.mjs.map

package/dist/adapters/typescript/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../src/adapters/typescript/index.ts"],"sourcesContent":["import { adapterWrapperJavaScript } from \"../javascript\";\n\nexport default (code: string, metadata: string[]) => adapterWrapperJavaScript(code, metadata, \"ts\");\n"],"mappings":";;;AAEA,0BAAgB,MAAc,aAAuB,yBAAyB,MAAM,UAAU,KAAK"}

package/dist/assets/package.mjs

@@ -0,0 +1,11 @@
+//#region assets/package.json
+var package_default = {
+	name: "docval-env",
+	version: "0.0.0",
+	"private": true,
+	type: "module"
+};
+
+//#endregion
+export { package_default as default };
+//# sourceMappingURL=package.mjs.map

package/dist/assets/package.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.mjs","names":[],"sources":["../../assets/package.json"],"sourcesContent":[""],"mappings":""}

package/dist/main.d.mts

@@ -0,0 +1,2 @@
+import { remarkDocval } from "./remark/plugin.mjs";
+export { remarkDocval as remarkDocVal };

package/dist/main.mjs

@@ -0,0 +1,3 @@
+import remarkDocval from "./remark/plugin.mjs";
+
+export { remarkDocval as remarkDocVal };

package/dist/remark/plugin.d.mts

@@ -0,0 +1,12 @@
+import { Root } from "mdast";
+
+//#region src/remark/plugin.d.ts
+type DocValOptions = {
+  include?: boolean;
+};
+declare function remarkDocval({
+  include
+}?: DocValOptions): (tree: Root) => Promise<Root>;
+//#endregion
+export { remarkDocval };
+//# sourceMappingURL=plugin.d.mts.map

package/dist/remark/plugin.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/remark/plugin.ts"],"mappings":";;;KAGY,aAAA;EACV,OAAA;AAAA;AAAA,iBAGsB,YAAA,CAAA;EAAe;AAAA,IAAW,aAAA,IAAkB,IAAA,EACrC,IAAA,KAAI,OAAA,CAAA,IAAA"}

package/dist/remark/plugin.mjs

@@ -0,0 +1,25 @@
+import map from "../adapters/index.mjs";
+
+//#region src/remark/plugin.ts
+function remarkDocval({ include } = {}) {
+	return async function(tree) {
+		const promises = [];
+		tree.children.forEach((node) => {
+			if (node.type === "code" && node.lang && node.lang in map) {
+				const metadata = node.meta?.split(" ") ?? [];
+				const docValIndex = metadata.findIndex((item) => item === "docval");
+				if (include || docValIndex !== -1) promises.push(map[node.lang](node.value, metadata));
+			} else if (node.type === "code" && process.env.DOCVAL_TEST_NO_SKIP === "true") throw new Error(`Skipped code block: ${JSON.stringify(node)}`);
+		});
+		const res = await Promise.allSettled(promises);
+		if (res.some((r) => r.status === "rejected")) throw JSON.stringify({
+			message: "One or more code blocks failed validation.",
+			originalResults: res
+		});
+		return tree;
+	};
+}
+
+//#endregion
+export { remarkDocval as default };
+//# sourceMappingURL=plugin.mjs.map

package/dist/remark/plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.mjs","names":["adapters"],"sources":["../../src/remark/plugin.ts"],"sourcesContent":["import adapters from \"@/adapters\";\nimport type { Root } from \"mdast\";\n\nexport type DocValOptions = {\n  include?: boolean;\n};\n\nexport default function remarkDocval({ include }: DocValOptions = {}) {\n  return async function (tree: Root) {\n    const promises: Promise<void>[] = [];\n    tree.children.forEach((node) => {\n      if (node.type === \"code\" && node.lang && node.lang in adapters) {\n        const metadata = node.meta?.split(\" \") ?? [];\n        const docValIndex = metadata.findIndex((item) => item === \"docval\");\n        if (include || docValIndex !== -1) {\n          promises.push(adapters[node.lang as keyof typeof adapters](node.value, metadata));\n        }\n      } else if (node.type === \"code\" && process.env.DOCVAL_TEST_NO_SKIP === \"true\") {\n        throw new Error(`Skipped code block: ${JSON.stringify(node)}`);\n      }\n    });\n    const res = await Promise.allSettled(promises);\n    if (res.some((r) => r.status === \"rejected\")) {\n      throw JSON.stringify({\n        message: \"One or more code blocks failed validation.\",\n        originalResults: res,\n      });\n    }\n\n    return tree;\n  };\n}\n"],"mappings":";;;AAOA,SAAwB,aAAa,EAAE,YAA2B,EAAE,EAAE;AACpE,QAAO,eAAgB,MAAY;EACjC,MAAM,WAA4B,EAAE;AACpC,OAAK,SAAS,SAAS,SAAS;AAC9B,OAAI,KAAK,SAAS,UAAU,KAAK,QAAQ,KAAK,QAAQA,KAAU;IAC9D,MAAM,WAAW,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE;IAC5C,MAAM,cAAc,SAAS,WAAW,SAAS,SAAS,SAAS;AACnE,QAAI,WAAW,gBAAgB,GAC7B,UAAS,KAAKA,IAAS,KAAK,MAA+B,KAAK,OAAO,SAAS,CAAC;cAE1E,KAAK,SAAS,UAAU,QAAQ,IAAI,wBAAwB,OACrE,OAAM,IAAI,MAAM,uBAAuB,KAAK,UAAU,KAAK,GAAG;IAEhE;EACF,MAAM,MAAM,MAAM,QAAQ,WAAW,SAAS;AAC9C,MAAI,IAAI,MAAM,MAAM,EAAE,WAAW,WAAW,CAC1C,OAAM,KAAK,UAAU;GACnB,SAAS;GACT,iBAAiB;GAClB,CAAC;AAGJ,SAAO"}

package/dist/remark/utils.mjs

@@ -0,0 +1,26 @@
+import { hash } from "crypto";
+
+//#region src/remark/utils.ts
+function getFilename(_metadata, code) {
+	return hash("sha1", code);
+}
+function getOptions(metadata, defaultOptions) {
+	let options = { ...defaultOptions };
+	metadata.forEach((item) => {
+		const pairs = [];
+		const [key, ...rest] = item.split("=");
+		const value = rest.join("=").replace(/^["']|["']$/g, "");
+		if (!key || !value) return;
+		pairs.push([key, value.includes(",") ? value.split(",") : value]);
+		Object.fromEntries(pairs);
+		options = {
+			...options,
+			...Object.fromEntries(pairs)
+		};
+	});
+	return options;
+}
+
+//#endregion
+export { getFilename, getOptions };
+//# sourceMappingURL=utils.mjs.map

package/dist/remark/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":[],"sources":["../../src/remark/utils.ts"],"sourcesContent":["import { hash } from \"crypto\";\n\nfunction getFilename(_metadata: string[], code: string): string {\n  // TODO: Use filename metadata to provide better error messages pointing to the exact codeblock.\n  // const filenameIndex = metadata.findIndex((item) => item.startsWith(\"filename=\"));\n  // if (filenameIndex !== -1) {\n  //   return metadata[filenameIndex].split(\"=\")[1];\n  // }\n  return hash(\"sha1\", code);\n}\n\nexport function getOptions<T extends Record<string, string | string[] | undefined>>(\n  metadata: string[],\n  defaultOptions: T,\n): T {\n  let options = { ...defaultOptions };\n  metadata.forEach((item) => {\n    const pairs: [string, string | string[]][] = [];\n    const [key, ...rest] = item.split(\"=\");\n    const value = rest.join(\"=\").replace(/^[\"']|[\"']$/g, \"\");\n    if (!key || !value) return;\n    pairs.push([key, value.includes(\",\") ? value.split(\",\") : value]);\n    Object.fromEntries(pairs);\n    options = { ...options, ...Object.fromEntries(pairs) };\n  });\n  return options as T;\n}\n\nexport { getFilename };\n"],"mappings":";;;AAEA,SAAS,YAAY,WAAqB,MAAsB;AAM9D,QAAO,KAAK,QAAQ,KAAK;;AAG3B,SAAgB,WACd,UACA,gBACG;CACH,IAAI,UAAU,EAAE,GAAG,gBAAgB;AACnC,UAAS,SAAS,SAAS;EACzB,MAAM,QAAuC,EAAE;EAC/C,MAAM,CAAC,KAAK,GAAG,QAAQ,KAAK,MAAM,IAAI;EACtC,MAAM,QAAQ,KAAK,KAAK,IAAI,CAAC,QAAQ,gBAAgB,GAAG;AACxD,MAAI,CAAC,OAAO,CAAC,MAAO;AACpB,QAAM,KAAK,CAAC,KAAK,MAAM,SAAS,IAAI,GAAG,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AACjE,SAAO,YAAY,MAAM;AACzB,YAAU;GAAE,GAAG;GAAS,GAAG,OAAO,YAAY,MAAM;GAAE;GACtD;AACF,QAAO"}

package/dist/utils.mjs

@@ -0,0 +1,31 @@
+import { spawn } from "child_process";
+import consola from "consola";
+
+//#region src/utils.ts
+const logger = consola.withTag("Borrow").withTag("DocVal");
+function execUntilExit(command, cwd) {
+	let error = "";
+	return new Promise((resolve, reject) => {
+		const process = spawn(command, {
+			cwd,
+			shell: true
+		});
+		process.stdout.on("data", (data) => {
+			logger.debug(data.toString());
+		});
+		process.stderr.on("data", (data) => {
+			error += data;
+		});
+		process.on("close", (code) => {
+			if (code === 0) resolve();
+			else reject(`Command failed with exit code ${code}\n${error})`);
+		});
+	});
+}
+async function cleanupEnvironment(path) {
+	await execUntilExit(`rm -rf ${path}`, process.cwd());
+}
+
+//#endregion
+export { cleanupEnvironment, execUntilExit, logger };
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":[],"sources":["../src/utils.ts"],"sourcesContent":["import { spawn } from \"child_process\";\nimport consola from \"consola\";\n\nconst logger = consola.withTag(\"Borrow\").withTag(\"DocVal\");\n\nfunction execUntilExit(command: string, cwd: string): Promise<void> {\n  let error = \"\";\n  return new Promise((resolve, reject) => {\n    const process = spawn(command, { cwd, shell: true });\n\n    process.stdout.on(\"data\", (data) => {\n      logger.debug(data.toString());\n    });\n\n    process.stderr.on(\"data\", (data) => {\n      error += data;\n    });\n\n    process.on(\"close\", (code) => {\n      if (code === 0) {\n        resolve();\n      } else {\n        reject(`Command failed with exit code ${code}\\n${error})`);\n      }\n    });\n  });\n}\n\nasync function cleanupEnvironment(path: string) {\n  await execUntilExit(`rm -rf ${path}`, process.cwd());\n}\n\nexport { execUntilExit, cleanupEnvironment, logger };\n"],"mappings":";;;;AAGA,MAAM,SAAS,QAAQ,QAAQ,SAAS,CAAC,QAAQ,SAAS;AAE1D,SAAS,cAAc,SAAiB,KAA4B;CAClE,IAAI,QAAQ;AACZ,QAAO,IAAI,SAAS,SAAS,WAAW;EACtC,MAAM,UAAU,MAAM,SAAS;GAAE;GAAK,OAAO;GAAM,CAAC;AAEpD,UAAQ,OAAO,GAAG,SAAS,SAAS;AAClC,UAAO,MAAM,KAAK,UAAU,CAAC;IAC7B;AAEF,UAAQ,OAAO,GAAG,SAAS,SAAS;AAClC,YAAS;IACT;AAEF,UAAQ,GAAG,UAAU,SAAS;AAC5B,OAAI,SAAS,EACX,UAAS;OAET,QAAO,iCAAiC,KAAK,IAAI,MAAM,GAAG;IAE5D;GACF;;AAGJ,eAAe,mBAAmB,MAAc;AAC9C,OAAM,cAAc,UAAU,QAAQ,QAAQ,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@borrowdev/docval",
+  "version": "0.1.0",
+  "description": "Validate your documentation codeblocks at build-time",
+  "homepage": "https://borrow.dev",
+  "license": "MIT",
+  "author": "Lorenzo Bloedow <me@lorenzobloedow.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/borrowdev/borrow.git"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/main.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "consola": "^3.4.2",
+    "oxc-parser": "^0.123.0",
+    "tree-sitter": "^0.25.0",
+    "tree-sitter-rust": "^0.24.0",
+    "typescript": "~6.0.2"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^25.5.0",
+    "@typescript/native-preview": "7.0.0-dev.20260401.1",
+    "vite": "npm:@voidzero-dev/vite-plus-core@^0.1.15",
+    "vite-plus": "latest",
+    "vitest": "npm:@voidzero-dev/vite-plus-test@^0.1.15"
+  },
+  "peerDependencies": {
+    "mdast": "^3.0.0",
+    "remark": "^15.0.1"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check"
+  }
+}