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

package/e2e/translation.spec.ts

@@ -0,0 +1,55 @@
+import {describe, test} from 'vitest';
+import {TestAdapter, TranslateRunArgs, compareDirectories, getTestPaths} from '../fixtures';
+
+const generateMapTestTemplate = (
+    testTitle: string,
+    testRootPath: string,
+    args: TranslateRunArgs,
+) => {
+    test(testTitle, async () => {
+        const {inputPath, outputPath} = getTestPaths(testRootPath);
+
+        await TestAdapter.testTranslatePass(inputPath, outputPath, args);
+
+        await compareDirectories(outputPath, true);
+    });
+};
+
+const generateFilesYamlTestTemplate = (
+    testTitle: string,
+    testRootPath: string,
+    args: TranslateRunArgs,
+) => {
+    test(testTitle, async () => {
+        const {inputPath, outputPath} = getTestPaths(testRootPath);
+
+        await TestAdapter.testTranslatePass(inputPath, outputPath, args);
+
+        await compareDirectories(outputPath);
+    });
+};
+
+describe('Translate command', () => {
+    generateMapTestTemplate('filter files on extract', 'mocks/translation/dir-files', {
+        subcommand: 'extract',
+        source: 'ru-RU',
+        target: 'es-ES',
+    });
+
+    generateMapTestTemplate(
+        'filter files on extract with extra exclude option',
+        'mocks/translation/dir-files',
+        {
+            subcommand: 'extract',
+            source: 'ru-RU',
+            target: 'es-ES',
+            additionalArgs: '--exclude ru/_no-translate/*.md',
+        },
+    );
+
+    generateFilesYamlTestTemplate('extract yaml scheme files', 'mocks/translation/yaml-scheme', {
+        subcommand: 'extract',
+        source: 'ru-RU',
+        target: 'en-US',
+    });
+});

package/fixtures/cliAdapter.ts

@@ -1,21 +1,28 @@
 import {Runner, createRunner} from './runners';
 import {cleanupDirectory} from './utils/file';
 
-export interface TestRunArgs {
+export interface BuildRunArgs {
     md2md?: boolean;
     md2html?: boolean;
     args?: string;
 }
 
-export class CliTestAdapter {
+export interface TranslateRunArgs {
+    subcommand: 'extract';
+    source: string;
+    target: string;
+    additionalArgs?: string;
+}
+
+class CliTestAdapter {
     private readonly runner: Runner = createRunner();
 
-    async testPass(
+    async testBuildPass(
         inputPath: string,
         outputPath: string,
-        {md2md = true, md2html = true, args = ''}: TestRunArgs = {},
+        {md2md = true, md2html = true, args = ''}: BuildRunArgs = {},
     ): Promise<void> {
-        cleanupDirectory(outputPath);
+        await cleanupDirectory(outputPath);
 
         const baseArgs = [
             '--input',
@@ -26,14 +33,47 @@ export class CliTestAdapter {
         ];
 
         if (md2md && md2html) {
-            cleanupDirectory(`${outputPath}-html`);
+            await cleanupDirectory(`${outputPath}-html`);
 
             await this.runner.runYfmDocs([...baseArgs, '--output', outputPath, '-f', 'md']);
-            await this.runner.runYfmDocs([...baseArgs, '--output', `${outputPath}-html`, '-f', 'html']);
+            await this.runner.runYfmDocs([
+                ...baseArgs,
+                '--output',
+                `${outputPath}-html`,
+                '-f',
+                'html',
+            ]);
         } else if (md2md) {
             await this.runner.runYfmDocs([...baseArgs, '--output', outputPath, '-f', 'md']);
         } else {
             await this.runner.runYfmDocs([...baseArgs, '--output', outputPath]);
         }
     }
+
+    async testTranslatePass(
+        inputPath: string,
+        outputPath: string,
+        {subcommand, source, target, additionalArgs = ''}: TranslateRunArgs,
+    ): Promise<void> {
+        await cleanupDirectory(outputPath);
+
+        const baseArgs = [
+            'translate',
+            subcommand,
+            '--quiet',
+            '--input',
+            inputPath,
+            '--output',
+            outputPath,
+            '--source',
+            source,
+            '--target',
+            target,
+            ...additionalArgs.split(' ').filter(Boolean),
+        ];
+
+        await this.runner.runYfmDocs(baseArgs);
+    }
 }
+
+export const TestAdapter = new CliTestAdapter();

package/fixtures/runners/binary.ts

@@ -1,5 +1,5 @@
-import {spawn} from 'child_process';
 import {Runner} from './types';
+import {execa} from 'execa';
 
 export class BinaryRunner implements Runner {
     private readonly binaryPath: string;
@@ -8,24 +8,10 @@ export class BinaryRunner implements Runner {
         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',
-            });
+    async runYfmDocs(argv: string[]) {
+        const {all} = await execa(this.binaryPath, argv, {all: true});
 
-            child.on('error', reject);
-            child.on('exit', (code) => {
-                if (code === 0) {
-                    resolve();
-                } else {
-                    reject(new Error(`Process exited with code ${code}`));
-                }
-            });
-        });
+        // eslint-disable-next-line no-console
+        console.log(all);
     }
 }

package/fixtures/runners/source.ts

@@ -1,15 +1,10 @@
-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');
-    }
+const MODULE_PATH = require.resolve('../../../');
 
