@diplodoc/cli-tests 0.0.0-rc-fix-lint-202505271406 → 0.0.0-rc-toc-translation-202506181609

package/e2e/errors.spec.ts

@@ -0,0 +1,37 @@
+import type {Report} from '../fixtures/runners/types';
+
+import {describe, expect, it} from 'vitest';
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+type TestResult = {
+    md: Report;
+    html: Report;
+}
+
+function test(path: string, expect: Function) {
+    it(path, async () => {
+        const {inputPath, outputPath} = getTestPaths(path);
+
+        const md = await TestAdapter.build.run(inputPath, outputPath, ['-j2', '-f', 'md']);
+        const html = await TestAdapter.build.run(outputPath, outputPath + '-html', ['-j2', '-f', 'html']);
+
+        return expect({md, html});
+    });
+}
+
+describe('Errors', () => {
+    test('mocks/errors/unreachable-link', ({html}: TestResult) => {
+        expectErrors(html, [
+            'ERR index.md: 1: YFM003 / unreachable-link Link is unreachable [Context: "[Unreachable link: "exists.html"][existing file](./exists.md)"]',
+            'ERR index.md: 2: YFM003 / unreachable-link Link is unreachable [Context: "[Unreachable link: "missed.html"][missed file](./missed.md)"]'
+        ]);
+    });
+});
+
+function expectErrors(report: Report, errors: string[]) {
+    expect(report.code).toEqual(1);
+
+    for (const error of errors) {
+        expect(report.errors).toContain(error);
+    }
+}

package/e2e/restricted-access.test.ts

@@ -0,0 +1,21 @@
+import {describe, test} from 'vitest';
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+const generateFilesYamlTestTemplate = (
+    testTitle: string,
+    testRootPath: string
+) => {
+    test(testTitle, async () => {
+        const {inputPath, outputPath} = getTestPaths(testRootPath);
+        await TestAdapter.testBuildPass(inputPath, outputPath, {md2md:true});
+        await compareDirectories(outputPath);
+    });
+};
+
+describe('Restricted access', () => {
+    generateFilesYamlTestTemplate('Simple restricted access', 'mocks/restricted-access/test1');
+
+    generateFilesYamlTestTemplate('Nested restricted access', 'mocks/restricted-access/test2');
+
+    generateFilesYamlTestTemplate('Nested toc restricted access', 'mocks/restricted-access/test3');
+});

package/e2e/translation.spec.ts

