@diplodoc/cli-tests 5.8.4 → 5.9.1

package/e2e/__snapshots__/translation.spec.ts.snap

@@ -612,6 +612,47 @@ path: toc.yaml
 "
 `;
 
+exports[`Translate command > do not filter files on extract > filelist 1`] = `
+"[
+  "es/_includes/test.md.skl",
+  "es/_includes/test.md.xliff",
+  "es/_no-translate/exclude.md.skl",
+  "es/_no-translate/exclude.md.xliff",
+  "es/aboba.md.skl",
+  "es/aboba.md.xliff",
+  "es/index.md.skl",
+  "es/index.md.xliff",
+  "es/nested/a1.md.skl",
+  "es/nested/a1.md.xliff",
+  "es/nested/folder1/a1.md.skl",
+  "es/nested/folder1/a1.md.xliff",
+  "es/nested/folder1/toc-i.yaml.skl",
+  "es/nested/folder1/toc-i.yaml.xliff",
+  "es/nested/index-yfm.md.skl",
+  "es/nested/index-yfm.md.xliff",
+  "es/nested/index.yaml.skl",
+  "es/nested/index.yaml.xliff",
+  "es/nested/not-in-toc.md.skl",
+  "es/nested/not-in-toc.md.xliff",
+  "es/nested/syntax/base.md.skl",
+  "es/nested/syntax/base.md.xliff",
+  "es/nested/syntax/index.md.skl",
+  "es/nested/syntax/index.md.xliff",
+  "es/nested/syntax/lists.md.skl",
+  "es/nested/syntax/lists.md.xliff",
+  "es/nested/toc.yaml.skl",
+  "es/nested/toc.yaml.xliff",
+  "es/no-var-page.md.skl",
+  "es/no-var-page.md.xliff",
+  "es/not-in-toc.md.skl",
+  "es/not-in-toc.md.xliff",
+  "es/to-be-excluded.md.skl",
+  "es/to-be-excluded.md.xliff",
+  "es/toc.yaml.skl",
+  "es/toc.yaml.xliff"
+]"
+`;
+
 exports[`Translate command > extract openapi spec files > filelist 1`] = `
 "[
   "openapi-spec.yaml.skl",
@@ -716,6 +757,7 @@ exports[`Translate command > extract openapi spec files 3`] = `
       includers:
         - name: openapi
           input: openapi-spec.yaml
+      mode: link
 "
 `;
 
@@ -1686,12 +1728,12 @@ exports[`Translate command > filter files on extract > filelist 1`] = `
 "[
   "es/_includes/test.md.skl",
   "es/_includes/test.md.xliff",
-  "es/_no-translate/exclude.md.skl",
-  "es/_no-translate/exclude.md.xliff",
   "es/aboba.md.skl",
   "es/aboba.md.xliff",
   "es/index.md.skl",
   "es/index.md.xliff",
+  "es/nested/a1.md.skl",
+  "es/nested/a1.md.xliff",
   "es/nested/index-yfm.md.skl",
   "es/nested/index-yfm.md.xliff",
   "es/nested/index.yaml.skl",
@@ -1702,6 +1744,10 @@ exports[`Translate command > filter files on extract > filelist 1`] = `
   "es/nested/syntax/lists.md.xliff",
   "es/nested/toc.yaml.skl",
   "es/nested/toc.yaml.xliff",
+  "es/no-var-page.md.skl",
+  "es/no-var-page.md.xliff",
+  "es/to-be-excluded.md.skl",
+  "es/to-be-excluded.md.xliff",
   "es/toc.yaml.skl",
   "es/toc.yaml.xliff"
 ]"
