markdown-patch 0.1.3 → 0.2.1

package/README.md

@@ -1,111 +1,10 @@
 # Markdown Patch
 
-Have you ever needed to set up a script for modifying a markdown document and found yourself using arcane tools like `sed` before giving up entirely?
+Markdown Patch is a patch format and tool that allows you to make
+systematic changes to Markdown documents by allowing you to
+alter the content of a Markdown document relative to elements
+of that document's structure like headings or block references.
 
-Markdown Patch (`mdpatch`) is aware of the structure of your markdown document and makes it possible for you to easily inserting content relative to parts of that structure like headings and block references.
+Have you ever needed to set up a script for modifying a markdown document and found yourself using arcane tools like `sed` before giving up entirely?  This tool might be for you!
 
-## Quickstart
-
-You can install the package via `npm`:
-
-```bash
-npm install markdown-patch
-```
-
-And if you were to create a document named `document.md` with the following content:
-
-```markdown
-# Noise Floor
-
-- Some content
-
-# Discoveries
-
-# Events
-
-- Checked out of my hotel
-- Caught the flight home
-
-```
-
-Then you can use the `patch` or `apply` subcommands to alter the document.  For example, the following will add a new heading below the heading "Discoveries":
-
-```bash
-mdpatch patch append heading Discoveries ./document.md
-
-## My discovery
-I discovered a thing
-
-<Ctrl+D>
-```
-
-Your final document will then look like:
-
-```markdown
-# Noise Floor
-
-- Some content
-
-# Discoveries
-
-## My discovery
-I discovered a thing
-
-# Events
-
-- Checked out of my hotel
-- Caught the flight home
-
-```
-
-See `--help` for more insight into what commands are available.
-
-## Use as a library
-
-```ts
-import {PatchInstruction, applyPatch} from "markdown-patch"
-
-const myDocument = `
-# Noise Floor
-
-- Some content
-
-# Discoveries
-
-# Events
-
-- Checked out of my hotel
-- Caught the flight home
-
-`
-
-const instruction: PatchInstruction {
-    operation: "append",
-    targetType: "heading",
-    target: "Discoveries",
-    content: "\n## My discovery\nI discovered a thing\n",
-}
-
-console.log(
-    applyPatch(myDocument, instruction)
-)
-```
-
-and you'll see the output:
-
-```markdown
-# Noise Floor
-
-- Some content
-
-# Discoveries
-
-## My discovery
-I discovered a thing
-
-# Events
-
-- Checked out of my hotel
-- Caught the flight home
-
-```
+See docs at https://coddingtonbear.github.io/markdown-patch/.

package/dist/cli.js

@@ -105,4 +105,25 @@ program
         await fs.writeFile(options.output ? options.output : path, document);
     }
 });
+program
+    .command("query")
+    .option("-o, --output <output>", "Path to write output to; use '-' for stdout.  Defaults to patching in-place.")
+    .option("-d, --delimiter <delimiter>", "Heading delimiter to use in place of '::'.", "::")
+    .argument("<targetType>", "Target type ('heading', 'block', etc.)")
+    .argument("<target>", "Target ('::'-delimited by default for Headings); see `mdpatch print-map <path to document>` for options)")
+    .argument("<documentPath>", "Path to document to query from.")
+    .action(async (targetType, target, documentPath, options) => {
+    const document = await fs.readFile(documentPath, "utf-8");
+    const documentMap = getDocumentMap(document);
+    const actualTarget = targetType !== "heading"
+        ? target
+        : target.split(options.delimiter).join("\u001f");
+    const value = document.slice(documentMap[targetType][actualTarget].content.start, documentMap[targetType][actualTarget].content.end);
+    if (options.output) {
+        await fs.writeFile(options.output, value);
+    }
+    else {
+        process.stdout.write(value);
+    }
+});
 program.parse(process.argv);

package/dist/constants.d.ts

@@ -1,7 +1,3 @@
 export declare const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE: string[];
 export declare const CAN_INCLUDE_BLOCK_REFERENCE: string[];
-export declare enum ContentType {
-    text = "text/plain",
-    tableRows = "application/vnd.markdown-patch.table-rows+json"
-}
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sCAAsC,UAQlD,CAAC;AAEF,eAAO,MAAM,2BAA2B,UAA6B,CAAC;AAEtE,oBAAY,WAAW;IACrB,IAAI,eAAe;IACnB,SAAS,mDAAmD;CAC7D"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sCAAsC,UAQlD,CAAC;AAEF,eAAO,MAAM,2BAA2B,UAA6B,CAAC"}

package/dist/constants.js

@@ -8,8 +8,3 @@ export const TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE = [
     "image",
 ];
 export const CAN_INCLUDE_BLOCK_REFERENCE = ["paragraph", "list_item"];
-export var ContentType;
-(function (ContentType) {
-    ContentType["text"] = "text/plain";
-    ContentType["tableRows"] = "application/vnd.markdown-patch.table-rows+json";
-})(ContentType || (ContentType = {}));