@@ -6,12 +6,12 @@ const generateMapTestTemplate = (
     testRootPath: string,
     args: TranslateRunArgs,
 ) => {
-    test.skip(testTitle, async () => {
+    test(testTitle, async () => {
         const {inputPath, outputPath} = getTestPaths(testRootPath);
 
         await TestAdapter.testTranslatePass(inputPath, outputPath, args);
 
-        await compareDirectories(outputPath, true);
+        await compareDirectories(outputPath);
     });
 };
 
@@ -43,7 +43,18 @@ describe('Translate command', () => {
             subcommand: 'extract',
             source: 'ru-RU',
             target: 'es-ES',
-            additionalArgs: '--exclude ru/_no-translate/*.md',
+            additionalArgs: '--exclude ru/to-be-excluded.md',
+        },
+    );
+
+    generateMapTestTemplate(
+        'filter files on extract with --strict-vars options',
+        'mocks/translation/dir-files',
+        {
+            subcommand: 'extract',
+            source: 'ru-RU',
+            target: 'es-ES',
+            additionalArgs: '--strict-vars',
         },
     );
 

package/fixtures/cliAdapter.ts

@@ -14,8 +14,30 @@ export interface TranslateRunArgs {
     additionalArgs?: string;
 }
 
+class Build {
+    private readonly runner: Runner;
+
+    constructor(runner: Runner) {
+        this.runner = runner;
+    }
+
+    run(input: string, output: string, args: string[]) {
+        return this.runner.runYfmDocs([
+            '--input',
+            input,
+            '--output',
+            output,
+            '--quiet',
+            '--allowHTML',
+            ...args,
+        ]);
+    }
+}
+
 export class CliTestAdapter {
-    private readonly runner: Runner = createRunner();
+    readonly runner: Runner = createRunner();
+
+    readonly build = new Build(this.runner);
 
     async testBuildPass(
         inputPath: string,
@@ -23,30 +45,27 @@ export class CliTestAdapter {
         {md2md = true, md2html = true, args = ''}: BuildRunArgs = {},
     ): Promise<void> {
         await cleanupDirectory(outputPath);
+        await cleanupDirectory(`${outputPath}-md`);
+        await cleanupDirectory(`${outputPath}-html`);
 
-        const baseArgs = [
-            '--input',
-            inputPath,
-            '--quiet',
-            '--allowHTML',
-            ...args.split(' ').filter(Boolean),
-        ];
+        const baseArgs = args.split(' ').filter(Boolean);
+
+        const tasks = [];
 
         if (md2md && md2html) {
-            await cleanupDirectory(`${outputPath}-html`);
-
-            await this.runner.runYfmDocs([...baseArgs, '--output', outputPath, '-f', 'md']);
-            await this.runner.runYfmDocs([
-                ...baseArgs,
-                '--output',
-                `${outputPath}-html`,
-                '-f',
-                'html',
-            ]);
+            tasks.push(() => this.build.run(inputPath, outputPath,[...baseArgs, '-f', 'md']));
+            tasks.push(() => this.build.run(inputPath, `${outputPath}-html`, [...baseArgs, '-f', 'html']));
         } else if (md2md) {
-            await this.runner.runYfmDocs([...baseArgs, '--output', outputPath, '-f', 'md']);
+            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md']));
         } else {
-            await this.runner.runYfmDocs([...baseArgs, '--output', outputPath]);
+            tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'html']));
+        }
+
+        for (const task of tasks) {
+            const report = await task();
+            if (report.code > 0) {
+                throw report;
+            }
         }
     }
 

package/fixtures/runners/binary.ts

@@ -9,9 +9,27 @@ export class BinaryRunner implements Runner {
     }
 
     async runYfmDocs(argv: string[]) {
-        const {all} = await execa(this.binaryPath, argv, {all: true});
+        const {stderr, exitCode} = await execa(this.binaryPath, argv, {all: true, reject: false});
+        const report = {
+            code: exitCode || 0,
+            warns: fillLog(/^WARN/, stderr),
+            errors: fillLog(/^ERR/, stderr),
+        };
 
-        // eslint-disable-next-line no-console
-        console.log(all);
+        const restLog = fillLog(/^(?!INFO|WARN|ERR)/, stderr);
+        if (restLog.length) {
+            for (const line of restLog) {
+                console.log(line);
+            }
+        }
+
+        return report;
     }
 }
+
+function fillLog(filter: RegExp, source: string) {
+    return source.split('\n')
+        .filter((line) => line.match(filter))
+        .map((line) => line.trim())
+        .filter(Boolean);
+}

package/fixtures/runners/index.ts

@@ -1,3 +1,5 @@
+import {resolve} from 'node:path';
+
 import {SourceRunner} from './source';
 import {BinaryRunner} from './binary';
 import {Runner} from './types';
