@remigius42/morg 0.5.0 → 0.6.0

package/dist/orgToMarkdown.js

@@ -1,11 +1,24 @@
 import { unified } from "unified";
-import uniorgParse from "uniorg-parse";
 import remarkStringify from "remark-stringify";
 import remarkGfm from "remark-gfm";
 import remarkFrontmatter from "remark-frontmatter";
 import remarkMath from "remark-math";
 import { transformUniorgAstToMdast } from "./core/uniorgToMdast/index.js";
 import { takeRecordedStyle } from "./core/markdownStyle.js";
+import { unescapeOrgMarkup } from "./core/markupBoundary.js";
+import { unescapeLineSyntax } from "./core/lineSyntax.js";
+import { unescapeFootnoteReferences } from "./core/footnoteReferences.js";
+import { parseOrg } from "./core/bracedScripts.js";
+import { dropUnderscoreBulletGuards, guardUnderscoreBullets } from "./core/underscoreBullets.js";
+// a list item's paragraph after its nested list needs a blank line, or
+// md reads it as a lazy continuation of the nested list's last item
+function separateTextAfterNestedList(left, right, parent) {
+    return parent.type === "listItem" &&
+        left.type === "list" &&
+        right.type === "paragraph"
+        ? 1
+        : undefined;
+}
 /**
  * Converts an Org-mode string to a Markdown string.
  * @param org The Org-mode string to convert.
@@ -14,10 +27,17 @@ import { takeRecordedStyle } from "./core/markdownStyle.js";
  */
 export function convertOrgToMarkdown(org, options = {}) {
     // Phase 1: Parse Org-mode to uniorg-ast
-    let uniorgAst = unified().use(uniorgParse).parse(org);
+    // md text has no scripts, so ^:{} is implied there and consumed here
+    // (see markdownToOrg); uniorg misreads `_.` lines (see underscoreBullets)
+    let uniorgAst = parseOrg(guardUnderscoreBullets(org));
+    dropUnderscoreBulletGuards(uniorgAst);
     // Phase 1b: a recorded style is morg's own (ADR 0004), so consume it so
     // it does not travel on as frontmatter; explicit options still win
     const recordedStyle = takeRecordedStyle(uniorgAst);
+    // Phase 1c: markdown needs no zero-width space escapes (inverse of md→org)
+    unescapeOrgMarkup(uniorgAst);
+    unescapeLineSyntax(uniorgAst);
+    unescapeFootnoteReferences(uniorgAst);
     // Phase 2: Extract dialect preset conventions, if any
     if (options.preset?.extractFromUniorg) {
         uniorgAst = options.preset.extractFromUniorg(uniorgAst);
@@ -46,11 +66,15 @@ export function convertOrgToMarkdown(org, options = {}) {
         rule: "-",
         ...recordedStyle,
         ...options.markdownStyle,
+        join: [separateTextAfterNestedList],
         handlers: {
             // key:: value blocks and preset inline passthroughs (e.g.
-            // wikilinks) are emitted verbatim, unescaped
+            // wikilinks) are emitted verbatim, unescaped; only a pipe inside
+            // a table cell is escaped, or it would split the cell
             keyValue: (node) => node.value,
-            verbatimInline: (node) => node.value
+            verbatimInline: (node, _parent, state) => state.stack.includes("tableCell")
+                ? node.value.replaceAll("|", "\\|")
+                : node.value
         }
     })
         .use(remarkGfm)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remigius42/morg",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Bidirectional Markdown ↔ Org-mode converter with round-trip convergence",
   "keywords": [
     "org-mode",
@@ -46,6 +46,7 @@
     "prepare": "husky",
     "prepack": "npm run build",
     "version": "node scripts/release-changelog.mjs && git add CHANGELOG.md",
+    "postversion": "printf '\\nNext:\\n  git push origin v%s\\n  wait for the Release run to pass\\n  git push\\n' \"$npm_package_version\"",
     "build": "tsc -p tsconfig.build.json",
     "build:web": "vite build web",
     "dev:web": "vite web",
@@ -61,6 +62,8 @@
     "lint:fix": "npm run lint:fix:prettier && npm run lint:fix:eslint",
     "lint:fix:prettier": "prettier --write '**/*'",
     "lint:fix:eslint": "eslint --fix '**/*.{ts,mts,js}'",
+    "perf": "npm run build && node scripts/perf/perf.mjs",
+    "perf:record": "node scripts/perf/perf.mjs --record",
     "test:unit": "vitest",
     "test:unit:ci": "vitest run --reporter default --coverage",
     "test:coverage": "vitest run --coverage",