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

package/fixtures/runners/binary.ts

@@ -0,0 +1,31 @@
+import {spawn} from 'child_process';
+import {Runner} from './types';
+
+export class BinaryRunner implements Runner {
+    private readonly binaryPath: string;
+
+    constructor(binaryPath: string) {
+        this.binaryPath = binaryPath;
+    }
+
+    runYfmDocs(argv: string[]): Promise<void> {
+        return this.spawnAsync(argv);
+    }
+
+    private spawnAsync(argv: string[]): Promise<void> {
+        return new Promise((resolve, reject) => {
+            const child = spawn(this.binaryPath, argv, {
+                stdio: 'inherit',
+            });
+
+            child.on('error', reject);
+            child.on('exit', (code) => {
+                if (code === 0) {
+                    resolve();
+                } else {
+                    reject(new Error(`Process exited with code ${code}`));
+                }
+            });
+        });
+    }
+}

package/fixtures/runners/index.ts

@@ -0,0 +1,15 @@
+import {SourceRunner} from './source';
+import {BinaryRunner} from './binary';
+import {Runner} from './types';
+
+export {Runner};
+
+export function createRunner(): Runner {
+    const binaryPath = process.env.DIPLODOC_BINARY_PATH;
+
+    if (binaryPath) {
+        return new BinaryRunner(binaryPath);
+    }
+
+    return new SourceRunner();
+}

package/fixtures/runners/source.ts

@@ -0,0 +1,20 @@
+export class SourceRunner {
+    private readonly cliPath: string;
+
+    constructor() {
+        // Allow overriding the CLI path via environment variable, otherwise use local build
+        this.cliPath = process.env.DIPLODOC_CLI_BUILD_PATH || require.resolve('../../../build');
+    }
+
+    async runYfmDocs(argv: string[]): Promise<void> {
+        const {run} = await import(this.cliPath);
+
+        const baseArgs = ['node', this.cliPath, ...argv];
+
+        const exitCode = await run(baseArgs);
+
+        if (exitCode !== 0) {
+            throw new Error(`CLI exited with code ${exitCode}`);
+        }
+    }
+}

package/fixtures/runners/types.ts

@@ -0,0 +1,4 @@
+export interface Runner {
+    runYfmDocs(argv: string[]): Promise<void>;
+}
+

package/fixtures/utils/file.ts

@@ -0,0 +1,43 @@
+import {readFileSync} from 'fs';
+import {join, resolve} from 'path';
+import walkSync from 'walk-sync';
+import {bundleless, platformless} from './test';
+import {expect} from 'vitest';
+import shell from 'shelljs';
+
+export function getFileContent(filePath: string) {
+    return bundleless(platformless(readFileSync(filePath, 'utf8')));
+}
+
+const uselessFile = (file: string) =>
+    !['_bundle/', '_assets/', '_search/'].some((part) => file.includes(part));
+
+export function compareDirectories(outputPath: string): void {
+    const filesFromOutput = walkSync(outputPath, {
+        directories: false,
+        includeBasePath: false,
+    }).sort();
+
+    expect(bundleless(JSON.stringify(filesFromOutput, null, 2))).toMatchSnapshot('filelist');
+
+    filesFromOutput.filter(uselessFile).forEach((filePath) => {
+        const content = getFileContent(resolve(outputPath, filePath));
+        expect(content).toMatchSnapshot(filePath);
+    });
+}
+
+type TestPaths = {
+    inputPath: string;
+    outputPath: string;
+}
+
+export function getTestPaths(testRootPath: string): TestPaths {
+    return {
+        inputPath: resolve(__dirname, '../../', join(testRootPath, 'input')),
+        outputPath: resolve(__dirname, '../../', join(testRootPath, 'output')),
+    };
+}
+
+export function cleanupDirectory(path: string): void {
+    shell.rm('-rf', path);
+}

package/fixtures/utils/test.ts