@@ -1715,6 +1761,8 @@ exports[`Translate command > filter files on extract with extra exclude option >
   "es/aboba.md.xliff",
   "es/index.md.skl",
   "es/index.md.xliff",
+  "es/nested/a1.md.skl",
+  "es/nested/a1.md.xliff",
   "es/nested/index-yfm.md.skl",
   "es/nested/index-yfm.md.xliff",
   "es/nested/index.yaml.skl",
@@ -1725,6 +1773,39 @@ exports[`Translate command > filter files on extract with extra exclude option >
   "es/nested/syntax/lists.md.xliff",
   "es/nested/toc.yaml.skl",
   "es/nested/toc.yaml.xliff",
+  "es/no-var-page.md.skl",
+  "es/no-var-page.md.xliff",
+  "es/toc.yaml.skl",
+  "es/toc.yaml.xliff"
+]"
+`;
+
+exports[`Translate command > filter files on extract with extra vars option > filelist 1`] = `
+"[
+  "es/_includes/test.md.skl",
+  "es/_includes/test.md.xliff",
+  "es/_no-translate/exclude.md.skl",
+  "es/_no-translate/exclude.md.xliff",
+  "es/aboba.md.skl",
+  "es/aboba.md.xliff",
+  "es/index.md.skl",
+  "es/index.md.xliff",
+  "es/nested/a1.md.skl",
+  "es/nested/a1.md.xliff",
+  "es/nested/index-yfm.md.skl",
+  "es/nested/index-yfm.md.xliff",
+  "es/nested/index.yaml.skl",
+  "es/nested/index.yaml.xliff",
+  "es/nested/syntax/base.md.skl",
+  "es/nested/syntax/base.md.xliff",
+  "es/nested/syntax/lists.md.skl",
+  "es/nested/syntax/lists.md.xliff",
+  "es/nested/toc.yaml.skl",
+  "es/nested/toc.yaml.xliff",
+  "es/no-var-page.md.skl",
+  "es/no-var-page.md.xliff",
+  "es/to-be-excluded.md.skl",
+  "es/to-be-excluded.md.xliff",
   "es/toc.yaml.skl",
   "es/toc.yaml.xliff"
 ]"
@@ -2261,3 +2342,285 @@ exports[`Translate command > skip no-translate marked content 8`] = `
   </file>
 </xliff>"
 `;