@@ -5,7 +7,7 @@ import {Runner} from './types';
 export {Runner};
 
 export function createRunner(): Runner {
-    const binaryPath = process.env.DIPLODOC_BINARY_PATH;
+    const binaryPath = process.env.DIPLODOC_BINARY_PATH || resolve(__dirname, '../../../build/index.js');
 
     if (binaryPath) {
         return new BinaryRunner(binaryPath);

package/fixtures/runners/source.ts

@@ -1,15 +1,15 @@
+import type {Report} from './types';
+
 export class SourceRunner {
     readonly MODULE_PATH = require.resolve('../../../');
 
-    async runYfmDocs(argv: string[]): Promise<void> {
+    async runYfmDocs(argv: string[]) {
         const {run} = await import(this.MODULE_PATH);
 
         const baseArgs = ['node', this.MODULE_PATH, ...argv];
 
-        const exitCode = await run(baseArgs);
+        const report = await run(baseArgs) as Report;
 
-        if (exitCode !== 0) {
-            throw new Error(`CLI exited with code ${exitCode}`);
-        }
+        return report;
     }
 }

package/fixtures/runners/types.ts

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

package/fixtures/utils/file.ts

@@ -1,7 +1,7 @@
 import {readFileSync} from 'node:fs';
 import {join, resolve} from 'node:path';
 import {glob} from 'glob';
-import {bundleless, platformless} from './test';
+import {bundleless, hashless, platformless} from './test';
 import {expect} from 'vitest';
 import {$} from 'execa';
 
@@ -23,12 +23,12 @@ export async function compareDirectories(outputPath: string, ignoreFileContent =
         })
     ).sort();
 
-    expect(bundleless(JSON.stringify(filesFromOutput, null, 2))).toMatchSnapshot('filelist');
+    expect(hashless(bundleless(JSON.stringify(filesFromOutput, null, 2)))).toMatchSnapshot('filelist');
 
     if (!ignoreFileContent) {
         filesFromOutput.filter(uselessFile).forEach((filePath) => {
             const content = getFileContent(resolve(outputPath, filePath));
-            expect(content).toMatchSnapshot(filePath);
+            expect(content).toMatchSnapshot();
         });
     }
 }

package/fixtures/utils/test.ts