@@ -0,0 +1,31 @@
+import {readFileSync} from 'fs';
+
+export function platformless(text: string): string {
+    return text
+        .replace(/\r\n/g, '\n')
+        .replace(/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/g, 'UUID')
+        .replace(/(content"?[:=]{1}[" ]{1}Diplodoc.*? )v\d+\.\d+\.\d+/g, `$1vDIPLODOC-VERSION`)
+        .replace(/(\\(?![/"'])){1,2}/g, '/');
+}
+
+export function bundleless(text: string): string {
+    const assets = require('@diplodoc/client/manifest') as Record<string, Record<string, string[]>>;
+
+    for (const [entryKey, entry] of Object.entries(assets)) {
+        for (const [typeKey, type] of Object.entries(entry)) {
+            for (let index = 0; index < type.length; index++) {
+                let prev = '';
+                while (prev !== text) {
+                    prev = text;
+                    text = text.replace(type[index], `${entryKey}-${typeKey}-${index}`);
+                }
+            }
+        }
+    }
+
+    return text;
+}
+
+export function getNormalizedContent(filePath: string): string {
+    return bundleless(platformless(readFileSync(filePath, 'utf8')));
+}

package/mocks/fileContent/metadata/authorAliasInMetadata.md

@@ -0,0 +1,7 @@
+---
+title: Author alias in metadata
+author: alias123
+---
+
+# Header
+Some text

package/mocks/fileContent/metadata/fullAuthorInMetadata.md

@@ -0,0 +1,10 @@
+---
+title: Full author in metadata
+author:
+  avatar: https://example/icons/logo.png
+  name: Author Name
+  url: https://site.ru
+---
+
+# Header
+Some text

package/mocks/fileContent/metadata/includesContent/firstIncludeFile.md

@@ -0,0 +1,7 @@
+---
+title: First include file
+---
+# Header
+Some text
+
+{% include [secondIncludeFile](./secondIncludeFile.md) %}

package/mocks/fileContent/metadata/includesContent/secondIncludeFile.md

@@ -0,0 +1,5 @@
+---
+title: Second include file
+---
+# Header
+Some text

package/mocks/fileContent/metadata/includesContent/withIncludes.md

@@ -0,0 +1,7 @@
+---
+title: With includes
+---
+# Header
+Some text
+
+{% include [firstIncludeFile](./firstIncludeFile.md) %}

package/mocks/fileContent/metadata/keywordsInMetadata.md

@@ -0,0 +1,9 @@
+---
+title: Keywords in metadata
+keywords:
+  - keyword 1
+  - keyword 2
+---
+
+# Header
+Some text

package/mocks/fileContent/metadata/simpleMetadata.md

@@ -0,0 +1,6 @@
+---
+title: Simple metadata
+editable: false
+---
+# Header
+Some text

package/mocks/fileContent/metadata/substitutionsInMetadataPropertyKeys.md

@@ -0,0 +1,7 @@
+---
+prop-{{key-name}}: This one has a substitution in a key name.
+{{key-name}}-prop: This one's key starts with a substitution.
+{{key-name}}: This one's key only consists of a substitution.
+{{ key-name }}: This one's key employs a different whitespace style in a substitution.
+---
+Blah.

package/mocks/fileContent/metadata/substitutionsInMetadataPropertyValues.md

@@ -0,0 +1,11 @@
+---
+prop1: "This is a metadata property with a {{substitution}} in it."
+prop2: "This one contains {{multiple}} {{substitutions}}."
+prop3: "This one has {{substitutions}} of {{ different }} {{  styles}}."
+prop4: 'This one has a {{substitution}} as well, but the string literal is single-quoted.'
+prop5: This one has no quotes at {{all}}.
+prop6: {{this}} starts with a substitution.
+prop7: >-
+  {{this}} one is a multiline {{property}}.
+---
+Blah.

package/mocks/fileContent/metadata/substitutionsWithEmptyString.md

@@ -0,0 +1,7 @@
+---
+prop1: {{var}}
+prop2: '{{var}}'
+prop3: '{{var}}'
+prop4: >-
+  {{var}}
+---

package/mocks/fileContent/metadata/variableInMetadata.md

@@ -0,0 +1,7 @@
+---
+title: Variable in metadata
+description: {{variable}} description
+---
+
+# Header
+Some text

package/mocks/fileContent/metadata/withAdditionalSeparatorsInContent.md

@@ -0,0 +1,9 @@
+---
+title: With additional separators in content
+---
+# Header
+Some text
+
+---
+Some text
+---

package/mocks/fileContent/metadata/withoutMetadata.md

@@ -0,0 +1,2 @@
+# Header
+Some text

package/mocks/fileContent/metadata/withoutMetadataWithAdditionalSeparatorsInContent.md

@@ -0,0 +1,6 @@
+# Header
+Some text
+
+---
+Some text
+---

package/mocks/generate-map/test1/input/ru/folder1/a1.md

@@ -0,0 +1 @@
+This is the /folder1/a1.md file content.

package/mocks/generate-map/test1/input/ru/folder1/folder2/a1.md

@@ -0,0 +1 @@
+This is the /folder1/folder1/a1.md file content.

package/mocks/generate-map/test1/input/ru/folder1/folder2/toc.yaml

@@ -0,0 +1,5 @@
+items:
+  - name: A1
+    href: a1.md
+
+

package/mocks/generate-map/test1/input/ru/folder1/toc.yaml

@@ -0,0 +1,7 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    include:
+      mode: link
+      path: folder2/toc.yaml

package/mocks/generate-map/test1/input/ru/toc.yaml

@@ -0,0 +1,22 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+  - name: Settings
+    href: settings.md
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+      - name: Adding additional plugins
+        href: plugins/import.md
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+      - name: Configuration file
+        href: project/config.md
+  - name: folder1
+    include:
+      mode: link
+      path: folder1/toc.yaml

package/mocks/generate-map/test2/input/en/toc.yaml

@@ -0,0 +1,18 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+  - name: Settings
+    href: settings.md
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+      - name: Adding additional plugins
+        href: plugins/import.md
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+      - name: Configuration file
+        href: project/config.md

package/mocks/generate-map/test2/input/ru/toc.yaml

@@ -0,0 +1,18 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+  - name: Settings
+    href: settings.md
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+      - name: Adding additional plugins
+        href: plugins/import.md
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+      - name: Configuration file
+        href: project/config.md

package/mocks/generate-map/test3/input/ru/folder1/a1.md

@@ -0,0 +1 @@
+This is the /folder1/a1.md file content.

package/mocks/generate-map/test3/input/ru/folder1/folder2/a1.md

@@ -0,0 +1 @@
+This is the /folder1/folder1/a1.md file content.

package/mocks/generate-map/test3/input/ru/folder1/folder2/toc.yaml

@@ -0,0 +1,5 @@
+items:
+  - name: A1
+    href: a1.md
+
+

package/mocks/generate-map/test3/input/ru/folder1/toc.yaml

@@ -0,0 +1,7 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    include:
+      mode: link
+      path: folder2/toc.yaml

package/mocks/generate-map/test3/input/ru/toc.yaml

@@ -0,0 +1,22 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+  - name: Settings
+    href: settings.md
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+      - name: Adding additional plugins
+        href: https://test.ru
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+      - name: Configuration file
+        href: https://test.ru
+  - name: folder1
+    include:
+      mode: link
+      path: folder1/toc.yaml

package/mocks/include-toc/test1/input/a1.md

@@ -0,0 +1 @@
+This is the /a1.md file content.

package/mocks/include-toc/test1/input/folder1/a1.md

@@ -0,0 +1 @@
+This is the /folder1/a1.md file content.

package/mocks/include-toc/test1/input/folder1/folder2/a1.md

@@ -0,0 +1 @@
+This is the /folder1/folder1/a1.md file content.

package/mocks/include-toc/test1/input/folder1/folder2/toc.yaml

@@ -0,0 +1,5 @@
+items:
+  - name: A1
+    href: a1.md
+
+

package/mocks/include-toc/test1/input/folder1/toc.yaml

@@ -0,0 +1,7 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    include:
+      mode: link
+      path: folder2/toc.yaml

package/mocks/include-toc/test1/input/toc.yaml

@@ -0,0 +1,9 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    include:
+      mode: link
+      path: folder1/toc.yaml
+
+

package/mocks/include-toc/test2/input/.yfm

@@ -0,0 +1 @@
+applyPresets: true

package/mocks/include-toc/test2/input/file1.md

@@ -0,0 +1 @@
+# File 1

package/mocks/include-toc/test2/input/fileX.md

@@ -0,0 +1 @@
+# File X

package/mocks/include-toc/test2/input/folder/fileA.md

@@ -0,0 +1,11 @@
+---
+title: File A
+description: {{product}} 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.
+
+---

package/mocks/include-toc/test2/input/folder/fileB.md

@@ -0,0 +1,9 @@
+# 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.
+
+---

package/mocks/include-toc/test2/input/folder/folder/fileC.md

@@ -0,0 +1 @@
+# File C

package/mocks/include-toc/test2/input/folder/folder/toc.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: NameC
+    href: fileC.md

package/mocks/include-toc/test2/input/folder/toc.yaml

@@ -0,0 +1,6 @@
+items:
+  - name: NameA
+    href: fileA.md
+  - name: NameB
+    href: fileB.md
+  - include: {path: folder/folder/toc.yaml }

package/mocks/include-toc/test2/input/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  product: YFM

package/mocks/include-toc/test2/input/toc.yaml

@@ -0,0 +1,6 @@
+items:
+  - name: Name1
+    href: file1.md
+  - include: { path: folder/toc.yaml }
+  - name: NameX
+    href: fileX.md

package/mocks/include-toc/test3/input/product1/core/_includes/inc.md

@@ -0,0 +1 @@
+This is the core include.

package/mocks/include-toc/test3/input/product1/core/article1.md

@@ -0,0 +1,3 @@
+This is the core content of Article 1.
+
+{% include [x](_includes/inc.md) %}

package/mocks/include-toc/test3/input/product1/core/toc_m.yaml

@@ -0,0 +1,2 @@
+items:
+- include: { mode: merge, path: product/toc_p.yaml }

package/mocks/include-toc/test3/input/product1/product/toc_p.yaml

@@ -0,0 +1,3 @@
+items:
+- name: Article1
+  href: article1.md

package/mocks/include-toc/test3/input/product1/toc.yaml

@@ -0,0 +1,3 @@
+title: Product 1 title
+items:
+- include: { mode: merge, path: core/toc_m.yaml }

package/mocks/include-toc/test3/input/product2/core/_includes/inc.md

@@ -0,0 +1 @@
+This is the core include.

package/mocks/include-toc/test3/input/product2/core/article1.md

@@ -0,0 +1,3 @@
+This is the core content of Article 1.
+
+{% include [x](_includes/inc.md) %}

package/mocks/include-toc/test3/input/product2/core/toc_m.yaml

@@ -0,0 +1,2 @@
+items:
+- include: { mode: merge, path: product/toc_p.yaml }

package/mocks/include-toc/test3/input/product2/overlay1/product/article1.md

@@ -0,0 +1,3 @@
+This is the overlay content of Article 1 for product 2.
+
+{% include [x](_includes/inc.md) %}

package/mocks/include-toc/test3/input/product2/overlay1/product/toc_p.yaml

@@ -0,0 +1,3 @@
+items:
+- name: Article1
+  href: article1.md