package/dist/debug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,eAAO,MAAM,QAAQ,YACV,MAAM,eACF,WAAW,SACjB,MAAM,GAAG,SAAS,KACxB,IAmEF,CAAC"}
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,eAAO,MAAM,QAAQ,YACV,MAAM,eACF,WAAW,SACjB,MAAM,GAAG,SAAS,KACxB,IAiFF,CAAC"}

package/dist/debug.js

@@ -1,8 +1,17 @@
 import chalk from "chalk";
 export const printMap = (content, documentMap, regex) => {
-    for (const type in documentMap) {
-        for (const positionName in documentMap[type]) {
-            const position = documentMap[type][positionName];
+    for (const frontmatterField in documentMap.frontmatter) {
+        const blockName = `[${chalk.magenta("frontmatter")}] ${chalk.blueBright(frontmatterField)}`;
+        console.log("\n" + blockName + "\n");
+        console.log(JSON.stringify(documentMap.frontmatter[frontmatterField]));
+    }
+    const targetablePositions = {
+        heading: documentMap.heading,
+        block: documentMap.block,
+    };
+    for (const type in targetablePositions) {
+        for (const positionName in targetablePositions[type]) {
+            const position = targetablePositions[type][positionName];
             const blockName = `[${chalk.magenta(type)}] ${positionName
                 .split("\u001f")
                 .map((pos) => chalk.blueBright(pos))

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @module Reference
+ */
 export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
 export * from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -1,2 +1,5 @@
+/**
+ * @module Reference
+ */
 export { PatchFailureReason, PatchFailed, PatchError, TablePartsNotFound, applyPatch, } from "./patch.js";
 export * from "./types.js";

package/dist/map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../src/map.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EAGZ,MAAM,YAAY,CAAC;AAyLpB,eAAO,MAAM,cAAc,aAAc,MAAM,KAAG,WAQjD,CAAC"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../src/map.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,WAAW,EAIZ,MAAM,YAAY,CAAC;AA2MpB,eAAO,MAAM,cAAc,aAAc,MAAM,KAAG,WAejD,CAAC"}

package/dist/map.js

@@ -1,24 +1,12 @@
 import * as marked from "marked";
+import { parse as parseYaml } from "yaml";
 import { CAN_INCLUDE_BLOCK_REFERENCE, TARGETABLE_BY_ISOLATED_BLOCK_REFERENCE, } from "./constants.js";
-function getHeadingPositions(document, tokens) {
-    // If the document starts with frontmatter, figure out where
-    // the frontmatter ends so we can know where the text of the
-    // document begins
-    let documentStart = 0;
-    if (tokens[0].type === "hr") {
-        documentStart = tokens[0].raw.length + 1;
-        for (const token of tokens.slice(1)) {
-            documentStart += token.raw.length;
-            if (token.type === "hr") {
-                break;
-            }
-        }
-    }
+function getHeadingPositions(document, tokens, contentOffset) {
     const positions = {
         "": {
             content: {
-                start: documentStart,
-                end: document.length,
+                start: contentOffset,
+                end: document.length + contentOffset,
             },
             marker: {
                 start: 0,
@@ -51,16 +39,16 @@ function getHeadingPositions(document, tokens) {
             }
             const currentHeading = {
                 content: {
-                    start: startContent,
-                    end: endContent,
+                    start: startContent + contentOffset,
+                    end: endContent + contentOffset,
                 },
                 marker: {
-                    start: startHeading,
-                    end: endHeading,
+                    start: startHeading + contentOffset,
+                    end: endHeading + contentOffset,
                 },
                 level: headingLevel,
             };
-            // Build the full heading path with parent headings separated by '\t'
+            // Build the full heading path with parent headings separated by \u001f
             let fullHeadingPath = headingToken.text.trim();
             while (stack.length &&
                 stack[stack.length - 1].position.level >= headingLevel) {
@@ -68,7 +56,7 @@ function getHeadingPositions(document, tokens) {
             }
             if (stack.length) {
                 const parent = stack[stack.length - 1];
-                parent.position.content.end = endContent;
+                parent.position.content.end = endContent + contentOffset;
                 fullHeadingPath = `${parent.heading}\u001f${fullHeadingPath}`;
             }
             positions[fullHeadingPath] = currentHeading;
@@ -78,7 +66,7 @@ function getHeadingPositions(document, tokens) {
     });
     return positions;
 }
-function getBlockPositions(document, tokens) {
+function getBlockPositions(document, tokens, contentOffset) {
     const positions = {};
     let lastBlockDetails = undefined;
     let startContent = 0;
@@ -117,10 +105,13 @@ function getBlockPositions(document, tokens) {
                 finalStartContent.end = lastBlockDetails.end;
             }
             positions[name] = {
-                content: finalStartContent,
+                content: {
+                    start: finalStartContent.start + contentOffset,
+                    end: finalStartContent.end + contentOffset,
+                },
                 marker: {
-                    start: startMarker,
-                    end: endMarker,
+                    start: startMarker + contentOffset,
+                    end: endMarker + contentOffset,
                 },
             };
         }
@@ -134,11 +125,38 @@ function getBlockPositions(document, tokens) {
     });
     return positions;
 }
+function preProcess(document) {
+    const frontmatterRegex = /^---(?:\r\n|\r|\n)([\s\S]*?)(?:\r\n|\r|\n)---(?:\r\n|\r|\n|$)/;
+    let content;
+    let contentOffset = 0;
+    let frontmatter;
+    const match = frontmatterRegex.exec(document);
+    if (match) {
+        const frontmatterText = match[1].trim(); // Captured frontmatter content
+        contentOffset = match[0].length; // Length of the entire frontmatter section including delimiters
+        frontmatter = parseYaml(frontmatterText);
+        content = document.slice(contentOffset);
+    }
+    else {
+        content = document;
+        frontmatter = {};
+    }
+    return {
+        content,
+        contentOffset,
+        frontmatter,
+    };
+}
 export const getDocumentMap = (document) => {
+    const { frontmatter, contentOffset, content } = preProcess(document);
     const lexer = new marked.Lexer();
-    const tokens = lexer.lex(document);
+    const tokens = lexer.lex(content);
+    const lineEnding = document.indexOf("\r\n") > -1 ? "\r\n" : "\n";
     return {
-        heading: getHeadingPositions(document, tokens),
-        block: getBlockPositions(document, tokens),
+        heading: getHeadingPositions(content, tokens, contentOffset),
+        block: getBlockPositions(content, tokens, contentOffset),
+        frontmatter: frontmatter,
+        contentOffset: contentOffset,
+        lineEnding,
     };
 };

package/dist/patch.d.ts

@@ -3,7 +3,9 @@ export declare enum PatchFailureReason {
     InvalidTarget = "invalid-target",
     ContentAlreadyPreexistsInTarget = "content-already-preexists-in-target",
     TableContentIncorrectColumnCount = "table-content-incorrect-column-count",
-    RequestedBlockTypeBehaviorUnavailable = "requested-block-type-behavior-unavailable"
+    ContentTypeInvalid = "content-type-invalid",
+    ContentTypeInvalidForTarget = "content-type-invalid-for-target",
+    ContentNotMergeable = "content-not-mergeable"
 }
 export declare class PatchFailed extends Error {
     reason: PatchFailureReason;
@@ -13,7 +15,16 @@ export declare class PatchFailed extends Error {
 }
 export declare class PatchError extends Error {
 }
+export declare class MergeNotPossible extends Error {
+}
 export declare class TablePartsNotFound extends Error {
 }
+/**
+ * Applies a patch to the specified document.
+ *
+ * @param document The document to apply the patch to.
+ * @param instruction The patch to apply.
+ * @returns The patched document
+ */
 export declare const applyPatch: (document: string, instruction: PatchInstruction) => string;
 //# sourceMappingURL=patch.d.ts.map

package/dist/patch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,4BAA4B,EAE5B,gBAAgB,EAEjB,MAAM,YAAY,CAAC;AAGpB,oBAAY,kBAAkB;IAC5B,aAAa,mBAAmB;IAChC,+BAA+B,wCAAwC;IACvE,gCAAgC,yCAAyC;IACzE,qCAAqC,8CAA8C;CACpF;AAED,qBAAa,WAAY,SAAQ,KAAK;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,GAAG,IAAI,CAAC;gBAGpD,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EAAE,gBAAgB,EAC7B,SAAS,EAAE,4BAA4B,GAAG,IAAI;CAUjD;AAED,qBAAa,UAAW,SAAQ,KAAK;CAAG;AA0CxC,qBAAa,kBAAmB,SAAQ,KAAK;CAAG;AAmNhD,eAAO,MAAM,UAAU,aACX,MAAM,eACH,gBAAgB,KAC5B,MA8BF,CAAC"}
+{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":"AAGA,OAAO,EAIL,4BAA4B,EAE5B,gBAAgB,EAKjB,MAAM,YAAY,CAAC;AAUpB,oBAAY,kBAAkB;IAC5B,aAAa,mBAAmB;IAChC,+BAA+B,wCAAwC;IACvE,gCAAgC,yCAAyC;IACzE,kBAAkB,yBAAyB;IAC3C,2BAA2B,oCAAoC;IAC/D,mBAAmB,0BAA0B;CAC9C;AAED,qBAAa,WAAY,SAAQ,KAAK;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,GAAG,IAAI,CAAC;gBAGpD,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EAAE,gBAAgB,EAC7B,SAAS,EAAE,4BAA4B,GAAG,IAAI;CAUjD;AAED,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC,qBAAa,gBAAiB,SAAQ,KAAK;CAAG;AA0C9C,qBAAa,kBAAmB,SAAQ,KAAK;CAAG;AAqWhD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,aACX,MAAM,eACH,gBAAgB,KAC5B,MAoGF,CAAC"}