@diplodoc/cli-tests 0.0.0-rc-fix-translate-openapi-includer-202507171205 → 0.0.0-rc-liquid-conditions-saving-202509050811

package/e2e/preprocess.test.ts

@@ -0,0 +1,33 @@
+import {describe, test} from 'vitest';
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+const generateFilesYamlTestTemplate = (
+    testTitle: string,
+    testRootPath: string,
+    args: string[] = [],
+) => {
+    test(testTitle, async () => {
+        const {inputPath, outputPath} = getTestPaths(testRootPath);
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md:true,
+            md2html: false,
+            args: args.join(' '),
+        });
+        await TestAdapter.testBuildPass(outputPath, outputPath + '-html', {
+            md2md: false,
+            md2html: true,
+            args: args.join(' '),
+        });
+        await compareDirectories(outputPath);
+    });
+};
+
+describe('Preprocess', () => {
+    generateFilesYamlTestTemplate('HashIncludes=true,Autotitles=false', 'mocks/preprocess', [
+        '--no-merge-autotitles'
+    ]);
+
+    generateFilesYamlTestTemplate('HashIncludes=true,Autotitles=true', 'mocks/preprocess');
+
+    // generateFilesYamlTestTemplate('Nested toc restricted access', 'mocks/preprocess/test3');
+});

package/e2e/redirects-validation.spec.ts

@@ -0,0 +1,61 @@
+import {describe, expect, it} from 'vitest';
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+describe('Redirects validation', () => {
+    it('should emit an error on an unparseable redirects.yaml', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/unparseable');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(expect.stringMatching(/redirects.yaml parsing error/));
+    });
+
+    it.skip('should emit a warning when supplied with a `redirects.yaml` that mentions file extensions', async () => {
+        const {inputPath, outputPath} = getTestPaths(
+            'mocks/redirects-validation/extensions-deprecation',
+        );
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(0);
+        expect(report.warns).toContainEqual(
+            expect.stringMatching(/Redirects with explicit extensions are deprecated./),
+        );
+    });
+
+    it('should emit an error when an invalid regular expression pattern is encountered', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/invalid-regex');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(
+                /Redirects configuration results in a non-valid regular expression/,
+            ),
+        );
+    });
+
+    it('should emit an error when a redirect is malformed', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/malformed-redirect');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(/One of the two parameters is missing/),
+        );
+    });
+
+    it('should emit an error when a redirect leads to the same path', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/same-path');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(/Parameters must be different/),
+        );
+    });
+});

package/e2e/search.test.ts

@@ -8,7 +8,7 @@ describe('Local search', () => {
         await TestAdapter.testBuildPass(inputPath, outputPath, {
             md2md: false,
             md2html: true,
-            args: '-j2 --search',
+            args: '-j2 --search --interface-toc',
         });
         await compareDirectories(outputPath);
     });

package/e2e/skip-html-extension.spec.ts

@@ -0,0 +1,15 @@
+import {describe, it} from 'vitest';
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+describe('Skip html extension', () => {
+    it('transforms links correctly', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/skip-html-extension');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: false,
+            md2html: true,
+            args: '-j2 --skip-html-extension',
+        });
+        await compareDirectories(outputPath);
+    });
+});

package/e2e/translation.spec.ts

