@diplodoc/cli-tests 5.24.0 → 5.24.1

package/e2e/__snapshots__/include-with-meta.test.ts.snap

@@ -0,0 +1,67 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Include with Meta > Build with PAGE_PROCESS_CONCURRENCY=1 should preserve meta information in includes > filelist 1`] = `
+"[
+  "included.md",
+  "index.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`Include with Meta > Build with PAGE_PROCESS_CONCURRENCY=1 should preserve meta information in includes 1`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+title: Included Page Title
+description: This is the description for the included page
+vcsPath: included.md
+---
+
+# Included Page
+
+This is the content of the included page.
+
+## Section 1
+
+Some content in section 1.
+
+## Section 2
+
+Some content in section 2.
+"
+`;
+
+exports[`Include with Meta > Build with PAGE_PROCESS_CONCURRENCY=1 should preserve meta information in includes 2`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+title: Main Page Title
+description: This is the description for the main page
+vcsPath: index.md
+---
+
+# Main Page
+
+This is the main page content.
+
+## Including another page
+
+Here we include the content from the included page:
+
+[Included Page](./included.md)
+
+"
+`;
+
+exports[`Include with Meta > Build with PAGE_PROCESS_CONCURRENCY=1 should preserve meta information in includes 3`] = `
+"items:
+  - name: Main Page
+    href: index.md
+    items:
+      - name: Included Page
+        href: included.md
+path: toc.yaml
+"
+`;

package/e2e/include-with-meta.test.ts

@@ -0,0 +1,20 @@
+import {describe, test} from 'vitest';
+
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+describe('Include with Meta', () => {
+    test('Build with PAGE_PROCESS_CONCURRENCY=1 should preserve meta information in includes', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/include-with-meta');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: '-j 2',
+            env: {
+                PAGE_PROCESS_CONCURRENCY: '1',
+            },
+        });
+
+        await compareDirectories(outputPath);
+    });
+});

package/fixtures/cliAdapter.ts

@@ -7,6 +7,7 @@ export interface BuildRunArgs {
     md2md?: boolean;
     md2html?: boolean;
     args?: string;
+    env?: Record<string, string>;
 }
 
 export interface TranslateRunArgs {
@@ -23,16 +24,11 @@ class Build {
         this.runner = runner;
     }
 
-    run(input: string, output: string, args: string[]) {
-        return this.runner.runYfmDocs([
-            '--input',
-            input,
-            '--output',
-            output,
-            '--quiet',
-            '--allowHTML',
-            ...args,
-        ]);
+    run(input: string, output: string, args: string[], env?: Record<string, string>) {
+        return this.runner.runYfmDocs(
+            ['--input', input, '--output', output, '--quiet', '--allowHTML', ...args],
+            env,
+        );
     }
 }
 
@@ -43,17 +39,11 @@ class Extract {
         this.runner = runner;
     }
 
-    run(input: string, output: string, args: string[]) {
-        return this.runner.runYfmDocs([
-            'translate',
-            'extract',
-            '--input',
-            input,
-            '--output',
-            output,
-            '--quiet',
-            ...args,
-        ]);
+    run(input: string, output: string, args: string[], env?: Record<string, string>) {
+        return this.runner.runYfmDocs(
+            ['translate', 'extract', '--input', input, '--output', output, '--quiet', ...args],
+            env,
+        );
     }
 }
 
@@ -67,7 +57,7 @@ export class CliTestAdapter {
     async testBuildPass(
         inputPath: string,
         outputPath: string,
-        {md2md = true, md2html = true, args = ''}: BuildRunArgs = {},
+        {md2md = true, md2html = true, args = '', env}: BuildRunArgs = {},
     ): Promise<void> {
         await cleanupDirectory(outputPath);
         await cleanupDirectory(`${outputPath}-md`);
@@ -78,14 +68,16 @@ export class CliTestAdapter {
         const tasks = [];
 
         if (md2md && md2html) {
-            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md']));
+            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md'], env));
             tasks.push(() =>
-                this.build.run(inputPath, `${outputPath}-html`, [...baseArgs, '-f', 'html']),
+                this.build.run(inputPath, `${outputPath}-html`, [...baseArgs, '-f', 'html'], env),
             );
         } else if (md2md) {
-            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md']));
+            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md'], env));
         } else {
-            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'html']));
+            tasks.push(() =>
+                this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'html'], env),
+            );
         }
 
         for (const task of tasks) {

package/fixtures/runners/binary.ts

@@ -10,8 +10,12 @@ export class BinaryRunner implements Runner {
         this.binaryPath = binaryPath;
     }
 
-    async runYfmDocs(argv: string[]) {
-        const {stderr, exitCode} = await execa(this.binaryPath, argv, {all: true, reject: false});
+    async runYfmDocs(argv: string[], env?: Record<string, string>) {
+        const {stderr, exitCode} = await execa(this.binaryPath, argv, {
+            all: true,
+            reject: false,
+            env: {...process.env, ...env},
+        });
         const report = {
             code: exitCode || 0,
             warns: fillLog(/^WARN/, stderr),

package/fixtures/runners/types.ts

@@ -5,5 +5,5 @@ export type Report = {
 };
 
 export interface Runner {
-    runYfmDocs(argv: string[]): Promise<Report>;
+    runYfmDocs(argv: string[], env?: Record<string, string>): Promise<Report>;
 }

package/mocks/include-with-meta/input/included.md

@@ -0,0 +1,16 @@
+---
+title: Included Page Title
+description: This is the description for the included page
+---
+
+# Included Page
+
+This is the content of the included page.
+
+## Section 1
+
+Some content in section 1.
+
+## Section 2
+
+Some content in section 2.

package/mocks/include-with-meta/input/index.md

@@ -0,0 +1,15 @@
+---
+title: Main Page Title
+description: This is the description for the main page
+---
+
+# Main Page
+
+This is the main page content.
+
+## Including another page
+
+Here we include the content from the included page:
+
+[{#T}](./included.md)
+

package/mocks/include-with-meta/input/toc.yaml

@@ -0,0 +1,6 @@
+items:
+  - name: Main Page
+    href: index.md
+    items:
+      - name: Included Page
+        href: included.md

package/package.json

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