feat: enable usePrettyRefs for nextJS publishing and preview (#1239)

* feat: support usePrettyRef config * fix: handle cases for MD_DENDRON and MD_REGULAR * chore: update snapshots * chore: add tests for preview and publishing * chore: use getProps for getting config keys * fix: wrong import * add default config for usePrettyRef * chore: update snapshot * chore: fix broken tests * chore: fix broken test
dendronhq · Sep 1, 2021 · 8a456a9 · 8a456a9
1 parent 66111a1
commit 8a456a9
Show file tree

Hide file tree

Showing 9 changed files with 337 additions and 139 deletions.
diff --git a/packages/engine-server/src/config.ts b/packages/engine-server/src/config.ts
@@ -50,6 +50,7 @@ export class DConfig {
       mermaid: true,
       useKatex: true,
       autoFoldFrontmatter: true,
+      usePrettyRefs: true,
       dev: {
         enablePreviewV2: true,
       },

diff --git a/packages/engine-server/src/markdown/remark/dendronPub.ts b/packages/engine-server/src/markdown/remark/dendronPub.ts
@@ -252,7 +252,6 @@ function plugin(this: Unified.Processor, opts?: PluginOpts): Transformer {
         const ndata = node.data as NoteRefDataV4;
         const copts: NoteRefsOpts = {
           wikiLinkOpts: opts?.wikiLinkOpts,
-          prettyRefs: opts?.prettyRefs,
         };
         const procOpts = MDUtilsV4.getProcOpts(proc);
         const { data } = convertNoteRefASTV2({

diff --git a/packages/engine-server/src/markdown/remark/noteRefsV2.ts b/packages/engine-server/src/markdown/remark/noteRefsV2.ts
@@ -16,6 +16,7 @@ import {
 import { file2Note } from "@dendronhq/common-server";
 import _ from "lodash";
 import { brk, html, paragraph, root } from "mdast-builder";
+import { DConfig } from "../../config";
 import { Eat } from "remark-parse";
 import Unified, { Plugin } from "unified";
 import { Node, Parent } from "unist";
@@ -306,39 +307,41 @@ export function convertNoteRefASTV2(
   const refLvl = MDUtilsV4.getNoteRefLvl(proc());
   let { dest, vault, config, shouldApplyPublishRules } =
     MDUtilsV4.getDendronData(proc);
-
   if (MDUtilsV5.isV5Active(proc)) {
     shouldApplyPublishRules = MDUtilsV5.shouldApplyPublishingRules(proc);
   }
-
   if (link.data.vaultName) {
     vault = VaultUtils.getVaultByNameOrThrow({
       vaults: engine.vaults,
       vname: link.data.vaultName,
     })!;
   }
-
   if (!vault) {
     return {
       error: new DendronError({ message: "no vault specified" }),
       data: [],
     };
   }
-  let { prettyRefs, wikiLinkOpts } = compilerOpts;
+  const { wikiLinkOpts } = compilerOpts;
+  const sitePrettyRefConfig = DConfig.getProp(procOpts.config, "site").usePrettyRefs;
+  const prettyRefConfig = DConfig.getProp(procOpts.config, "usePrettyRefs");
+  let prettyRefs = shouldApplyPublishRules
+    ? sitePrettyRefConfig
+    : prettyRefConfig
   if (
-    !prettyRefs &&
-    _.includes([DendronASTDest.HTML, DendronASTDest.MD_ENHANCED_PREVIEW], dest)
+    prettyRefs && _.includes(
+      [DendronASTDest.MD_DENDRON, DendronASTDest.MD_REGULAR], 
+      dest
+    )
   ) {
-    prettyRefs = true;
+    prettyRefs = false;
   }
-
   if (refLvl >= MAX_REF_LVL) {
     return {
       error: new DendronError({ message: "too many nested note refs" }),
       data: [MDUtilsV4.genMDMsg("too many nested note refs")],
     };
   }
-
   let noteRefs: DNoteLoc[] = [];
   if (link.from.fname.endsWith("*")) {
     const resp = engine.queryNotesSync({ qs: link.from.fname, vault });

diff --git a/...e-test-utils/src/__tests__/dendron-cli/commands/__snapshots__/seedCLICommand.spec.ts.snap b/...e-test-utils/src/__tests__/dendron-cli/commands/__snapshots__/seedCLICommand.spec.ts.snap
@@ -34,6 +34,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -121,6 +122,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -198,6 +200,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -242,6 +245,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -303,6 +307,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:

diff --git a/packages/engine-test-utils/src/__tests__/engine-server/__snapshots__/seedSvc.spec.ts.snap b/packages/engine-test-utils/src/__tests__/engine-server/__snapshots__/seedSvc.spec.ts.snap
@@ -28,6 +28,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -115,6 +116,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -192,6 +194,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -236,6 +239,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -297,6 +301,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -365,6 +370,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:
@@ -420,6 +426,7 @@ lookupConfirmVaultOnCreate: false
 mermaid: true
 useKatex: true
 autoFoldFrontmatter: true
+usePrettyRefs: true
 dev:
     enablePreviewV2: true
 lookup:

diff --git a/...ine-test-utils/src/__tests__/engine-server/markdown/__snapshots__/dendronPub.spec.ts.snap b/...ine-test-utils/src/__tests__/engine-server/markdown/__snapshots__/dendronPub.spec.ts.snap
@@ -192,3 +192,139 @@ VFile {
   "messages": Array [],
 }
 `;
+
+exports[`dendronPub usePrettyRefs config.site.usePrettyRef: false 1`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#foo\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Foo</h1>
+<p></p><p></p><p>bar body</p><p></p><p></p>
+<hr>
+<h2 id=\\"children\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#children\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Children</h2>
+<ol>
+<li><a href=\\"/notes/foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;
+
+exports[`dendronPub usePrettyRefs config.site.usePrettyRef: true 1`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#foo\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Foo</h1>
+<p></p><p></p><div class=\\"portal-container\\">
+<div class=\\"portal-head\\">
+<div class=\\"portal-backlink\\">
+<div class=\\"portal-title\\">From <span class=\\"portal-text-title\\">Bar</span></div>
+
+</div>
+</div>
+<div id=\\"portal-parent-anchor\\" class=\\"portal-parent\\" markdown=\\"1\\">
+<div class=\\"portal-parent-fader-top\\"></div>
+<div class=\\"portal-parent-fader-bottom\\"></div><p>bar body</p>
+</div></div><p></p><p></p>
+<hr>
+<h2 id=\\"children\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#children\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Children</h2>
+<ol>
+<li><a href=\\"/notes/foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;
+
+exports[`dendronPub usePrettyRefs config.usePrettyRef: false 1`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\">Foo</h1>
+<p></p><p></p><p>bar body</p><p></p><p></p>
+<hr>
+<h2 id=\\"children\\">Children</h2>
+<ol>
+<li><a href=\\"foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;
+
+exports[`dendronPub usePrettyRefs config.usePrettyRef: true 1`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\">Foo</h1>
+<p></p><p></p><div class=\\"portal-container\\">
+<div class=\\"portal-head\\">
+<div class=\\"portal-backlink\\">
+<div class=\\"portal-title\\">From <span class=\\"portal-text-title\\">Bar</span></div>
+<a href=\\"bar.html\\" class=\\"portal-arrow\\">Go to text <span class=\\"right-arrow\\">→</span></a>
+</div>
+</div>
+<div id=\\"portal-parent-anchor\\" class=\\"portal-parent\\" markdown=\\"1\\">
+<div class=\\"portal-parent-fader-top\\"></div>
+<div class=\\"portal-parent-fader-bottom\\"></div><p>bar body</p>
+</div></div><p></p><p></p>
+<hr>
+<h2 id=\\"children\\">Children</h2>
+<ol>
+<li><a href=\\"foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;
+
+exports[`dendronPub usePrettyRefs usePrettyRef defaults to true in both cases 1`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\">Foo</h1>
+<p></p><p></p><div class=\\"portal-container\\">
+<div class=\\"portal-head\\">
+<div class=\\"portal-backlink\\">
+<div class=\\"portal-title\\">From <span class=\\"portal-text-title\\">Bar</span></div>
+<a href=\\"bar.html\\" class=\\"portal-arrow\\">Go to text <span class=\\"right-arrow\\">→</span></a>
+</div>
+</div>
+<div id=\\"portal-parent-anchor\\" class=\\"portal-parent\\" markdown=\\"1\\">
+<div class=\\"portal-parent-fader-top\\"></div>
+<div class=\\"portal-parent-fader-bottom\\"></div><p>bar body</p>
+</div></div><p></p><p></p>
+<hr>
+<h2 id=\\"children\\">Children</h2>
+<ol>
+<li><a href=\\"foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;
+
+exports[`dendronPub usePrettyRefs usePrettyRef defaults to true in both cases 2`] = `
+VFile {
+  "contents": "<h1 id=\\"foo\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#foo\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Foo</h1>
+<p></p><p></p><div class=\\"portal-container\\">
+<div class=\\"portal-head\\">
+<div class=\\"portal-backlink\\">
+<div class=\\"portal-title\\">From <span class=\\"portal-text-title\\">Bar</span></div>
+<a href=\\"/notes/bar.html\\" class=\\"portal-arrow\\">Go to text <span class=\\"right-arrow\\">→</span></a>
+</div>
+</div>
+<div id=\\"portal-parent-anchor\\" class=\\"portal-parent\\" markdown=\\"1\\">
+<div class=\\"portal-parent-fader-top\\"></div>
+<div class=\\"portal-parent-fader-bottom\\"></div><p>bar body</p>
+</div></div><p></p><p></p>
+<hr>
+<h2 id=\\"children\\"><a aria-hidden=\\"true\\" class=\\"anchor-heading\\" href=\\"#children\\"><svg aria-hidden=\\"true\\" viewBox=\\"0 0 16 16\\"><use xlink:href=\\"#svg-link\\"></use></svg></a>Children</h2>
+<ol>
+<li><a href=\\"/notes/foo.ch1.html\\">Ch1</a></li>
+</ol>",
+  "cwd": "<PROJECT_ROOT>",
+  "data": Object {},
+  "history": Array [],
+  "messages": Array [],
+}
+`;