obsidian-dev-utils 4.8.2 → 4.9.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 4.9.0
+
+- Add replaceCodeBlock
+- Refactor getCodeBlockArguments
+
 ## 4.8.2
 
 - Disable import rules

package/dist/lib/obsidian/MarkdownCodeBlockProcessor.cjs

@@ -25,30 +25,48 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var MarkdownCodeBlockProcessor_exports = {};
 __export(MarkdownCodeBlockProcessor_exports, {
-  getCodeBlockArgument: () => getCodeBlockArgument
+  getCodeBlockArguments: () => getCodeBlockArguments,
+  replaceCodeBlock: () => replaceCodeBlock
 });
 module.exports = __toCommonJS(MarkdownCodeBlockProcessor_exports);
+var import_shell_quote = require('shell-quote');
 var import_Error = require('../Error.cjs');
+var import_ValueProvider = require('../ValueProvider.cjs');
+var import_Vault = require('./Vault.cjs');
 var __process = globalThis["process"] ?? {
   "cwd": () => "/",
   "env": {},
   "platform": "android"
 };
-function getCodeBlockArgument(ctx, el) {
+function getCodeBlockArguments(ctx, el) {
   const sectionInfo = ctx.getSectionInfo(el);
   if (!sectionInfo) {
-    return null;
+    return [];
   }
   const lines = sectionInfo.text.split("\n");
   const codeBlockHeader = lines[sectionInfo.lineStart] ?? (0, import_Error.throwExpression)(new Error("Code block header not found"));
   const match = /^`{3,}\S+\s+(.*)$/.exec(codeBlockHeader);
   if (!match) {
-    return null;
+    return [];
   }
-  return match[1]?.trim() ?? null;
+  return (0, import_shell_quote.parse)(match[1] ?? "").map(String);
+}
+async function replaceCodeBlock(app, ctx, el, codeBlockProvider) {
+  const sectionInfo = ctx.getSectionInfo(el);
+  if (!sectionInfo) {
+    return;
+  }
+  const lines = sectionInfo.text.split("\n");
+  const prefix = lines.slice(0, sectionInfo.lineStart).join("\n");
+  const oldCodeBlock = lines.slice(sectionInfo.lineStart, sectionInfo.lineEnd + 1).join("\n");
+  const suffix = lines.slice(sectionInfo.lineEnd + 1).join("\n");
+  const newCodeBlock = await (0, import_ValueProvider.resolveValue)(codeBlockProvider, oldCodeBlock);
+  const newSectionText = prefix + "\n" + newCodeBlock + (newCodeBlock ? "\n" : "") + suffix;
+  await (0, import_Vault.process)(app, ctx.sourcePath, (content) => content.replace(sectionInfo.text, newSectionText));
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getCodeBlockArgument
+  getCodeBlockArguments,
+  replaceCodeBlock
 });
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL29ic2lkaWFuL01hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJ2YXIgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1sncHJvY2VzcyddID8/IHtcbiAgXCJjd2RcIjogKCk9PlwiL1wiLFxuICBcImVudlwiOiB7fSxcbiAgXCJwbGF0Zm9ybVwiOiBcImFuZHJvaWRcIlxufTtcbi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uIE1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yXG4gKiBUaGlzIG1vZHVsZSBwcm92aWRlcyB1dGlsaXR5IGZ1bmN0aW9ucyBmb3IgcHJvY2Vzc2luZyBjb2RlIGJsb2NrcyBpbiBPYnNpZGlhbi5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IE1hcmtkb3duUG9zdFByb2Nlc3NvckNvbnRleHQgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IHRocm93RXhwcmVzc2lvbiB9IGZyb20gJy4uL0Vycm9yLnRzJztcblxuLyoqXG4gKiBSZXRyaWV2ZXMgdGhlIGFyZ3VtZW50IG9mIGEgY29kZSBibG9jayBmcm9tIHRoZSBnaXZlbiBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0IGFuZCBIVE1MRWxlbWVudC5cbiAqXG4gKiBAcGFyYW0gY3R4IC0gVGhlIE1hcmtkb3duUG9zdFByb2Nlc3NvckNvbnRleHQgb2JqZWN0LlxuICogQHBhcmFtIGVsIC0gVGhlIEhUTUxFbGVtZW50IHJlcHJlc2VudGluZyB0aGUgY29kZSBibG9jay5cbiAqIEByZXR1cm5zIFRoZSBhcmd1bWVudCBvZiB0aGUgY29kZSBibG9jayBhcyBhIHN0cmluZywgb3IgbnVsbCBpZiBubyBhcmd1bWVudCBpcyBmb3VuZC5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGdldENvZGVCbG9ja0FyZ3VtZW50KGN0eDogTWFya2Rvd25Qb3N0UHJvY2Vzc29yQ29udGV4dCwgZWw6IEhUTUxFbGVtZW50KTogbnVsbCB8IHN0cmluZyB7XG4gIGNvbnN0IHNlY3Rpb25JbmZvID0gY3R4LmdldFNlY3Rpb25JbmZvKGVsKTtcbiAgaWYgKCFzZWN0aW9uSW5mbykge1xuICAgIHJldHVybiBudWxsO1xuICB9XG4gIGNvbnN0IGxpbmVzID0gc2VjdGlvbkluZm8udGV4dC5zcGxpdCgnXFxuJyk7XG4gIGNvbnN0IGNvZGVCbG9ja0hlYWRlciA9IGxpbmVzW3NlY3Rpb25JbmZvLmxpbmVTdGFydF0gPz8gdGhyb3dFeHByZXNzaW9uKG5ldyBFcnJvcignQ29kZSBibG9jayBoZWFkZXIgbm90IGZvdW5kJykpO1xuICBjb25zdCBtYXRjaCA9IC9eYHszLH1cXFMrXFxzKyguKikkLy5leGVjKGNvZGVCbG9ja0hlYWRlcik7XG4gIGlmICghbWF0Y2gpIHtcbiAgICByZXR1cm4gbnVsbDtcbiAgfVxuICByZXR1cm4gbWF0Y2hbMV0/LnRyaW0oKSA/PyBudWxsO1xufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFZQSxtQkFBZ0M7QUFaaEMsSUFBSSxZQUFZLFdBQVcsU0FBUyxLQUFLO0FBQUEsRUFDdkMsT0FBTyxNQUFJO0FBQUEsRUFDWCxPQUFPLENBQUM7QUFBQSxFQUNSLFlBQVk7QUFDZDtBQWlCTyxTQUFTLHFCQUFxQixLQUFtQyxJQUFnQztBQUN0RyxRQUFNLGNBQWMsSUFBSSxlQUFlLEVBQUU7QUFDekMsTUFBSSxDQUFDLGFBQWE7QUFDaEIsV0FBTztBQUFBLEVBQ1Q7QUFDQSxRQUFNLFFBQVEsWUFBWSxLQUFLLE1BQU0sSUFBSTtBQUN6QyxRQUFNLGtCQUFrQixNQUFNLFlBQVksU0FBUyxTQUFLLDhCQUFnQixJQUFJLE1BQU0sNkJBQTZCLENBQUM7QUFDaEgsUUFBTSxRQUFRLG9CQUFvQixLQUFLLGVBQWU7QUFDdEQsTUFBSSxDQUFDLE9BQU87QUFDVixXQUFPO0FBQUEsRUFDVDtBQUNBLFNBQU8sTUFBTSxDQUFDLEdBQUcsS0FBSyxLQUFLO0FBQzdCOyIsCiAgIm5hbWVzIjogW10KfQo=
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL29ic2lkaWFuL01hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJ2YXIgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1sncHJvY2VzcyddID8/IHtcbiAgXCJjd2RcIjogKCk9PlwiL1wiLFxuICBcImVudlwiOiB7fSxcbiAgXCJwbGF0Zm9ybVwiOiBcImFuZHJvaWRcIlxufTtcbi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uIE1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yXG4gKiBUaGlzIG1vZHVsZSBwcm92aWRlcyB1dGlsaXR5IGZ1bmN0aW9ucyBmb3IgcHJvY2Vzc2luZyBjb2RlIGJsb2NrcyBpbiBPYnNpZGlhbi5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7XG4gIEFwcCxcbiAgTWFya2Rvd25Qb3N0UHJvY2Vzc29yQ29udGV4dFxufSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IHBhcnNlIH0gZnJvbSAnc2hlbGwtcXVvdGUnO1xuXG5pbXBvcnQgdHlwZSB7IFZhbHVlUHJvdmlkZXIgfSBmcm9tICcuLi9WYWx1ZVByb3ZpZGVyLnRzJztcblxuaW1wb3J0IHsgdGhyb3dFeHByZXNzaW9uIH0gZnJvbSAnLi4vRXJyb3IudHMnO1xuaW1wb3J0IHsgcmVzb2x2ZVZhbHVlIH0gZnJvbSAnLi4vVmFsdWVQcm92aWRlci50cyc7XG5pbXBvcnQgeyBwcm9jZXNzIH0gZnJvbSAnLi9WYXVsdC50cyc7XG5cbi8qKlxuICogUmV0cmlldmVzIHRoZSBhcmd1bWVudCBvZiBhIGNvZGUgYmxvY2sgZnJvbSB0aGUgZ2l2ZW4gTWFya2Rvd25Qb3N0UHJvY2Vzc29yQ29udGV4dCBhbmQgSFRNTEVsZW1lbnQuXG4gKlxuICogQHBhcmFtIGN0eCAtIFRoZSBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0IG9iamVjdC5cbiAqIEBwYXJhbSBlbCAtIFRoZSBIVE1MRWxlbWVudCByZXByZXNlbnRpbmcgdGhlIGNvZGUgYmxvY2suXG4gKiBAcmV0dXJucyBUaGUgYXJndW1lbnQgb2YgdGhlIGNvZGUgYmxvY2sgYXMgYSBzdHJpbmcsIG9yIG51bGwgaWYgbm8gYXJndW1lbnQgaXMgZm91bmQuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBnZXRDb2RlQmxvY2tBcmd1bWVudHMoY3R4OiBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0LCBlbDogSFRNTEVsZW1lbnQpOiBzdHJpbmdbXSB7XG4gIGNvbnN0IHNlY3Rpb25JbmZvID0gY3R4LmdldFNlY3Rpb25JbmZvKGVsKTtcbiAgaWYgKCFzZWN0aW9uSW5mbykge1xuICAgIHJldHVybiBbXTtcbiAgfVxuICBjb25zdCBsaW5lcyA9IHNlY3Rpb25JbmZvLnRleHQuc3BsaXQoJ1xcbicpO1xuICBjb25zdCBjb2RlQmxvY2tIZWFkZXIgPSBsaW5lc1tzZWN0aW9uSW5mby5saW5lU3RhcnRdID8/IHRocm93RXhwcmVzc2lvbihuZXcgRXJyb3IoJ0NvZGUgYmxvY2sgaGVhZGVyIG5vdCBmb3VuZCcpKTtcbiAgY29uc3QgbWF0Y2ggPSAvXmB7Myx9XFxTK1xccysoLiopJC8uZXhlYyhjb2RlQmxvY2tIZWFkZXIpO1xuICBpZiAoIW1hdGNoKSB7XG4gICAgcmV0dXJuIFtdO1xuICB9XG4gIHJldHVybiBwYXJzZShtYXRjaFsxXSA/PyAnJykubWFwKFN0cmluZyk7XG59XG5cbi8qKlxuICogUmVwbGFjZXMgdGhlIGNvZGUgYmxvY2suXG4gKlxuICogQHBhcmFtIGFwcCAtIFRoZSBPYnNpZGlhbiBBcHAgb2JqZWN0LlxuICogQHBhcmFtIGN0eCAtIFRoZSBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0IG9iamVjdC5cbiAqIEBwYXJhbSBlbCAtIFRoZSBIVE1MRWxlbWVudCByZXByZXNlbnRpbmcgdGhlIGNvZGUgYmxvY2suXG4gKiBAcGFyYW0gY29kZUJsb2NrUHJvdmlkZXIgLSBUaGUgVmFsdWVQcm92aWRlciB0aGF0IHByb3ZpZGVzIHRoZSBuZXcgY29kZSBibG9jay5cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIHJlcGxhY2VDb2RlQmxvY2soYXBwOiBBcHAsIGN0eDogTWFya2Rvd25Qb3N0UHJvY2Vzc29yQ29udGV4dCwgZWw6IEhUTUxFbGVtZW50LCBjb2RlQmxvY2tQcm92aWRlcjogVmFsdWVQcm92aWRlcjxzdHJpbmcsIFtzdHJpbmddPik6IFByb21pc2U8dm9pZD4ge1xuICBjb25zdCBzZWN0aW9uSW5mbyA9IGN0eC5nZXRTZWN0aW9uSW5mbyhlbCk7XG4gIGlmICghc2VjdGlvbkluZm8pIHtcbiAgICByZXR1cm47XG4gIH1cbiAgY29uc3QgbGluZXMgPSBzZWN0aW9uSW5mby50ZXh0LnNwbGl0KCdcXG4nKTtcbiAgY29uc3QgcHJlZml4ID0gbGluZXMuc2xpY2UoMCwgc2VjdGlvbkluZm8ubGluZVN0YXJ0KS5qb2luKCdcXG4nKTtcbiAgY29uc3Qgb2xkQ29kZUJsb2NrID0gbGluZXMuc2xpY2Uoc2VjdGlvbkluZm8ubGluZVN0YXJ0LCBzZWN0aW9uSW5mby5saW5lRW5kICsgMSkuam9pbignXFxuJyk7XG4gIGNvbnN0IHN1ZmZpeCA9IGxpbmVzLnNsaWNlKHNlY3Rpb25JbmZvLmxpbmVFbmQgKyAxKS5qb2luKCdcXG4nKTtcbiAgY29uc3QgbmV3Q29kZUJsb2NrID0gYXdhaXQgcmVzb2x2ZVZhbHVlKGNvZGVCbG9ja1Byb3ZpZGVyLCBvbGRDb2RlQmxvY2spO1xuICBjb25zdCBuZXdTZWN0aW9uVGV4dCA9IHByZWZpeCArICdcXG4nICsgbmV3Q29kZUJsb2NrICsgKG5ld0NvZGVCbG9jayA/ICdcXG4nIDogJycpICsgc3VmZml4O1xuICBhd2FpdCBwcm9jZXNzKGFwcCwgY3R4LnNvdXJjZVBhdGgsIChjb250ZW50KSA9PiBjb250ZW50LnJlcGxhY2Uoc2VjdGlvbkluZm8udGV4dCwgbmV3U2VjdGlvblRleHQpKTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFlQSx5QkFBc0I7QUFJdEIsbUJBQWdDO0FBQ2hDLDJCQUE2QjtBQUM3QixtQkFBd0I7QUFyQnhCLElBQUksWUFBWSxXQUFXLFNBQVMsS0FBSztBQUFBLEVBQ3ZDLE9BQU8sTUFBSTtBQUFBLEVBQ1gsT0FBTyxDQUFDO0FBQUEsRUFDUixZQUFZO0FBQ2Q7QUEwQk8sU0FBUyxzQkFBc0IsS0FBbUMsSUFBMkI7QUFDbEcsUUFBTSxjQUFjLElBQUksZUFBZSxFQUFFO0FBQ3pDLE1BQUksQ0FBQyxhQUFhO0FBQ2hCLFdBQU8sQ0FBQztBQUFBLEVBQ1Y7QUFDQSxRQUFNLFFBQVEsWUFBWSxLQUFLLE1BQU0sSUFBSTtBQUN6QyxRQUFNLGtCQUFrQixNQUFNLFlBQVksU0FBUyxTQUFLLDhCQUFnQixJQUFJLE1BQU0sNkJBQTZCLENBQUM7QUFDaEgsUUFBTSxRQUFRLG9CQUFvQixLQUFLLGVBQWU7QUFDdEQsTUFBSSxDQUFDLE9BQU87QUFDVixXQUFPLENBQUM7QUFBQSxFQUNWO0FBQ0EsYUFBTywwQkFBTSxNQUFNLENBQUMsS0FBSyxFQUFFLEVBQUUsSUFBSSxNQUFNO0FBQ3pDO0FBVUEsZUFBc0IsaUJBQWlCLEtBQVUsS0FBbUMsSUFBaUIsbUJBQW1FO0FBQ3RLLFFBQU0sY0FBYyxJQUFJLGVBQWUsRUFBRTtBQUN6QyxNQUFJLENBQUMsYUFBYTtBQUNoQjtBQUFBLEVBQ0Y7QUFDQSxRQUFNLFFBQVEsWUFBWSxLQUFLLE1BQU0sSUFBSTtBQUN6QyxRQUFNLFNBQVMsTUFBTSxNQUFNLEdBQUcsWUFBWSxTQUFTLEVBQUUsS0FBSyxJQUFJO0FBQzlELFFBQU0sZUFBZSxNQUFNLE1BQU0sWUFBWSxXQUFXLFlBQVksVUFBVSxDQUFDLEVBQUUsS0FBSyxJQUFJO0FBQzFGLFFBQU0sU0FBUyxNQUFNLE1BQU0sWUFBWSxVQUFVLENBQUMsRUFBRSxLQUFLLElBQUk7QUFDN0QsUUFBTSxlQUFlLFVBQU0sbUNBQWEsbUJBQW1CLFlBQVk7QUFDdkUsUUFBTSxpQkFBaUIsU0FBUyxPQUFPLGdCQUFnQixlQUFlLE9BQU8sTUFBTTtBQUNuRixZQUFNLHNCQUFRLEtBQUssSUFBSSxZQUFZLENBQUMsWUFBWSxRQUFRLFFBQVEsWUFBWSxNQUFNLGNBQWMsQ0FBQztBQUNuRzsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/obsidian/MarkdownCodeBlockProcessor.d.ts

@@ -2,7 +2,8 @@
  * @packageDocumentation MarkdownCodeBlockProcessor
  * This module provides utility functions for processing code blocks in Obsidian.
  */
-import type { MarkdownPostProcessorContext } from 'obsidian';
+import type { App, MarkdownPostProcessorContext } from 'obsidian';
+import type { ValueProvider } from '../ValueProvider.ts';
 /**
  * Retrieves the argument of a code block from the given MarkdownPostProcessorContext and HTMLElement.
  *
@@ -10,4 +11,13 @@ import type { MarkdownPostProcessorContext } from 'obsidian';
  * @param el - The HTMLElement representing the code block.
  * @returns The argument of the code block as a string, or null if no argument is found.
  */
-export declare function getCodeBlockArgument(ctx: MarkdownPostProcessorContext, el: HTMLElement): null | string;
+export declare function getCodeBlockArguments(ctx: MarkdownPostProcessorContext, el: HTMLElement): string[];
+/**
+ * Replaces the code block.
+ *
+ * @param app - The Obsidian App object.
+ * @param ctx - The MarkdownPostProcessorContext object.
+ * @param el - The HTMLElement representing the code block.
+ * @param codeBlockProvider - The ValueProvider that provides the new code block.
+ */
+export declare function replaceCodeBlock(app: App, ctx: MarkdownPostProcessorContext, el: HTMLElement, codeBlockProvider: ValueProvider<string, [string]>): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-dev-utils",
-  "version": "4.8.2",
+  "version": "4.9.0",
   "description": "This is the collection of useful functions that you can use for your Obsidian plugin development",
   "main": "./dist/lib/index.cjs",
   "types": "./dist/lib/index.d.ts",
@@ -45,6 +45,7 @@
     "@types/node": "^22.9.0",
     "@types/parsimmon": "^1.10.9",
     "@types/path-browserify": "^1.0.3",
+    "@types/shell-quote": "^1.7.5",
     "@typescript-eslint/eslint-plugin": "^8.14.0",
     "@typescript-eslint/parser": "^8.14.0",
     "adm-zip": "^0.5.16",
@@ -70,6 +71,7 @@
     "obsidian-typings": "^2.3.3",
     "path-browserify": "^1.0.1",
     "preact": "^10.24.3",
+    "shell-quote": "^1.8.1",
     "tsx": "^4.19.2",
     "type-fest": "^4.26.1",
     "typescript": "^5.6.3",