@diplodoc/cli-tests 5.39.8 → 5.41.0

package/e2e/build-content-map.spec.ts

@@ -0,0 +1,220 @@
+import {describe, expect, test} from 'vitest';
+import {cp, mkdtemp, readFile, realpath, writeFile} from 'node:fs/promises';
+import {tmpdir} from 'node:os';
+import {join} from 'node:path';
+
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+const buildContentTestTemplate = (testTitle: string, testRootPath: string, extraArgs = '') => {
+    test(testTitle, async () => {
+        const {inputPath, outputPath} = getTestPaths(testRootPath);
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: `--build-content ${extraArgs}`.trim(),
+        });
+
+        const contentMap = await readFile(join(outputPath, 'yfm-build-content.json'), 'utf-8');
+
+        expect(JSON.parse(contentMap)).toMatchSnapshot();
+    });
+};
+
+describe('Build content map for', () => {
+    buildContentTestTemplate(
+        'project with an include and a picture (mergeIncludes off)',
+        'mocks/build-content-map/with-includes',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'project with an include and a picture (mergeIncludes on)',
+        'mocks/build-content-map/with-includes',
+        '--merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'project with autotitle links between pages (mergeIncludes off)',
+        'mocks/build-content-map/with-autotitles',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'project with autotitle links between pages (mergeIncludes on)',
+        'mocks/build-content-map/with-autotitles',
+        '--merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'nested includes (hashIncludes default, mergeIncludes off)',
+        'mocks/build-content-map/nested-includes',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'nested includes (mergeIncludes on)',
+        'mocks/build-content-map/nested-includes',
+        '--merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'diamond includes (hashIncludes default, mergeIncludes off)',
+        'mocks/build-content-map/diamond-includes',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'diamond includes (mergeIncludes on)',
+        'mocks/build-content-map/diamond-includes',
+        '--merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'autotitle chain (hashIncludes default, mergeIncludes off)',
+        'mocks/build-content-map/autotitle-chain',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'autotitle chain (mergeIncludes on)',
+        'mocks/build-content-map/autotitle-chain',
+        '--merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'autotitle target with include (hashIncludes default, mergeIncludes off)',
+        'mocks/build-content-map/autotitle-target-with-include',
+        '--no-merge-includes',
+    );
+
+    buildContentTestTemplate(
+        'autotitle target with include (mergeIncludes on)',
+        'mocks/build-content-map/autotitle-target-with-include',
+        '--merge-includes',
+    );
+});
+
+describe('Build content map propagation', () => {
+    test('mutating an include propagates to parent hashes (mergeIncludes: false, hashIncludes: true)', async () => {
+        const fixtureRoot = getTestPaths('mocks/build-content-map/nested-includes').inputPath;
+        // realpath() canonicalizes macOS /var → /private/var symlink so the
+        // build's scope checks (which compare against fs.realpath() results)
+        // line up with the configured input/output paths.
+        const work = await realpath(
+            await mkdtemp(join(tmpdir(), 'yfm-build-content-propagation-')),
+        );
+        const inputBefore = join(work, 'input-before');
+        const inputAfter = join(work, 'input-after');
+        const before = join(work, 'before');
+        const after = join(work, 'after');
+
+        await cp(fixtureRoot, inputBefore, {recursive: true});
+        await cp(fixtureRoot, inputAfter, {recursive: true});
+
+        await writeFile(
+            join(inputAfter, '_includes/level2.md'),
+            '# Level 2 mutated\n\nNew body for the deepest include.\n',
+        );
+
+        await TestAdapter.testBuildPass(inputBefore, before, {
+            md2md: true,
+            md2html: false,
+            args: '--build-content --no-merge-includes',
+        });
+        await TestAdapter.testBuildPass(inputAfter, after, {
+            md2md: true,
+            md2html: false,
+            args: '--build-content --no-merge-includes',
+        });
+
+        const beforeManifest = JSON.parse(
+            await readFile(join(before, 'yfm-build-content.json'), 'utf-8'),
+        );
+        const afterManifest = JSON.parse(
+            await readFile(join(after, 'yfm-build-content.json'), 'utf-8'),
+        );
+
+        // level2.md changed → its hash differs
+        expect(beforeManifest.contentHashes['_includes/level2.md'].hash).not.toBe(
+            afterManifest.contentHashes['_includes/level2.md'].hash,
+        );
+
+        // level1.md transitively references level2 via signlink → name change
+        // propagates into level1.md's body → its hash differs.
+        expect(beforeManifest.contentHashes['_includes/level1.md'].hash).not.toBe(
+            afterManifest.contentHashes['_includes/level1.md'].hash,
+        );
+
+        // index.md references level1 via signlink → name change cascades → its
+        // hash differs.
+        expect(beforeManifest.contentHashes['index.md'].hash).not.toBe(
+            afterManifest.contentHashes['index.md'].hash,
+        );
+
+        // toc.yaml and .yfm are untouched → identical
+        expect(beforeManifest.contentHashes['toc.yaml']?.hash).toBe(
+            afterManifest.contentHashes['toc.yaml']?.hash,
+        );
+        expect(beforeManifest.contentHashes['.yfm']?.hash).toBe(
+            afterManifest.contentHashes['.yfm']?.hash,
+        );
+    });
+
+    test('mutating an include propagates to parent hashes (mergeIncludes: true)', async () => {
+        const fixtureRoot = getTestPaths('mocks/build-content-map/nested-includes').inputPath;
+        const work = await realpath(
+            await mkdtemp(join(tmpdir(), 'yfm-build-content-propagation-merge-')),
+        );
+        const inputBefore = join(work, 'input-before');
+        const inputAfter = join(work, 'input-after');
+        const before = join(work, 'before');
+        const after = join(work, 'after');
+
+        await cp(fixtureRoot, inputBefore, {recursive: true});
+        await cp(fixtureRoot, inputAfter, {recursive: true});
+
+        await writeFile(
+            join(inputAfter, '_includes/level2.md'),
+            '# Level 2 mutated\n\nNew body for the deepest include.\n',
+        );
+
+        await TestAdapter.testBuildPass(inputBefore, before, {
+            md2md: true,
+            md2html: false,
+            args: '--build-content --merge-includes',
+        });
+        await TestAdapter.testBuildPass(inputAfter, after, {
+            md2md: true,
+            md2html: false,
+            args: '--build-content --merge-includes',
+        });
+
+        const beforeManifest = JSON.parse(
+            await readFile(join(before, 'yfm-build-content.json'), 'utf-8'),
+        );
+        const afterManifest = JSON.parse(
+            await readFile(join(after, 'yfm-build-content.json'), 'utf-8'),
+        );
+
+        // With merge: level2.md and level1.md don't exist in output anymore,
+        // their content is inlined into index.md.
+        expect(beforeManifest.contentHashes['_includes/level2.md']).toBeUndefined();
+        expect(afterManifest.contentHashes['_includes/level2.md']).toBeUndefined();
+        expect(beforeManifest.contentHashes['_includes/level1.md']).toBeUndefined();
+        expect(afterManifest.contentHashes['_includes/level1.md']).toBeUndefined();
+
+        // index.md hash differs because the inlined level2 content changed.
+        expect(beforeManifest.contentHashes['index.md'].hash).not.toBe(
+            afterManifest.contentHashes['index.md'].hash,
+        );
+
+        // toc.yaml and .yfm unchanged.
+        expect(beforeManifest.contentHashes['toc.yaml']?.hash).toBe(
+            afterManifest.contentHashes['toc.yaml']?.hash,
+        );
+        expect(beforeManifest.contentHashes['.yfm']?.hash).toBe(
+            afterManifest.contentHashes['.yfm']?.hash,
+        );
+    });
+});