@@ -1,13 +1,18 @@
 import {readFileSync} from 'node:fs';
 
 export function platformless(text: string): string {
-    return text
+    return hashless(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+(?:-[\w-]+)?/g, `$1vDIPLODOC-VERSION`)
         .replace(/(\\(?![/"'])){1,2}/g, '/');
 }
 
+export function hashless(text: string): string {
+    return text
+        .replace(/-[a-z0-9]{12}\./g, '-hash.')
+}
+
 export function bundleless(text: string): string {
     const assets = require('@diplodoc/client/manifest') as Record<string, Record<string, string[]>>;
 

package/mocks/errors/unreachable-link/input/exists.md

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

package/mocks/errors/unreachable-link/input/index.md

@@ -0,0 +1,2 @@
+[existing file](./exists.md)
+[missed file](./missed.md)

package/mocks/errors/unreachable-link/input/toc.yaml

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

package/mocks/regression/input/1.md

@@ -24,10 +24,6 @@ not_var{{skip()}}
 
 [](./latex.md)
 
-[nowhere-link](./nowhere-link.md)
-
 [noext-link](./includes)
 
 {% include [user](includes/user.md) %}
-
-Forbibben text before {% include [user](includes/user.md) %}

package/mocks/regression/input/images.md

@@ -7,3 +7,5 @@
 ![with trailing comment](_assets/3.png)<!-- comment -->
 
 <!-- ![commented](_assets/4.png) -->
+
+![with backslash](_assets/5\_1.png)

package/mocks/regression/input/includes.md

@@ -4,4 +4,5 @@ Text
 
 {% include [test](includes/test.md) %}
 
+<!--{% include [For includes/deep.md](includes/deep.md) %}-->
 {% include [For includes/deep.md](includes/deep.md) %}

package/mocks/restricted-access/test1/input/plugins/index4.md

@@ -0,0 +1,4 @@
+---
+restricted-access:
+  - - customInFile
+---

package/mocks/restricted-access/test1/input/toc.yaml

@@ -0,0 +1,28 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+    restricted-access: admin
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+        restricted-access:
+          - admin
+  - name: Plugins 2
+    restricted-access: admin
+    items:
+      - name: Overview 2
+        href: plugins/index2.md
+        restricted-access:
+          - admin
+          - user
+      - name: Overview 3
+        href: plugins/index3.md
+        restricted-access:
+          - admin
+      - name: Overview 4
+        href: plugins/index4.md
+        restricted-access:
+          - admin
+

package/mocks/restricted-access/test2/input/toc.yaml

@@ -0,0 +1,21 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Plugins
+    restricted-access: 
+     - admin
+     - manager
+    items:
+      - name: Overview
+        href: plugins/index.md
+        restricted-access:
+          - userA
+          - userB
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+        restricted-access:
+          - userA
+          - userB
+
+

package/mocks/restricted-access/test3/input/a1.md

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

package/mocks/restricted-access/test3/input/folder1/a1.md

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

package/mocks/restricted-access/test3/input/folder1/folder2/a1.md

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

package/mocks/restricted-access/test3/input/folder1/folder2/toc.yaml

@@ -0,0 +1,8 @@
+items:
+  - name: A1
+    href: a1.md
+    restricted-access:
+      - userAtoc3
+      - userBtoc3
+
+

package/mocks/restricted-access/test3/input/folder1/toc.yaml

@@ -0,0 +1,10 @@
+items:
+  - name: A1
+    href: a1.md
+    restricted-access:
+      - userAtoc2
+      - userBtoc2
+  - name: folder1
+    include:
+      mode: link
+      path: folder2/toc.yaml

package/mocks/restricted-access/test3/input/toc.yaml

@@ -0,0 +1,16 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    restricted-access:
+      - userA
+      - userB
+    include:
+      mode: link
+      path: folder1/toc.yaml
+      
+
+
+
+
+

package/mocks/translation/dir-files/input/.yfm

@@ -0,0 +1,5 @@
+translate:
+    extract:
+        vars:
+            test: prod
+            skip: dev

package/mocks/translation/dir-files/input/ru/aboba.md

@@ -2,6 +2,4 @@
 
 [ссылка на файл не в toc.yaml](./aboba-not-in-toc.md)
 
-{% include [Описание](./_includes/test.md) %}
-
-
+{% include [Описание](./_includes/test.md) %}

package/mocks/translation/dir-files/input/ru/nested/a1.md

@@ -0,0 +1,3 @@
+## Included A1
+
+TEST

package/mocks/translation/dir-files/input/ru/nested/folder1/a1.md

@@ -0,0 +1,3 @@
+## Included A1
+
+TEST

package/mocks/translation/dir-files/input/ru/nested/folder1/toc-i.yaml

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

package/mocks/translation/dir-files/input/ru/nested/toc.yaml

@@ -3,6 +3,7 @@ href: index.yaml
 items:
   - name: API Yandex Cloud
     href: index.yaml
+  - include: {mode: merge, path: folder1/toc-i.yaml}
   - name: Yandex Flavored Markdown
     href: index-yfm.md
     items:

package/mocks/translation/dir-files/input/ru/no-var-page.md

@@ -0,0 +1,3 @@
+## No var page
+
+This page might be translated or not. Depends on --strict-vars option.

package/mocks/translation/dir-files/input/ru/to-be-excluded.md

@@ -0,0 +1 @@
+## Excluded title

package/mocks/translation/dir-files/input/ru/toc.yaml

@@ -4,4 +4,10 @@ items:
   - name: Aboba
     href: aboba.md
   - name: Не переводить
-    href: _no-translate/exclude.md
+    when: skip == 'prod'
+    href: _no-translate/exclude.md
+  - name: Нет переменной в vars
+    when: novar == 'test'
+    href: no-var-page.md
+  - name: exclude-test
+    href: to-be-excluded.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/cli-tests",
-  "version": "0.0.0-rc-fix-lint-202505271406",
+  "version": "0.0.0-rc-toc-translation-202506181609",
   "bin": {
     "diplodoc-cli-test": "bin.mjs"
   },
@@ -17,7 +17,8 @@
   ],
   "scripts": {
     "build": "false",
-    "test": "vitest run"
+    "test": "vitest run",
+    "test:update": "vitest -u"
   },
   "publishConfig": {
     "access": "public"
@@ -26,7 +27,7 @@
     "@diplodoc/cli": "file:.."
   },
   "dependencies": {
-    "@diplodoc/client": "^3.3.1",
+    "@diplodoc/client": "^3.6.3",
     "@types/node": "18.x",
     "@vitest/coverage-istanbul": "^3.1.1",
     "@vitest/coverage-v8": "^3.1.1",

package/vitest.config.ts

@@ -17,10 +17,9 @@ export default defineConfig({
         environment: 'node',
         include: [
             'e2e/**/*.{test,spec}.ts',
-            'units/**/*.{test,spec}.ts',
             ...resolvedTestPaths.map((path) => `${path}/**/*.{test,spec}.ts`),
         ],
-        exclude: ['node_modules', 'dist'],
+        exclude: ['node_modules'],
         coverage: {
             enabled: false,
         },