@diplodoc/cli-tests 5.9.5 → 5.10.1

package/e2e/bundles.spec.ts

@@ -0,0 +1,15 @@
+import {describe, it} from 'vitest';
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+describe('Check bundles', () => {
+    it('bundles list is correct', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/bundles');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: false,
+            md2html: true,
+            args: '-j2',
+        });
+        await compareDirectories(outputPath, false, true);
+    });
+});

package/fixtures/utils/file.ts

@@ -5,14 +5,38 @@ import {glob} from 'glob';
 import {bundleless, hashless, platformless} from './test';
 import {expect} from 'vitest';
 
+const SYSTEM_DIRS = ['_bundle/', '_search/'];
+
 export function getFileContent(filePath: string) {
     return platformless(bundleless(readFileSync(filePath, 'utf8')));
 }
 
-const uselessFile = (file: string) =>
-    !['_bundle/', '_assets/', '_search/'].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('|');
+
+    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, '');
+
+    return content;
+}
 
-export async function compareDirectories(outputPath: string, ignoreFileContent = false) {
+export async function compareDirectories(
+    outputPath: string,
+    ignoreFileContent = false,
+    checkBundle = false,
+) {
     const filesFromOutput = (
         await glob(`**/*`, {
             cwd: outputPath,
@@ -23,11 +47,30 @@ export async function compareDirectories(outputPath: string, ignoreFileContent =
         })
     ).map(bundleless).sort();
 
-    expect(hashless(JSON.stringify(filesFromOutput, null, 2))).toMatchSnapshot('filelist');
+    let filesForSnapshot;
+
+    if (checkBundle) {
+        filesForSnapshot = filesFromOutput;
+    } else {
+        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(); 
+
+    expect(JSON.stringify(filesForSnapshot, null, 2)).toMatchSnapshot('filelist');
 
     if (!ignoreFileContent) {
-        filesFromOutput.filter(uselessFile).forEach((filePath) => {
-            const 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);
+            }
+
             expect(content).toMatchSnapshot();
         });
     }

package/mocks/bundles/input/.yfm

@@ -0,0 +1,13 @@
+allowHTML: true
+
+meta:
+  rootPath: http://127.0.0.1:5000/
+
+interface:
+  toc-header: false
+  favicon-src: https://storage.yandexcloud.net/diplodoc-www-assets/favicon/favicon.ico
+
+search:
+  provider: local
+  tolerance: 2
+  confidense: phrased

package/mocks/bundles/input/index.md

@@ -0,0 +1,12 @@
+---
+  availableLangs:
+    - en
+    - ru
+---
+
+# Header
+
+Content
+
+[Link 1](page1.md)
+[Link 2](page2.md)

package/mocks/bundles/input/page1.md

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

package/mocks/bundles/input/page2.md

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

package/mocks/bundles/input/toc.yaml

@@ -0,0 +1,9 @@
+title: Skip html extension
+href: index.md
+
+items:
+  - name: Title 1
+    href: page1.md
+  - name: Title 2
+    href: page2.md
+    

package/package.json

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