package/mocks/build-content-map/autotitle-chain/input/a.md

@@ -0,0 +1,3 @@
+# A page title
+
+See [{#T}](b.md) for the next step.

package/mocks/build-content-map/autotitle-chain/input/b.md

@@ -0,0 +1,3 @@
+# B page title
+
+See [{#T}](c.md) to continue the chain.

package/mocks/build-content-map/autotitle-chain/input/c.md

@@ -0,0 +1,3 @@
+# C page title
+
+Final page in the autotitle chain.

package/mocks/build-content-map/autotitle-chain/input/toc.yaml

@@ -0,0 +1,9 @@
+title: Build content map - autotitle chain
+href: a.md
+items:
+  - name: A
+    href: a.md
+  - name: B
+    href: b.md
+  - name: C
+    href: c.md

package/mocks/build-content-map/autotitle-target-with-include/input/_includes/snippet.md

@@ -0,0 +1,3 @@
+# Snippet heading
+
+Reusable snippet body for the B page.

package/mocks/build-content-map/autotitle-target-with-include/input/a.md

@@ -0,0 +1,3 @@
+# A page title
+
+See [{#T}](b.md) for the snippet section.

package/mocks/build-content-map/autotitle-target-with-include/input/b.md

@@ -0,0 +1,3 @@
+# B page title
+
+{% include [Snippet](_includes/snippet.md) %}

package/mocks/build-content-map/autotitle-target-with-include/input/toc.yaml

@@ -0,0 +1,7 @@
+title: Build content map - autotitle target with include
+href: a.md
+items:
+  - name: A
+    href: a.md
+  - name: B
+    href: b.md

package/mocks/build-content-map/diamond-includes/input/_includes/branch-a.md

@@ -0,0 +1,5 @@
+# Branch A
+
+First branch pulling in the shared leaf.
+
+{% include [Shared](shared.md) %}

package/mocks/build-content-map/diamond-includes/input/_includes/branch-b.md

@@ -0,0 +1,5 @@
+# Branch B
+
+Second branch pulling in the shared leaf.
+
+{% include [Shared](shared.md) %}

package/mocks/build-content-map/diamond-includes/input/_includes/shared.md

@@ -0,0 +1,3 @@
+# Shared leaf
+
+Shared content reused by both branches.

package/mocks/build-content-map/diamond-includes/input/index.md

@@ -0,0 +1,7 @@
+# Diamond root
+
+Pulls in two branches that share a leaf.
+
+{% include [Branch A](_includes/branch-a.md) %}
+
+{% include [Branch B](_includes/branch-b.md) %}

package/mocks/build-content-map/diamond-includes/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Build content map - diamond includes
+href: index.md
+items:
+  - name: Index
+    href: index.md

package/mocks/build-content-map/nested-includes/input/_includes/level1.md

@@ -0,0 +1,5 @@
+# Level 1 intermediate
+
+Intermediate snippet that pulls in a deeper one.
+
+{% include [Level2](level2.md) %}

package/mocks/build-content-map/nested-includes/input/_includes/level2.md

@@ -0,0 +1,3 @@
+# Level 2 leaf
+
+Deepest snippet with the actual leaf content.

package/mocks/build-content-map/nested-includes/input/index.md

@@ -0,0 +1,5 @@
+# Nested includes root
+
+Top-level entry page that pulls in a chained include.
+
+{% include [Level1](_includes/level1.md) %}

package/mocks/build-content-map/nested-includes/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Build content map - nested includes
+href: index.md
+items:
+  - name: Index
+    href: index.md

package/mocks/build-content-map/with-autotitles/input/index.md

@@ -0,0 +1,3 @@
+# Index page
+
+See [{#T}](other.md) for more.

package/mocks/build-content-map/with-autotitles/input/other.md

@@ -0,0 +1,3 @@
+# Other page title
+
+Body of other.

package/mocks/build-content-map/with-autotitles/input/toc.yaml

@@ -0,0 +1,7 @@
+title: Build content map - autotitles
+href: index.md
+items:
+  - name: Index
+    href: index.md
+  - name: Other
+    href: other.md

package/mocks/build-content-map/with-includes/input/_includes/snippet.md

@@ -0,0 +1 @@
+Reusable snippet content.

package/mocks/build-content-map/with-includes/input/index.md

@@ -0,0 +1,5 @@
+# Index page
+
+{% include [Snippet](_includes/snippet.md) %}
+
+![Diplodoc logo](logo.svg){inline=false}

package/mocks/build-content-map/with-includes/input/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="158" height="32" fill="none"><path fill="#1D4634" fill-rule="evenodd" d="M42.03 25.795h7.225q3.25 0 5.56-1.258a8.5 8.5 0 0 0 3.55-3.61q1.24-2.352 1.24-5.624 0-3.263-1.229-5.604-1.228-2.342-3.519-3.59-2.28-1.257-5.456-1.257H42.03zm7.038-3.283h-3.176V8.134h3.29q2.166 0 3.624.798 1.468.787 2.218 2.383.75 1.584.75 3.988t-.75 4.008q-.75 1.596-2.239 2.403-1.49.798-3.717.798m12.868-12.425v15.708h3.769V10.087zm6.472 21.598V10.087h3.707v2.598h.219q.291-.573.822-1.217.531-.655 1.437-1.115.906-.47 2.311-.47 1.854 0 3.343.93 1.499.921 2.374 2.73.885 1.8.885 4.419 0 2.586-.865 4.397-.864 1.81-2.353 2.76-1.489.952-3.373.952-1.375 0-2.28-.45-.906-.45-1.458-1.084a7 7 0 0 1-.844-1.217h-.156v8.365zm3.696-13.744q0 1.524.438 2.669.447 1.145 1.28 1.79.844.633 2.041.634 1.249 0 2.093-.655.844-.664 1.27-1.81.438-1.155.438-2.628 0-1.462-.427-2.597t-1.27-1.78-2.104-.644q-1.208 0-2.051.624t-1.28 1.748q-.428 1.125-.428 2.649m17.226 7.854V4.852h-3.77v20.943zm9.68.306q-2.344 0-4.062-1.012-1.717-1.013-2.665-2.833-.937-1.82-.937-4.254t.937-4.264q.948-1.83 2.665-2.843 1.72-1.012 4.061-1.012 2.343 0 4.061 1.012t2.655 2.843q.948 1.83.947 4.264 0 2.434-.947 4.254-.937 1.82-2.655 2.833-1.719 1.012-4.06 1.012m.02-2.965q1.27 0 2.124-.685.854-.696 1.27-1.861.427-1.166.427-2.598 0-1.441-.427-2.608-.416-1.176-1.27-1.87-.853-.696-2.124-.696-1.302 0-2.166.695-.854.696-1.28 1.871-.417 1.167-.417 2.608 0 1.432.416 2.598.427 1.165 1.281 1.86.864.686 2.166.686m12.23 1.984q1.489.95 3.374.95 1.374 0 2.28-.45t1.458-1.083a6.3 6.3 0 0 0 .843-1.217h.229v2.475h3.707V4.852h-3.78v7.833h-.156a6.8 6.8 0 0 0-.823-1.217q-.531-.655-1.436-1.115-.906-.47-2.312-.47-1.844 0-3.342.93-1.5.921-2.385 2.73-.874 1.8-.874 4.419 0 2.586.864 4.397.864 1.81 2.353 2.76m6.466-2.72q-.843.633-2.041.634-1.239 0-2.093-.655-.843-.664-1.28-1.81-.427-1.155-.427-2.628 0-1.462.427-2.597t1.27-1.78 2.103-.644q1.218 0 2.051.624.844.624 1.271 1.748.437 1.125.437 2.649t-.437 2.669q-.438 1.145-1.281 1.79m15.245 3.701q-2.343 0-4.061-1.012-1.719-1.013-2.666-2.833-.936-1.82-.937-4.254 0-2.433.937-4.264.948-1.83 2.666-2.843t4.061-1.012q2.342 0 4.06 1.012 1.719 1.013 2.655 2.843.948 1.83.948 4.264t-.948 4.254q-.936 1.82-2.655 2.833-1.718 1.012-4.06 1.012m.02-2.965q1.27 0 2.124-.685.854-.696 1.271-1.861.427-1.166.427-2.598 0-1.441-.427-2.608-.417-1.176-1.271-1.87-.853-.696-2.124-.696-1.3 0-2.165.695-.854.696-1.281 1.871-.417 1.167-.417 2.608 0 1.432.417 2.598.427 1.165 1.281 1.86.864.686 2.165.686m12.533 1.933q1.718 1.032 4.112 1.032 2.01 0 3.499-.715 1.488-.726 2.353-2.005.864-1.288.999-2.955h-3.602q-.167.848-.614 1.442-.448.593-1.115.91-.656.307-1.488.307-1.178 0-2.052-.614-.864-.623-1.343-1.769-.479-1.155-.479-2.761 0-1.585.479-2.72.49-1.135 1.364-1.739.874-.613 2.031-.613 1.363 0 2.176.767a3.37 3.37 0 0 1 1.041 1.892h3.602q-.124-1.698-1.02-2.966-.896-1.278-2.405-1.974-1.5-.705-3.447-.705-2.342 0-4.06 1.033-1.708 1.022-2.645 2.863-.937 1.83-.937 4.223 0 2.383.916 4.214a6.94 6.94 0 0 0 2.635 2.853M61.912 4.856V7.63h3.797V4.856z" clip-rule="evenodd"/><path fill="#63D490" fill-rule="evenodd" d="M17.61 0h-7.157a.94.94 0 0 0-.941.942v5.717H.942A.94.94 0 0 0 0 7.6v23.457c0 .52.422.942.942.942h19.116c.52 0 .941-.422.941-.942v-5.624h8.57c.52 0 .942-.422.942-.942V12.9C30.51 5.776 24.735 0 17.61 0M21 25.434V7.6a.94.94 0 0 0-.942-.942H9.512v17.833c0 .52.421.942.941.942z" clip-rule="evenodd"/></svg>

package/mocks/build-content-map/with-includes/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Build content map - includes
+href: index.md
+items:
+  - name: Index
+    href: index.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/cli-tests",
-  "version": "5.39.8",
+  "version": "5.41.0",
   "bin": {
     "diplodoc-cli-test": "bin.mjs"
   },