+
+exports[`Translate command > test no-translate directive > filelist 1`] = `
+"[
+  "index.md.skl",
+  "index.md.xliff",
+  "no-translate.md.skl",
+  "no-translate.md.xliff",
+  "openapi-spec.yaml.skl",
+  "openapi-spec.yaml.xliff",
+  "toc.yaml.skl",
+  "toc.yaml.xliff"
+]"
+`;
+
+exports[`Translate command > test no-translate directive 1`] = `
+"## %%%0%%%
+
+::no-translate  [adsfasdfasdfasdfasdf]
+
+%%%1%%%
+
+%%%2%%%"
+`;
+
+exports[`Translate command > test no-translate directive 2`] = `
+"<?xml version="1.0" encoding="UTF-8"?>
+<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
+  <file original="file.ext" source-language="ru-RU" target-language="es-ES" datatype="markdown">
+    <header>
+      <skeleton>
+        <external-file href="file.skl"></external-file>
+      </skeleton>
+    </header>
+    <body>
+      <trans-unit id="0">
+        <source xml:space="preserve">Index header</source>
+      </trans-unit>
+      <trans-unit id="1">
+        <source xml:space="preserve">lorem</source>
+      </trans-unit>
+      <trans-unit id="2">
+        <source xml:space="preserve">asdfasdfasdf</source>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>"
+`;
+
+exports[`Translate command > test no-translate directive 3`] = `
+"# %%%0%%%
+
+## %%%1%%%
+:::no-translate
+### No-translate header
+
+:::html-block
+testsetsets
+:::
+
+::: any-other-directive
+content test
+:::
+
+Should not be translated.
+Can use **markup** inside.
+:::
+
+
+%%%2%%%
+
+## %%%3%%%
+
+::no-translate [## /usr/local/bin/application]
+::no-translate[**C:/Program Files/Application/config.ini**]
+::no-translate [~/Documents/project/src/main.rs]
+
+
+- :no-translate[GET /api/v1/users] %%%4%%%
+- :no-translate[POST /api/v1/auth/login] %%%5%%%
+- :no-translate[PUT /api/v1/users/{id}] %%%6%%%
+
+## %%%7%%%
+%%%8%%%
+:no-translate[The default port is unless specified.] %%%9%%%
+%%%10%%%
+
+## %%%11%%%
+%%%12%%%
+%%%13%%%
+%%%14%%%
+
+## %%%15%%%
+%%%16%%%
+
+## %%%17%%%
+%%%18%%%
+
+
+"
+`;
+
+exports[`Translate command > test no-translate directive 4`] = `
+"<?xml version="1.0" encoding="UTF-8"?>
+<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
+  <file original="file.ext" source-language="ru-RU" target-language="es-ES" datatype="markdown">
+    <header>
+      <skeleton>
+        <external-file href="file.skl"></external-file>
+      </skeleton>
+    </header>
+    <body>
+      <trans-unit id="0">
+        <source xml:space="preserve">No-translate directive</source>
+      </trans-unit>
+      <trans-unit id="1">
+        <source xml:space="preserve">Block directive</source>
+      </trans-unit>
+      <trans-unit id="2">
+        <source xml:space="preserve">::: some-other-directive<x ctype="lb" equiv-text="&amp;#10;" id="x-1"/>content here<x ctype="lb" equiv-text="&amp;#10;" id="x-2"/>:::<x ctype="lb" equiv-text="&amp;#10;" id="x-3"/>::: no-translate<x ctype="lb" equiv-text="&amp;#10;" id="x-4"/>content here<x ctype="lb" equiv-text="&amp;#10;" id="x-5"/>::: some-other-directive<x ctype="lb" equiv-text="&amp;#10;" id="x-6"/>nested content<x ctype="lb" equiv-text="&amp;#10;" id="x-7"/>:::<x ctype="lb" equiv-text="&amp;#10;" id="x-8"/>:::</source>
+      </trans-unit>
+      <trans-unit id="3">
+        <source xml:space="preserve">Leaf directive</source>
+      </trans-unit>
+      <trans-unit id="4">
+        <source xml:space="preserve">— get all users</source>
+      </trans-unit>
+      <trans-unit id="5">
+        <source xml:space="preserve">— authorization</source>
+      </trans-unit>
+      <trans-unit id="6">
+        <source xml:space="preserve">— update users data</source>
+      </trans-unit>
+      <trans-unit id="7">
+        <source xml:space="preserve">Simple case leaf</source>
+      </trans-unit>
+      <trans-unit id="8">
+        <source xml:space="preserve">Install using command.</source>
+      </trans-unit>
+      <trans-unit id="9">
+        <source xml:space="preserve">Next sentence.</source>
+      </trans-unit>
+      <trans-unit id="10">
+        <source xml:space="preserve">Set NODE_ENV=production for production builds.</source>
+      </trans-unit>
+      <trans-unit id="11">
+        <source xml:space="preserve">Simple case inline</source>
+      </trans-unit>
+      <trans-unit id="12">
+        <source xml:space="preserve">Install using <x ctype="no_translate_inline" equiv-text=":no-translate[npm install @company/package]" id="x-9"/> command.</source>
+      </trans-unit>
+      <trans-unit id="13">
+        <source xml:space="preserve">The default port is <x ctype="no_translate_inline" equiv-text=":no-translate[8080]" id="x-10"/> unless specified.</source>
+      </trans-unit>
+      <trans-unit id="14">
+        <source xml:space="preserve">Set <x ctype="no_translate_inline" equiv-text=":no-translate[NODE_ENV=production]" id="x-11"/> for production builds.</source>
+      </trans-unit>
+      <trans-unit id="15">
+        <source xml:space="preserve">Few inline directives</source>
+      </trans-unit>
+      <trans-unit id="16">
+        <source xml:space="preserve">Use <x ctype="no_translate_inline" equiv-text=":no-translate[**GET /api/v1/users**]" id="x-12"/> to list users and <x ctype="no_translate_inline" equiv-text=":no-translate[POST /api/v1/users]" id="x-13"/> to create.</source>
+      </trans-unit>
+      <trans-unit id="17">
+        <source xml:space="preserve">Empty inline directive</source>
+      </trans-unit>
+      <trans-unit id="18">
+        <source xml:space="preserve">This is text with empty <x ctype="no_translate_inline" equiv-text=":no-translate[]" id="x-14"/> directive.</source>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>"
+`;
+
+exports[`Translate command > test no-translate directive 5`] = `
+"openapi: 3.0.1
+info:
+  title: '%%%0%%%'
+  version: v0
+servers:
+  - url: http://localhost:8080
+    description: '%%%1%%%'
+paths:
+  /test:
+    get:
+      tags:
+        - test-controller
+      summary: '%%%2%%%'
+      description: '%%%3%%%'
+      operationId: getWithPayloadResponse
+      responses:
+        '200':
+          description: '%%%4%%%'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecurceTop'
+components:
+  schemas:
+    RecurceTop:
+      type: object
+      properties:
+        A:
+          type: string
+    RecurceMiddle:
+      type: object
+      properties:
+        B:
+          type: array
+          items:
+            $ref: '#/components/schemas/RecurceTop'
+"
+`;
+
+exports[`Translate command > test no-translate directive 6`] = `
+"<?xml version="1.0" encoding="UTF-8"?>
+<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
+  <file original="file.ext" source-language="ru-RU" target-language="es-ES" datatype="markdown">
+    <header>
+      <skeleton>
+        <external-file href="file.skl"></external-file>
+      </skeleton>
+    </header>
+    <body>
+      <trans-unit id="0">
+        <source xml:space="preserve">OpenAPI definition</source>
+      </trans-unit>
+      <trans-unit id="1">
+        <source xml:space="preserve">Generated server url</source>
+      </trans-unit>
+      <trans-unit id="2">
+        <source xml:space="preserve">Simple get operation. тест новой верстки 3</source>
+      </trans-unit>
+      <trans-unit id="3">
+        <source xml:space="preserve">Defines a simple get <x ctype="no_translate_inline" equiv-text=":no-translate[skip this]" id="x-15"/> operation with no inputs and a complex</source>
+      </trans-unit>
+      <trans-unit id="4">
+        <source xml:space="preserve">200!!!!</source>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>"
+`;
+
+exports[`Translate command > test no-translate directive 7`] = `
+"title: '%%%0%%%'
+href: index.md
+items:
+  - name: '%%%1%%%'
+    href: no-translate.md
+  - name: '%%%2%%%'
+    include:
+      path: openapi
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+      mode: link
+"
+`;
+
+exports[`Translate command > test no-translate directive 8`] = `
+"<?xml version="1.0" encoding="UTF-8"?>
+<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
+  <file original="file.ext" source-language="ru-RU" target-language="es-ES" datatype="markdown">
+    <header>
+      <skeleton>
+        <external-file href="file.skl"></external-file>
+      </skeleton>
+    </header>
+    <body>
+      <trans-unit id="0">
+        <source xml:space="preserve">Test123</source>
+      </trans-unit>
+      <trans-unit id="1">
+        <source xml:space="preserve">Не переводить</source>
+      </trans-unit>
+      <trans-unit id="2">
+        <source xml:space="preserve">openapi</source>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>"
+`;