@@ -7,7 +7,7 @@ const generateMapTestTemplate = (
     args: TranslateRunArgs,
     ignoreFileContent = true,
 ) => {
-    test.skip(testTitle, async () => {
+    test(testTitle, async () => {
         const {inputPath, outputPath} = getTestPaths(testRootPath);
 
         await TestAdapter.testTranslatePass(inputPath, outputPath, args);
@@ -56,10 +56,17 @@ describe('Translate command', () => {
         target: 'es-ES',
     });
 
+    generateMapTestTemplate('do not filter files on extract', 'mocks/translation/dir-files', {
+        subcommand: 'extract',
+        source: 'ru-RU',
+        target: 'es-ES',
+    });
+
     generateMapTestTemplate('filter files on extract', 'mocks/translation/dir-files', {
         subcommand: 'extract',
         source: 'ru-RU',
         target: 'es-ES',
+        additionalArgs: '--filter'
     });
 
     generateMapTestTemplate(
@@ -69,7 +76,19 @@ describe('Translate command', () => {
             subcommand: 'extract',
             source: 'ru-RU',
             target: 'es-ES',
-            additionalArgs: '--exclude ru/_no-translate/*.md',
+            additionalArgs: '--exclude ru/to-be-excluded.md --filter',
+        },
+    );
+
+    const vars = {skip: 'prod'}
+    generateMapTestTemplate(
+        'filter files on extract with extra vars option',
+        'mocks/translation/dir-files',
+        {
+            subcommand: 'extract',
+            source: 'ru-RU',
+            target: 'es-ES',
+            additionalArgs: `--vars ${JSON.stringify(vars)} --filter`,
         },
     );
 
@@ -89,4 +108,30 @@ describe('Translate command', () => {
         source: 'ru-RU',
         target: 'en-US',
     });
+
+    let conditionVars = {prod: true, inner: true, list: ['item']};
+    generateMapTestTemplate(
+        'save truthy liquid conditions structures',
+        'mocks/translation/conditions',
+        {
+            subcommand: 'extract',
+            source: 'ru-RU',
+            target: 'es-ES',
+            additionalArgs: `--vars ${JSON.stringify(conditionVars)}`,
+        },
+        false,
+    );
+
+    conditionVars = {prod: false, inner: false, list: ['item']};
+    generateMapTestTemplate(
+        'remove falsy liquid conditions structures',
+        'mocks/translation/conditions',
+        {
+            subcommand: 'extract',
+            source: 'ru-RU',
+            target: 'es-ES',
+            additionalArgs: `--vars ${JSON.stringify(conditionVars)}`,
+        },
+        false,
+    );
 });

package/fixtures/cliAdapter.ts

@@ -34,11 +34,34 @@ class Build {
     }
 }
 
+class Extract {
+    private readonly runner: Runner;
+
+    constructor(runner: Runner) {
+        this.runner = runner;
+    }
+
+    run(input: string, output: string, args: string[]) {
+        return this.runner.runYfmDocs([
+            'translate',
+            'extract',
+            '--input',
+            input,
+            '--output',
+            output,
+            '--quiet',
+            ...args,
+        ]);
+    }
+}
+
 export class CliTestAdapter {
     readonly runner: Runner = createRunner();
 
     readonly build = new Build(this.runner);
 
+    readonly extract = new Extract(this.runner);
+
     async testBuildPass(
         inputPath: string,
         outputPath: string,

package/fixtures/globals.d.ts

@@ -0,0 +1,4 @@
+declare module "@diplodoc/cli/manifest" {
+    const manifest: Record<string, Record<string, string[]>>;
+    export = manifest;
+}

package/fixtures/runners/binary.ts

@@ -1,5 +1,6 @@
 import {Runner} from './types';
 import {execa} from 'execa';
+import strip from 'strip-ansi';
 
 export class BinaryRunner implements Runner {
     private readonly binaryPath: string;
@@ -29,7 +30,7 @@ export class BinaryRunner implements Runner {
 
 function fillLog(filter: RegExp, source: string) {
     return source.split('\n')
-        .filter((line) => line.match(filter))
-        .map((line) => line.trim())
-        .filter(Boolean);
+        .map((line) => strip(line).trim())
+        .filter(Boolean)
+        .filter((line) => line.match(filter));
 }

package/fixtures/runners/types.ts

@@ -2,9 +2,8 @@ export type Report = {
     code: number;
     warns: string[];
     errors: string[];
-}
+};
 
 export interface Runner {
     runYfmDocs(argv: string[]): Promise<Report>;
 }
-

package/fixtures/utils/file.ts

@@ -1,12 +1,12 @@
 import {readFileSync} from 'node:fs';
+import {rm} from 'node:fs/promises';
 import {join, resolve} from 'node:path';
 import {glob} from 'glob';
 import {bundleless, hashless, platformless} from './test';
 import {expect} from 'vitest';
-import {$} from 'execa';
 
 export function getFileContent(filePath: string) {
-    return bundleless(platformless(readFileSync(filePath, 'utf8')));
+    return platformless(bundleless(readFileSync(filePath, 'utf8')));
 }
 
 const uselessFile = (file: string) =>
@@ -21,9 +21,9 @@ export async function compareDirectories(outputPath: string, ignoreFileContent =
             nodir: true,
             posix: true,
         })
-    ).sort();
+    ).map(bundleless).sort();
 
-    expect(hashless(bundleless(JSON.stringify(filesFromOutput, null, 2)))).toMatchSnapshot('filelist');
+    expect(hashless(JSON.stringify(filesFromOutput, null, 2))).toMatchSnapshot('filelist');
 
     if (!ignoreFileContent) {
         filesFromOutput.filter(uselessFile).forEach((filePath) => {
@@ -46,5 +46,5 @@ export function getTestPaths(testRootPath: string): TestPaths {
 }
 
 export function cleanupDirectory(path: string) {
-    return $`rm -rf ${path}`;
+    return rm(path, {recursive: true, force: true});
 }

package/fixtures/utils/test.ts

@@ -1,11 +1,25 @@
-import {readFileSync} from 'node:fs';
+import assets from '@diplodoc/cli/manifest';
 
 export function platformless(text: string): string {
+    let index = 1;
+
     return hashless(text)
         .replace(/\r\n/g, '\n')
+        // Fix for XML equiv-text attributes in Windows - handle various patterns
+        .replace(/equiv-text="[\r\n]+
"/g, 'equiv-text="
"')
+        .replace(/equiv-text="[\r\n]+
"/g, 'equiv-text="
"')
+        // Also normalize any other attributes that might have line ending issues
+        .replace(/(ctype|id)="[\r\n]+(.*?)"/g, '$1="$2"')
         .replace(/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/g, 'UUID')
-        .replace(/(content"?[:=]{1}[" ]{1}Diplodoc.*? )v\d+\.\d+\.\d+(?:-[\w-]+)?/g, `$1vDIPLODOC-VERSION`)
-        .replace(/(\\(?![/"'])){1,2}/g, '/');
+        .replace(
+            /(content"?[:=]{1}[" ]{1}Diplodoc.*? )v\d+\.\d+\.\d+(?:-[\w-]+)?/g,
+            `$1vDIPLODOC-VERSION`,
+        )
+        .replace(/(\\(?![/"'])){1,2}/g, '/')
+        .replace(
+            /id=\\"inline-code-id-[a-zA-Z0-9]{8}\\"/g,
+            () => `id="inline-code-id-${index++}"`
+        )
 }
 
 export function hashless(text: string): string {
@@ -15,8 +29,6 @@ export function hashless(text: string): string {
 }
 
 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++) {
@@ -32,6 +44,3 @@ export function bundleless(text: string): string {
     return text;
 }
 
-export function getNormalizedContent(filePath: string): string {
-    return bundleless(platformless(readFileSync(filePath, 'utf8')));
-}

package/mocks/docs-viewer-interface/input/.yfm

@@ -0,0 +1,6 @@
+langs: ['en','ru']
+
+interface:
+    toc: false
+    feedback: false
+    search: false

package/mocks/docs-viewer-interface/input/index.md

@@ -0,0 +1,3 @@
+# Hello World!
+
+some text inside

package/mocks/docs-viewer-interface/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Test123
+href: index.md
+items:
+  - name: Главная
+    href: index.md

package/mocks/errors/extract-filtered-link/input/filtered.md

@@ -0,0 +1 @@
+File exists but not attached to toc

package/mocks/errors/extract-filtered-link/input/index.md

@@ -0,0 +1,7 @@
+[filtered file](./filtered.md)
+
+{% if test == "dev" %}[will be deleted on translate-extract](./index.md){% endif %}
+
+[second missed link](./filtered2.md)
+[second missed link](./filtered2.md)
+[second missed link](./filtered3.md)

package/mocks/errors/extract-filtered-link/input/toc.yaml

@@ -0,0 +1 @@
+href: index.md

package/mocks/load-custom-resources/md2html-with-resources/input/page.md

@@ -1,7 +1,14 @@
 ---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
 metadata:
   - name: yfm
-    content: builder
+    content: builder in page
 ---
 
-Lorem
+Lorem

package/mocks/load-custom-resources/md2md-with-resources/input/page.md

@@ -1,7 +1,14 @@
 ---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
 metadata:
   - name: yfm
-    content: builder
+    content: builder in page
 ---
 
-Lorem
+Lorem

package/mocks/load-custom-resources/single-page-with-resources/input/page.md

@@ -1,7 +1,14 @@
 ---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
 metadata:
   - name: yfm
-    content: builder
+    content: builder in page
 ---
 
-Lorem
+Lorem

package/mocks/metadata/md2html-with-metadata/input/page.md

@@ -1,7 +1,14 @@
 ---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
 metadata:
   - name: yfm
-    value: builder in page
+    content: builder in page
 ---
 
 Lorem

package/mocks/metadata/md2md-with-metadata/input/page.md

@@ -1,4 +1,11 @@
 ---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
 metadata:
   - name: yfm
     content: builder in page

package/mocks/preprocess/input/.yfm

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

package/mocks/preprocess/input/1.md

@@ -0,0 +1,29 @@
+# Title
+
+Text not_var{{not-var}} not_var{{skip()}} {{default-var}}
+
+Text `not_var{{not-var}}` `not_var{{skip()}}` `{{default-var}}`
+
+Text
+```
+not_var{{not-var}}
+
+not_var{{skip()}}
+
+{{default-var}}
+```
+
+
+`[not a link](./path/to/relative/file.md)`
+
+## Subtitle {#subtitle}
+
+[{#T}](mermaid.md)
+
+[{#T}](mermaid.md#info)
+
+[](latex.md)
+
+[noext-link](includes)
+
+{% include [user](includes/user.md) %}

package/mocks/preprocess/input/autotitle.md

@@ -0,0 +1,23 @@
+# Autotitles ![](_assets/1.svg)
+
+Empty title
+[](./1.md)
+
+Empty subtitle
+[](./1.md#subtitle)
+
+Special title
+[{#T}](./1.md)
+
+Special subtitle
+[{#T}](./1.md#subtitle)
+
+Empty local title
+[](#header)
+
+Special local title
+[{#T}](#header)
+
+## Header {#header}
+
+Content

package/mocks/preprocess/input/commented-include.md

@@ -0,0 +1,3 @@
+![](./missed-asset.png)
+
+[](./missed-link.md)

package/mocks/preprocess/input/images.md

@@ -0,0 +1,5 @@
+# Images
+
+![simple image](_assets/1.png)
+
+

package/mocks/preprocess/input/included-item.md

@@ -0,0 +1,12 @@
+# Included item
+
+Included item text
+
+<!-- :   {% include [rec-off](./commented-include.md) %} -->
+
+{% note alert "Alert!" %}
+
+  <!-- content -->
+
+{% endnote %}
+

package/mocks/preprocess/input/includes/deep.md

@@ -0,0 +1 @@
+{% include [user](sub/user.md) %}

package/mocks/preprocess/input/includes/deepWithIndent.md

@@ -0,0 +1,6 @@
+- list item
+
+  {% include [user](sub/userWithIndent.md) %}
+
+Link to mermaid diagram from 1 level
+[](../mermaid.md)

package/mocks/preprocess/input/includes/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  user: Alice

package/mocks/preprocess/input/includes/sub/user.md

@@ -0,0 +1 @@
+{{user}}

package/mocks/preprocess/input/includes/sub/userWithIndent.md

@@ -0,0 +1,5 @@
+Link to mermaid diagram from 2 level
+[](../../mermaid.md)
+
+- User
+  {{user}}

package/mocks/preprocess/input/includes/test.md

@@ -0,0 +1 @@
+Test

package/mocks/preprocess/input/includes/user.md

@@ -0,0 +1 @@
+{{user}}

package/mocks/preprocess/input/includes.md

@@ -0,0 +1,18 @@
+Text
+
+{% include [user](includes/user.md) %}
+
+{% include [test](includes/test.md) %}
+
+Link after include
+[{#T}](./1.md)
+
+<!--{% include [For includes/deep.md](includes/deep.md) %}-->
+{% include [For includes/deep.md](includes/deep.md) %}
+
+Include with big indent
+
+{% include [For includes/deep.md](includes/deepWithIndent.md) %}
+
+Link after include
+[{#T}](./1.md#subtitle)

package/mocks/preprocess/input/latex.md

@@ -0,0 +1,3 @@
+# Latex usage
+
+$\sqrt{3x-1}+(1+x)^2$

package/mocks/preprocess/input/mermaid.md

@@ -0,0 +1,13 @@
+# Mermaid usage
+
+```mermaid
+
+  sequenceDiagram
+        rect rgba(251, 243, 232, 0.2)
+            Alice ->> Bob:
+        end
+  ```
+
+## Mermaid info {#info}
+
+Some mermaid info

package/mocks/preprocess/input/presets.yaml

@@ -0,0 +1,8 @@
+default:
+  default-var: default-var-value
+  not-var: not-var-value
+  product: root
+  user: Bob
+
+internal:
+  default-var: default-var-internal-value

package/mocks/preprocess/input/sub/folder/item-1.md

@@ -0,0 +1,7 @@
+# Item 1
+
+Item 1 text
+
+[{#T}](../../images.md)
+
+[{#T}](../../autotitle.md)

package/mocks/preprocess/input/sub/toc.yaml

@@ -0,0 +1,5 @@
+items:
+  name: Named include (items is Object here - this is not an error)
+  items:
+    - name: Item 1
+      href: folder/item-1.md

package/mocks/preprocess/input/toc-i.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: Included Item
+    href: ./included-item.md