+export class SourceRunner {
     async runYfmDocs(argv: string[]): Promise<void> {
-        const {run} = await import(this.cliPath);
+        const {run} = await import(MODULE_PATH);
 
-        const baseArgs = ['node', this.cliPath, ...argv];
+        const baseArgs = ['node', MODULE_PATH, ...argv];
 
         const exitCode = await run(baseArgs);
 

package/fixtures/utils/file.ts

@@ -1,9 +1,9 @@
-import {readFileSync} from 'fs';
-import {join, resolve} from 'path';
-import walkSync from 'walk-sync';
+import {readFileSync} from 'node:fs';
+import {join, resolve} from 'node:path';
+import {glob} from 'glob';
 import {bundleless, platformless} from './test';
 import {expect} from 'vitest';
-import shell from 'shelljs';
+import {$} from 'execa';
 
 export function getFileContent(filePath: string) {
     return bundleless(platformless(readFileSync(filePath, 'utf8')));
@@ -12,24 +12,31 @@ export function getFileContent(filePath: string) {
 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();
+export async function compareDirectories(outputPath: string, ignoreFileContent = false) {
+    const filesFromOutput = (
+        await glob(`**/*`, {
+            cwd: outputPath,
+            dot: true,
+            follow: true,
+            nodir: true,
+            posix: true,
+        })
+    ).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);
-    });
+    if (!ignoreFileContent) {
+        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 {
@@ -38,6 +45,6 @@ export function getTestPaths(testRootPath: string): TestPaths {
     };
 }
 
-export function cleanupDirectory(path: string): void {
-    shell.rm('-rf', path);
+export function cleanupDirectory(path: string) {
+    return $`rm -rf ${path}`;
 }

package/fixtures/utils/test.ts

@@ -1,4 +1,4 @@
-import {readFileSync} from 'fs';
+import {readFileSync} from 'node:fs';
 
 export function platformless(text: string): string {
     return text

package/mocks/translation/dir-files/input/ru/_includes/test.md

@@ -0,0 +1 @@
+## Заголовок include

package/mocks/translation/dir-files/input/ru/_no-translate/exclude.md

@@ -0,0 +1 @@
+## Не переводить

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

@@ -0,0 +1,7 @@
+## Заголовок include
+
+[ссылка на файл не в toc.yaml](./aboba-not-in-toc.md)
+
+{% include [Описание](./_includes/test.md) %}
+
+

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

@@ -0,0 +1,3 @@
+## Заголовок index
+
+lorem

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

@@ -0,0 +1,2 @@
+# Yandex Flavored Markdown
+

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

@@ -0,0 +1,24 @@
+title: Diplodoc
+description: Diplodoc - платформа работы с документацией в парадигме Documentation as a Code. 
+meta:
+  title: Метаданные
+  noIndex: true
+links:
+- title: API Yandex Cloud
+  description: Архитектура API Yandex Cloud (урезанная)
+  href: api-design-guide
+- title: API Yandex Cloud Абсолют
+  description: Архитектура API Yandex Cloud (урезанная) с абсолютным путем
+  href: /api-design-guide
+- title: Обзор системы
+  description: Описание платформы, ее основные возможности, особенности и преимущества.
+  href: about.md
+- title: Как попробовать
+  description: С чего начать работу
+  href: how-it-work.md
+- title: Yandex Flavored Markdown
+  description: Описание языка Yandex Flavored Markdown.
+  href: index-yfm.md
+
+   
+  

package/mocks/translation/dir-files/input/ru/nested/not-in-toc.md

@@ -0,0 +1,20 @@
+---
+keywords: яндекс станция макс
+voter: no
+title: Справочник голосовых команд для Яндекс Станции — Справка
+---
+
+
+aboba
+
+Общение в issues и pull requests в GitHub на русском и преимущественно английском языке.- Презентация/продвижение продукта на разных **![i](./complex/_images/camera.svg) [конференциях](*conference)**{.photo} и **![i](./complex/_images/camera.svg) [митапах](*meetup)**{.photo}.
+
+абоба тест
+
+{% include [Описание](./_includes/test.md) %}
+
+[*meetup]:
+![i](./_images/highload.png)
+
+[*conference]:
+![i](./_images/highload.png)

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

@@ -0,0 +1 @@
+# Базовая разметка

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

@@ -0,0 +1,2 @@
+# Синтаксис
+

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

@@ -0,0 +1 @@
+# Списки

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

@@ -0,0 +1,18 @@
+title: Diplodoc
+href: index.yaml
+items:
+  - name: API Yandex Cloud
+    href: index.yaml
+  - name: Yandex Flavored Markdown
+    href: index-yfm.md
+    items:
+      - name: Синтаксис
+        items:
+          - name: Обзор
+            href: syntax/index.md
+            when: test == "nested"
+          - name: Базовая разметка
+            href: syntax/base.md
+          - name: Списки
+            href: syntax/lists.md
+          - name: Таблицы

package/mocks/translation/dir-files/input/ru/not-in-toc.md

@@ -0,0 +1,20 @@
+---
+keywords: яндекс станция макс
+voter: no
+title: Справочник голосовых команд для Яндекс Станции — Справка
+---
+
+
+aboba
+
+Общение в issues и pull requests в GitHub на русском и преимущественно английском языке.- Презентация/продвижение продукта на разных **![i](./complex/_images/camera.svg) [конференциях](*conference)**{.photo} и **![i](./complex/_images/camera.svg) [митапах](*meetup)**{.photo}.
+
+абоба тест
+
+{% include [Описание](./_includes/test.md) %}
+
+[*meetup]:
+![i](./_images/highload.png)
+
+[*conference]:
+![i](./_images/highload.png)

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

@@ -0,0 +1,7 @@
+title: Test123
+href: index.md
+items:
+  - name: Aboba
+    href: aboba.md
+  - name: Не переводить
+    href: _no-translate/exclude.md

package/mocks/translation/yaml-scheme/input/ru/.yfm

@@ -0,0 +1 @@
+langs: ['ru']

package/mocks/translation/yaml-scheme/input/ru/index-direct.yaml

@@ -0,0 +1,133 @@
+meta:
+ title: Справка Сервиса
+ description: В Справке Сервиса собрали всю необходимую информацию.
+ 
+fullScreen: true
+blocks:
+  - type: header-block
+    title: <div class="u-breadcrumbs"></div> 
+    breadcrumbs:
+     items:
+      - text: Справка
+        url: 'https://site.ru/support/'
+      - text: Реклама
+        url: 'https://site.ru/support/adv/'
+  - type: 'filter-block'
+    centered: false
+    title:
+      text: 'Сервис'
+    tags:
+      - id: 'one'
+        label: 'Для специалистов'
+      - id: 'two'
+        label: 'Для предпринимателей'
+    colSizes:
+      all: 12
+      xl: 4
+      sm: 6
+      md: 4
+
+    items:
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img/orig'
+          title: 'Единая перфоманс-кампания'
+          text: '<div>Комплексно решайте любые перфоманс-задачи в рамках одной кампании</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'unified-performance-campaign/about.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img2/orig'
+          title: 'Товарная кампания'
+          text: '<div>Используйте простой инструмент для продвижения товаров интернете</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'campaign-master/product-campaign.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img2/orig'
+          title: 'Реклама в Telegram'
+          text: '<div>Покажите релевантную рекламу в телеграм-каналах партнеров РСЯ</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'efficiency/telegram-ads.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'background-card'
+          title: Часто ищут
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Статистика
+              url: 'statistics.md'
+              arrow: true
+              theme: 'normal'
+            - text: Управление фидами
+              url: 'feeds/about.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'one'
+        card:
+          type: background-card
+          title: Сервисные функции
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Правила и модерация
+              url: 'moderation/adv-rules.md'
+              arrow: true
+              theme: 'normal'
+            - text: Технологии и сервисы
+              url: 'technologies-and-services/technologies-and-services.md'
+              arrow: true
+              theme: 'normal'
+            - text: Поддержка 24/7
+              url: 'troubleshooting/other.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'one'
+        card:
+          type: background-card
+          title: Полезные ссылки
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Глоссарий
+              url: 'glossary.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'two'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img4/orig'
+          title: 'Простой старт'
+          text: '<div>Минимум ручных настроек: достаточно указать ссылку на сайт</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'products-automatic/about.md'
+          urlTitle: 'Подробнее'
+
+animated: false

package/mocks/translation/yaml-scheme/input/ru/index.yaml

@@ -0,0 +1,32 @@
+blocks:
+  - type: 'content-layout-block'
+    textWidth: 'l'
+    textContent:
+      title: 'Введение'
+      text: "
+       API сервиса:
+       - Управлять счетчиками, их настройками и правами доступа, не используя веб-интерфейс.\n
+       - Получать информацию о посещаемости сайта и другие данные.\n
+       - Формировать отчеты, в том числе с помощью сегментации и параметризации.\n
+       "
+  - type: 'card-layout-block'
+    colSizes:
+      all: 12
+      lg: 4
+      md: 6
+      sm: 12
+      xl: 4
+    indent:
+      bottom: 'xs'
+    title: 'Виды API'
+    animated: false
+    children:
+      - type: 'basic-card'
+        title: 'API управления'
+        text: "Управление счетчиками, целями, фильтрами и другими объектами Сервиса (например, создать счетчик, отредактировать его настройки, создать цель, выдать права доступа)."
+        urlTitle: 'API управления'
+        border: 'shadow'
+        controlPosition: 'content'
+        url: 'management/index'
+        target: ''
+        animated: false

package/mocks/translation/yaml-scheme/input/ru/toc.yaml

@@ -0,0 +1,19 @@
+title: Заголовок
+href: index.yaml
+items:
+  - name: Дочерняя страница
+  - href: index-direct.yaml
+navigation:
+  header:
+    leftItems:
+      - text: 'Инструменты'
+        type: 'dropdown'
+        items:
+          - text: 'Пункт меню'
+            type: 'link'
+            href: 'menu/item'
+  logo:
+    light:
+      icon: 'https://icon.link/logo.svg'
+      url: 'https://site.ru'
+      urlTitle : 'На сайт сервиса'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/cli-tests",
-  "version": "0.0.0-rc-reusable-e2es-202504041505",
+  "version": "4.59.0",
   "bin": {
     "diplodoc-cli-test": "bin.mjs"
   },
@@ -22,19 +22,21 @@
   "publishConfig": {
     "access": "public"
   },
+  "devDependencies": {
+    "@diplodoc/cli": "file:.."
+  },
   "dependencies": {
     "@diplodoc/client": "^3.3.1",
     "@types/node": "18.x",
-    "@types/shelljs": "^0.8.15",
     "@vitest/coverage-istanbul": "^3.1.1",
     "@vitest/coverage-v8": "^3.1.1",
     "commander": "^13.1.0",
+    "execa": "^9.5.3",
+    "glob": "^11.0.2",
     "js-yaml": "^4.1.0",
-    "shelljs": "^0.9.1",
     "ts-dedent": "^2.2.0",
     "ts-node": "^10.4.0",
-    "typescript": "^5.3.3",
-    "walk-sync": "^3.0.0"
+    "typescript": "^5.3.3"
   },
   "peerDependencies": {
     "vitest": "^3.1.1"