package/e2e/errors.spec.ts

@@ -18,6 +18,7 @@ function test(path: string, expect: Function) {
     });
 }
 
+
 describe('Errors', () => {
     test('mocks/errors/unreachable-link', ({html}: TestResult) => {
         expectErrors(html, [
@@ -25,6 +26,21 @@ describe('Errors', () => {
             'ERR index.md: 2: YFM003 / unreachable-link Link is unreachable [Context: "[Unreachable link: "missed.html"][missed file](./missed.md)"]'
         ]);
     });
+
+    it('translate extract with filtered links', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/errors/extract-filtered-link');
+
+        const result = await TestAdapter.extract.run(inputPath, outputPath, ['--source', 'ru-RU', '--target', 'es-ES', '--filter']);
+        
+        expect(result.code).toEqual(1);
+        
+        expect(result.errors).toEqual([
+            "ERR File index.md contains link to filtered.md, which was filtered from toc.yaml or it's not been included initially",
+            "ERR File index.md contains link to filtered2.md, which was filtered from toc.yaml or it's not been included initially",
+            "ERR File index.md contains link to filtered2.md, which was filtered from toc.yaml or it's not been included initially",
+            "ERR File index.md contains link to filtered3.md, which was filtered from toc.yaml or it's not been included initially",
+        ])
+    });
 });
 
 describe('Warnings', () => {

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`,
         },
     );
 

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/utils/test.ts

@@ -5,6 +5,11 @@ export function platformless(text: string): string {
 
     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,

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/translation/dir-files/input/.yfm

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

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

@@ -1,7 +1,5 @@
 ## Заголовок include
 
-[ссылка на файл не в toc.yaml](./aboba-not-in-toc.md)
-
-{% include [Описание](./_includes/test.md) %}
-
+<!-- [ссылка на файл не в toc.yaml](./aboba-not-in-toc.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/syntax/base.md

@@ -1 +1,3 @@
 # Базовая разметка
+
+{% if test == "dev" %}[will be deleted on translate-extract](./index.md){% endif %}

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/mocks/translation/openapi/input/toc.yaml

@@ -5,4 +5,4 @@ items:
       includers:
         - name: openapi
           input: openapi-spec.yaml
-
+      mode: link

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/cli-tests",
-  "version": "5.8.4",
+  "version": "5.9.1",
   "bin": {
     "diplodoc-cli-test": "bin.mjs"
   },
@@ -27,6 +27,7 @@
     "@diplodoc/cli": "file:.."
   },
   "dependencies": {
+    "@diplodoc/liquid": "^1.3.4",
     "@types/node": "18.x",
     "@vitest/coverage-istanbul": "^3.1.1",
     "@vitest/coverage-v8": "^3.1.1",