@diplodoc/cli-tests 0.0.0-rc-reusable-e2es-202504041505

package/bin.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import {spawn} from 'node:child_process';
+import {dirname, join, resolve} from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {createRequire} from 'node:module';
+
+const require = createRequire(import.meta.url);
+const vitestPath = require.resolve('vitest');
+
+const vitest = spawn(
+    join(dirname(vitestPath), 'vitest.mjs'),
+    [
+        'run',
+        '--config',
+        resolve(dirname(fileURLToPath(import.meta.url)), 'vitest.config.ts'),
+        ...process.argv.slice(2),
+    ],
+    {
+        stdio: 'inherit',
+        env: {
+            ...process.env,
+            NODE_ENV: 'test',
+        },
+    },
+);
+
+vitest.on('exit', (code) => {
+    process.exit(code || 0);
+});

package/e2e/__snapshots__/generate-map.spec.ts.snap

@@ -0,0 +1,63 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Generate map for > project with external links in toc 1`] = `
+"{
+	"files": [
+		"ru/",
+		"ru/folder1/a1",
+		"ru/folder1/folder2/a1",
+		"ru/plugins/",
+		"ru/project/",
+		"ru/settings"
+	]
+}"
+`;
+
+exports[`Generate map for > project with multiple language 1`] = `
+"{
+	"files": [
+		"en/",
+		"en/plugins/",
+		"en/plugins/import",
+		"en/project/",
+		"en/project/config",
+		"en/settings",
+		"ru/",
+		"ru/plugins/",
+		"ru/plugins/import",
+		"ru/project/",
+		"ru/project/config",
+		"ru/settings"
+	]
+}"
+`;
+
+exports[`Generate map for > project with single language and toc include - only md2html 1`] = `
+"{
+	"files": [
+		"ru/",
+		"ru/folder1/a1",
+		"ru/folder1/folder2/a1",
+		"ru/plugins/",
+		"ru/plugins/import",
+		"ru/project/",
+		"ru/project/config",
+		"ru/settings"
+	]
+}"
+`;
+
+exports[`Generate map for > project with single language and toc include 1`] = `
+"{
+	"files": [
+		"ru/",
+		"ru/folder1/a1",
+		"ru/folder1/folder2/a1",
+		"ru/plugins/",
+		"ru/plugins/import",
+		"ru/project/",
+		"ru/project/config",
+		"ru/settings"
+	]
+}"
+`;

package/e2e/__snapshots__/include-toc.test.ts.snap

@@ -0,0 +1,464 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > filelist 1`] = `
+"[
+  "product1/_includes/inc.md",
+  "product1/article1.md",
+  "product1/toc.yaml",
+  "product2/overlay1/_includes/inc.md",
+  "product2/overlay1/article1.md",
+  "product2/overlay2/_includes/inc.md",
+  "product2/overlay2/article1.md",
+  "product2/overlay3/_includes/inc.md",
+  "product2/overlay3/article1.md",
+  "product2/p2.md",
+  "product2/toc.yaml"
+]"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product1/_includes/inc.md 1`] = `"This is the core include."`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product1/article1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: product1/core/article1.md
+---
+This is the core content of Article 1.
+
+{% include [x](_includes/inc.md) %}
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product1/toc.yaml 1`] = `
+"title: Product 1 title
+items:
+  - name: Article1
+    href: article1.md
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay1/_includes/inc.md 1`] = `
+"This is the core include.
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay1/article1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: product2/overlay1/product/article1.md
+---
+This is the overlay content of Article 1 for product 2.
+
+{% include [x](_includes/inc.md) %}
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay2/_includes/inc.md 1`] = `
+"This is the core include.
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay2/article1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: product2/overlay2/product/article1.md
+---
+This is the overlay number #2  of Article 1 content for product 2.
+
+{% include [x](_includes/inc.md) %}
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay3/_includes/inc.md 1`] = `
+"This is the core include.
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/overlay3/article1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: product2/core/article1.md
+---
+This is the core content of Article 1.
+
+{% include [x](_includes/inc.md) %}
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/p2.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+This is the product 2 specific article.
+
+Check here link to [Article1 overlay 1](overlay1/article1.md)
+Check here link to [Article1 overlay 2](overlay2/article1.md)"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes > product2/toc.yaml 1`] = `
+"title: Product 2 title
+items:
+  - name: P2 Article
+    href: p2.md
+  - name: Overlay1
+    items:
+      - name: Article1
+        href: overlay1/article1.md
+  - name: Overlay 2
+    items:
+      - name: Article1
+        href: overlay2/article1.md
+  - name: Overlay 3
+    items:
+      - name: Article1
+        href: overlay3/article1.md
+"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes 2 > filelist 1`] = `
+"[
+  "toc.yaml"
+]"
+`;
+
+exports[`Include toc > Nested toc inclusions with mixed including modes 2 > toc.yaml 1`] = `
+"title: main
+items:
+  - name: toc_i/item
+  - name: core/toc_m/item
+  - name: overlay/toc_p/item
+  - name: core/toc_i/item
+  - name: test
+    items:
+      - name: core/concepts/toc_i/item
+      - name: core/concepts/toc_p/item
+"
+`;
+
+exports[`Include toc > Toc is included in link mode > a1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+This is the /a1.md file content.
+"
+`;
+
+exports[`Include toc > Toc is included in link mode > filelist 1`] = `
+"[
+  "a1.md",
+  "folder1/a1.md",
+  "folder1/folder2/a1.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`Include toc > Toc is included in link mode > folder1/a1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+This is the /folder1/a1.md file content.
+"
+`;
+
+exports[`Include toc > Toc is included in link mode > folder1/folder2/a1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+This is the /folder1/folder1/a1.md file content.
+"
+`;
+
+exports[`Include toc > Toc is included in link mode > toc.yaml 1`] = `
+"items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    items:
+      - name: A1
+        href: folder1/a1.md
+      - name: folder1
+        items:
+          - name: A1
+            href: folder1/folder2/a1.md
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > .yfm 1`] = `
+"applyPresets: true
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > file1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# File 1
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > fileA.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: folder/fileA.md
+title: File A
+description: YFM description
+---
+# File A
+
+---
+
+Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
+
+---
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > fileB.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: folder/fileB.md
+---
+# File B
+
+Lorem Ipsum is simply dummy text of the printing and typesetting industry.
+
+---
+
+Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
+
+---
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > fileC.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+sourcePath: folder/folder/fileC.md
+---
+# File C
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > fileX.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# File X
+"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > filelist 1`] = `
+"[
+  ".yfm",
+  "file1.md",
+  "fileA.md",
+  "fileB.md",
+  "fileC.md",
+  "fileX.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`Include toc > Toc is included inline, not as a new section > toc.yaml 1`] = `
+"items:
+  - name: Name1
+    href: file1.md
+  - name: NameA
+    href: fileA.md
+  - name: NameB
+    href: fileB.md
+  - name: NameC
+    href: fileC.md
+  - name: NameX
+    href: fileX.md
+"
+`;
+
+exports[`Include toc > Toc root merge on non root dir > .yfm 1`] = `
+"allowHtml: true
+"
+`;
+
+exports[`Include toc > Toc root merge on non root dir > filelist 1`] = `
+"[
+  ".yfm",
+  "ru/index.yaml",
+  "ru/toc.yaml"
+]"
+`;
+
+exports[`Include toc > Toc root merge on non root dir > ru/index.yaml 1`] = `
+"blocks:
+  - type: header-block
+    title: Title
+    description: Description
+links: []
+meta:
+  metadata:
+    - name: generator
+      content: Diplodoc Platform vDIPLODOC-VERSION
+  sourcePath: ru/sub/folder/index.yaml
+"
+`;
+
+exports[`Include toc > Toc root merge on non root dir > ru/toc.yaml 1`] = `
+"title: Toc
+items:
+  - name: sub-page
+    href: index.yaml
+"
+`;
+
+exports[`Include toc > Toc with expressions > a1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+This is the /a1.md file content.
+"
+`;
+
+exports[`Include toc > Toc with expressions > filelist 1`] = `
+"[
+  "a1.md",
+  "index.yaml",
+  "toc.yaml"
+]"
+`;
+
+exports[`Include toc > Toc with expressions > index.yaml 1`] = `
+"title: Title A
+description:
+  - Desc A
+meta:
+  metadata:
+    - name: generator
+      content: Diplodoc Platform vDIPLODOC-VERSION
+  title: Meta A
+links:
+  - title: A1
+    description: A1 desc
+    href: a1
+"
+`;
+
+exports[`Include toc > Toc with expressions > toc.yaml 1`] = `
+"title: Title A
+href: index.yaml
+items:
+  - name: A1
+    href: a1.md
+"
+`;
+
+exports[`Include toc > Toc with generic includer > filelist 1`] = `
+"[
+  "test/index.md",
+  "test/sub/sub-1.md",
+  "test/sub/sub-2.md",
+  "test/sub/sub/sub-3.md",
+  "test/test.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`Include toc > Toc with generic includer > test/index.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# H1
+
+[same level link](./test.md)
+[inner link](./sub/sub-1.md)
+"
+`;
+
+exports[`Include toc > Toc with generic includer > test/sub/sub/sub-3.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# H1"
+`;
+
+exports[`Include toc > Toc with generic includer > test/sub/sub-1.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# H1
+
+[same level link](./sub-2.md)
+[outer link](../test.md)
+[inner link](./sub/sub-3.md)
+"
+`;
+
+exports[`Include toc > Toc with generic includer > test/sub/sub-2.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# H1"
+`;
+
+exports[`Include toc > Toc with generic includer > test/test.md 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+---
+# H1"
+`;
+
+exports[`Include toc > Toc with generic includer > toc.yaml 1`] = `
+"title: main
+items:
+  - name: test
+    href: test/test.md
+  - name: Overview
+    href: test/index.md
+  - name: sub
+    items:
+      - name: sub-2
+        href: test/sub/sub-2.md
+      - name: sub-1
+        href: test/sub/sub-1.md
+      - name: sub
+        items:
+          - name: sub-3
+            href: test/sub/sub/sub-3.md
+"
+`;