@diplodoc/cli-tests 5.12.1 → 5.12.3

package/e2e/metadata.spec.ts

@@ -1,4 +1,5 @@
 import {describe, test} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 const generateMapTestTemplate = (

package/e2e/pdf-page.spec.ts

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

package/e2e/plugin-corner-cases.spec.ts

@@ -1,4 +1,5 @@
 import {describe, it} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 describe('plugin corner cases:', () => {

package/e2e/preprocess.test.ts

@@ -1,4 +1,5 @@
 import {describe, test} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 const generateFilesYamlTestTemplate = (
@@ -9,7 +10,7 @@ const generateFilesYamlTestTemplate = (
     test(testTitle, async () => {
         const {inputPath, outputPath} = getTestPaths(testRootPath);
         await TestAdapter.testBuildPass(inputPath, outputPath, {
-            md2md:true,
+            md2md: true,
             md2html: false,
             args: args.join(' '),
         });
@@ -24,14 +25,16 @@ const generateFilesYamlTestTemplate = (
 
 describe('Preprocess', () => {
     generateFilesYamlTestTemplate('HashIncludes=true,Autotitles=false', 'mocks/preprocess', [
-        '--no-merge-autotitles'
+        '--no-merge-autotitles',
     ]);
 
     generateFilesYamlTestTemplate('HashIncludes=true,Autotitles=true', 'mocks/preprocess');
 
-    generateFilesYamlTestTemplate('HashIncludes=true,Autotitles=true,Svg=true', 'mocks/preprocess', [
-        '--merge-svg'
-    ]);
+    generateFilesYamlTestTemplate(
+        'HashIncludes=true,Autotitles=true,Svg=true',
+        'mocks/preprocess',
+        ['--merge-svg'],
+    );
 
     // generateFilesYamlTestTemplate('Nested toc restricted access', 'mocks/preprocess/test3');
 });

package/e2e/redirects-validation.spec.ts

@@ -1,4 +1,5 @@
 import {describe, expect, it} from 'vitest';
+
 import {TestAdapter, getTestPaths} from '../fixtures';
 
 describe('Redirects validation', () => {
@@ -38,7 +39,9 @@ describe('Redirects validation', () => {
     });
 
     it('should emit an error when a redirect is malformed', async () => {
-        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/malformed-redirect');
+        const {inputPath, outputPath} = getTestPaths(
+            'mocks/redirects-validation/malformed-redirect',
+        );
 
         const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
 
@@ -54,8 +57,6 @@ describe('Redirects validation', () => {
         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/),
-        );
+        expect(report.errors).toContainEqual(expect.stringMatching(/Parameters must be different/));
     });
 });

package/e2e/regression.test.ts

@@ -1,5 +1,6 @@
 import {describe, it} from 'vitest';
 import {dedent} from 'ts-dedent';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 function test(_description: string) {

package/e2e/restricted-access.test.ts

@@ -1,13 +1,11 @@
 import {describe, test} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
-const generateFilesYamlTestTemplate = (
-    testTitle: string,
-    testRootPath: string
-) => {
+const generateFilesYamlTestTemplate = (testTitle: string, testRootPath: string) => {
     test(testTitle, async () => {
         const {inputPath, outputPath} = getTestPaths(testRootPath);
-        await TestAdapter.testBuildPass(inputPath, outputPath, {md2md:true});
+        await TestAdapter.testBuildPass(inputPath, outputPath, {md2md: true});
         await compareDirectories(outputPath);
     });
 };

package/e2e/rtl.spec.ts

@@ -1,4 +1,5 @@
 import {describe, test} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 const generateMapTestTemplate = (

package/e2e/search.test.ts

@@ -1,4 +1,5 @@
 import {describe, it} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 describe('Local search', () => {

package/e2e/single-page.spec.ts

@@ -1,4 +1,5 @@
 import {describe, test} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 const generateMapTestSinglePageTemplate = (

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

@@ -1,4 +1,5 @@
 import {describe, it} from 'vitest';
+
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 describe('Skip html extension', () => {

package/e2e/translation.spec.ts

@@ -1,5 +1,8 @@
+import type {TranslateRunArgs} from '../fixtures';
+
 import {describe, test} from 'vitest';
-import {TestAdapter, TranslateRunArgs, compareDirectories, getTestPaths} from '../fixtures';
+
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
 const generateMapTestTemplate = (
     testTitle: string,
@@ -46,9 +49,17 @@ const buildFilesYamlTestTemplate = (
 };
 
 describe('Translate command', () => {
-    buildFilesYamlTestTemplate('build translated md files and remove no-translate directives', 'mocks/translation/no-translate', {md2md: true});
+    buildFilesYamlTestTemplate(
+        'build translated md files and remove no-translate directives',
+        'mocks/translation/no-translate',
+        {md2md: true},
+    );
 
-    buildFilesYamlTestTemplate('build translated static files and remove no-translate directives', 'mocks/translation/no-translate', {md2html: true});
+    buildFilesYamlTestTemplate(
+        'build translated static files and remove no-translate directives',
+        'mocks/translation/no-translate',
+        {md2html: true},
+    );
 
     generateFilesYamlTestTemplate('extract openapi spec files', 'mocks/translation/openapi', {
         subcommand: 'extract',
@@ -66,7 +77,7 @@ describe('Translate command', () => {
         subcommand: 'extract',
         source: 'ru-RU',
         target: 'es-ES',
-        additionalArgs: '--filter'
+        additionalArgs: '--filter',
     });
 
     generateMapTestTemplate(
@@ -80,7 +91,7 @@ describe('Translate command', () => {
         },
     );
 
-    const vars = {skip: 'prod'}
+    const vars = {skip: 'prod'};
     generateMapTestTemplate(
         'filter files on extract with extra vars option',
         'mocks/translation/dir-files',
@@ -98,7 +109,7 @@ describe('Translate command', () => {
         {
             subcommand: 'extract',
             source: 'ru-RU',
-            target: 'es-ES',            
+            target: 'es-ES',
         },
         false,
     );

package/fixtures/cliAdapter.ts

@@ -1,4 +1,6 @@
-import {Runner, createRunner} from './runners';
+import type {Runner} from './runners';
+
+import {createRunner} from './runners';
 import {cleanupDirectory} from './utils/file';
 
 export interface BuildRunArgs {
@@ -76,8 +78,10 @@ export class CliTestAdapter {
         const tasks = [];
 
         if (md2md && md2html) {
-            tasks.push(() => this.build.run(inputPath, outputPath,[...baseArgs, '-f', 'md']));
-            tasks.push(() => this.build.run(inputPath, `${outputPath}-html`, [...baseArgs, '-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) {
             tasks.push(() => this.build.run(inputPath, outputPath, [...baseArgs, '-f', 'md']));
         } else {

package/fixtures/globals.d.ts

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

package/fixtures/runners/binary.ts

@@ -1,4 +1,5 @@
-import {Runner} from './types';
+import type {Runner} from './types';
+
 import {execa} from 'execa';
 import strip from 'strip-ansi';
 
@@ -20,6 +21,7 @@ export class BinaryRunner implements Runner {
         const restLog = fillLog(/^(?!INFO|WARN|ERR)/, stderr);
         if (restLog.length) {
             for (const line of restLog) {
+                // eslint-disable-next-line no-console
                 console.log(line);
             }
         }
@@ -29,7 +31,8 @@ export class BinaryRunner implements Runner {
 }
 
 function fillLog(filter: RegExp, source: string) {
-    return source.split('\n')
+    return source
+        .split('\n')
         .map((line) => strip(line).trim())
         .filter(Boolean)
         .filter((line) => line.match(filter));

package/fixtures/runners/index.ts

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

package/fixtures/runners/source.ts

@@ -8,7 +8,7 @@ export class SourceRunner {
 
         const baseArgs = ['node', this.MODULE_PATH, ...argv];
 
-        const report = await run(baseArgs) as Report;
+        const report = (await run(baseArgs)) as Report;
 
         return report;
     }

package/fixtures/utils/file.ts

@@ -2,29 +2,29 @@ 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 {bundleless, hashless, platformless} from './test';
+
 const SYSTEM_DIRS = ['_bundle/', '_search/'];
 
 export function getFileContent(filePath: string) {
     return platformless(bundleless(readFileSync(filePath, 'utf8')));
 }
 
-const uselessFile = (file: string, dirs: string[]) =>
-    !dirs.some((part) => file.includes(part));
+const uselessFile = (file: string, dirs: string[]) => !dirs.some((part) => file.includes(part));
 
 export function stripSystemLinks(content: string) {
-    const dirPattern = SYSTEM_DIRS.map(d => d.replace('/', '\\/')).join('|');
+    const dirPattern = SYSTEM_DIRS.map((d) => d.replace('/', '\\/')).join('|');
 
     content = content.replace(
         new RegExp(`<script[^>]+src="(?:${dirPattern})[^"]*"[^>]*></script>`, 'g'),
-        ''
+        '',
     );
 
     content = content.replace(
         new RegExp(`<link[^>]+href="(?:${dirPattern})[^"]*"[^>]*\\/?>`, 'g'),
-        ''
+        '',
     );
 
     content = content.replace(/^[ \t]*\r?\n/gm, '');
@@ -45,34 +45,38 @@ export async function compareDirectories(
             nodir: true,
             posix: true,
         })
-    ).map(bundleless).sort();
+    )
+        .map(bundleless)
+        .sort();
 
     let filesForSnapshot;
 
     if (checkBundle) {
         filesForSnapshot = filesFromOutput;
     } else {
-        filesForSnapshot = filesFromOutput.filter(file => uselessFile(file, SYSTEM_DIRS));
+        filesForSnapshot = filesFromOutput.filter((file) => uselessFile(file, SYSTEM_DIRS));
     }
 
     // Here we sort the order of the included files after all processing
     // This is necessary for better test stability
     // We do not care in what order these files were received and processed
     // We sort only the final list and put it in the snapshot
-    filesForSnapshot = filesForSnapshot.map(hashless).sort(); 
+    filesForSnapshot = filesForSnapshot.map(hashless).sort();
 
     expect(JSON.stringify(filesForSnapshot, null, 2)).toMatchSnapshot('filelist');
 
     if (!ignoreFileContent) {
-        filesFromOutput.filter(file => uselessFile(file, ['_assets/', ...SYSTEM_DIRS])).forEach((filePath) => {
-            let content = getFileContent(resolve(outputPath, filePath));
+        filesFromOutput
+            .filter((file) => uselessFile(file, ['_assets/', ...SYSTEM_DIRS]))
+            .forEach((filePath) => {
+                let content = getFileContent(resolve(outputPath, filePath));
 
-            if (!checkBundle && filePath.endsWith('.html')) {
-                content = stripSystemLinks(content);
-            }
+                if (!checkBundle && filePath.endsWith('.html')) {
+                    content = stripSystemLinks(content);
+                }
 
-            expect(content).toMatchSnapshot();
-        });
+                expect(content).toMatchSnapshot();
+            });
     }
 }
 

package/fixtures/utils/test.ts

@@ -1,26 +1,27 @@
-
 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(
-            /id=\\"inline-code-id-[a-zA-Z0-9]{8}\\"/g,
-            () => `id="inline-code-id-${index++}"`
-        )
+    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(
+                /id=\\"inline-code-id-[a-zA-Z0-9]{8}\\"/g,
+                () => `id="inline-code-id-${index++}"`,
+            )
+    );
 }
 
 export function hashless(text: string): string {
@@ -45,4 +46,3 @@ export function bundleless(text: string): string {
 
     return text;
 }
-

package/mocks/pdf-page/input/.yfm

@@ -0,0 +1,7 @@
+allowHTML: true
+
+hiddenPolicy:
+  pdf: true
+
+docs-viewer:
+  pdf: true

package/mocks/pdf-page/input/index.md

@@ -0,0 +1,6 @@
+# Header
+
+Content
+
+[Link 1](page1.md)
+[Link 2](page2.md)

package/mocks/pdf-page/input/page1.md

@@ -0,0 +1,3 @@
+# Page 1
+
+[Link](page2.md#hash)

package/mocks/pdf-page/input/page2.md

@@ -0,0 +1,5 @@
+# Page 2
+
+## hash
+
+[External link](https://example.com)

package/mocks/pdf-page/input/page3.md

@@ -0,0 +1 @@
+# Page 3

package/mocks/pdf-page/input/toc.yaml

@@ -0,0 +1,15 @@
+title: Skip html extension
+href: index.md
+
+items:
+  - name: Title 1
+    href: page1.md
+  - name: Title 2
+    href: page2.md
+    hidden: true
+  - name: Without href
+    hidden: true
+    items:
+      - name: Title 3
+        href: page3.md
+    

package/mocks/preprocess/input/autotitle.md

@@ -29,6 +29,9 @@ Reference link with hash
 [link]: ./mermaid.md
 [link-with-hash]: ./1.md#subtitle
 
+Link another level
+[{#T}](./includes/level11.md)
+
 ## Header {#header}
 
 Content

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

@@ -0,0 +1,9 @@
+# Level 1 svg header in includes ![Level 1 svg header in includes](../_assets/1.svg)
+
+[{#T}](../level1/level1.md)
+
+[{#T}](../level1/level2/level2.md)
+
+{% include [{#T}](level2/level2.md) %}
+
+[{#T}](level11.md)

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

@@ -0,0 +1 @@
+# Level 11 svg header ![Level 11 svg header](../_assets/1.svg)

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

@@ -0,0 +1,7 @@
+# Level 2 svg header ![Level 2 svg header](../../_assets/1.svg)
+
+[{#T}](../level1.md)
+
+[{#T}](../../level0.md)
+
+[{#T}](../../level1/level1.md)

package/mocks/preprocess/input/level0.md

@@ -0,0 +1,7 @@
+# Level root svg header ![Level root svg header](_assets/1.svg)
+
+[{#T}](images.md)
+
+[{#T}](level1/level1.md)
+
+[{#T}](level1/level2/level2.md)

package/mocks/preprocess/input/level1/level1.md

@@ -0,0 +1,7 @@
+# Level 1 svg header ![Level 1 svg header](../_assets/1.svg)
+
+[{#T}](../level0.md)
+
+[{#T}](level2/level2.md)
+
+[{#T}](../includes/level11.md)

package/mocks/preprocess/input/level1/level2/level2.md

@@ -0,0 +1,6 @@
+# Level 2 svg header ![Level 2 svg header](../../_assets/1.svg)
+
+[{#T}](../level1.md)
+
+[{#T}](../../level0.md)
+

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

@@ -0,0 +1,5 @@
+items:
+  - name: level1
+    href: ./level1
+  - name: level2
+    href: ./level2/level2

package/mocks/preprocess/input/toc.yaml

@@ -14,3 +14,11 @@ items:
     href: ./autotitle
   - name: includes
     href: ./includes
+  - name: level11
+    href: ./includes/level11
+  - name: level0
+    href: ./level0
+  - name: level1
+    href: ./level1/level1
+  - name: level2
+    href: ./level1/level2/level2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/cli-tests",
-  "version": "5.12.1",
+  "version": "5.12.3",
   "bin": {
     "diplodoc-cli-test": "bin.mjs"
   },