@diplodoc/cli-tests 5.20.0 → 5.20.1

package/e2e/__snapshots__/cleanup-empty-dirs.spec.ts.snap

@@ -0,0 +1,71 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 1`] = `
+"ignoreStage:
+  - internal"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 2`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+vcsPath: active/page.md
+---
+# Active Page
+
+This is an active page that should be included in the build.
+
+Active variable: {{active_var}}"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 3`] = `
+"default:
+  active_var: active_value
+"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 4`] = `
+"title: Active Section
+items:
+  - name: Active Page
+    href: page.md
+path: active/toc.yaml
+"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 5`] = `
+"default:
+  empty_var: empty_value
+"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 6`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+vcsPath: index.md
+---
+# Main Page
+
+This is the main page content.
+
+Root variable: {{root_var}}"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 7`] = `
+"default:
+  root_var: root_value
+"
+`;
+
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 8`] = `
+"title: Test Documentation
+href: index.md
+items:
+  - name: Active Section
+    href: active/page.md
+path: toc.yaml
+"
+`;

package/e2e/cleanup-empty-dirs.spec.ts

@@ -0,0 +1,59 @@
+import {describe, expect, test} from 'vitest';
+import {existsSync} from 'node:fs';
+import {resolve} from 'node:path';
+
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+describe('Cleanup empty directories with stage filtering', () => {
+    test('should cleanup directories that contain only presets.yaml when TOC is ignored by stage', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/cleanup-empty-dirs');
+
+        // Test with disabled templating to trigger cleanupEmptyDirectories
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            args: '--no-template',
+        });
+
+        // Verify that the output directory structure is correct
+        await compareDirectories(outputPath, false, false, true);
+
+        // Check that active section files are present
+        expect(existsSync(resolve(outputPath, 'active/page.md'))).toBe(true);
+        expect(existsSync(resolve(outputPath, 'active/presets.yaml'))).toBe(true);
+        expect(existsSync(resolve(outputPath, 'active/toc.yaml'))).toBe(true);
+
+        expect(existsSync(resolve(outputPath, 'empty-section'))).toBe(true);
+        expect(existsSync(resolve(outputPath, 'empty-section/presets.yaml'))).toBe(true);
+
+        // Check that root files are present
+        expect(existsSync(resolve(outputPath, 'index.md'))).toBe(true);
+        expect(existsSync(resolve(outputPath, 'presets.yaml'))).toBe(true);
+        expect(existsSync(resolve(outputPath, 'toc.yaml'))).toBe(true);
+    });
+
+    test('should not cleanup directories when templating is enabled', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/cleanup-empty-dirs');
+
+        // Test with enabled templating - cleanup should not be triggered
+        await TestAdapter.testBuildPass(inputPath, outputPath + '-with-template', {
+            md2md: true,
+            args: '', // Default template enabled
+        });
+
+        // Check that empty-section directory exists (cleanup should not be triggered)
+        expect(existsSync(resolve(outputPath + '-with-template', 'empty-section'))).toBe(false);
+        expect(
+            existsSync(resolve(outputPath + '-with-template', 'empty-section/presets.yaml')),
+        ).toBe(false);
+
+        // Check that active section files are present
+        expect(existsSync(resolve(outputPath + '-with-template', 'active/page.md'))).toBe(true);
+        expect(existsSync(resolve(outputPath + '-with-template', 'active/presets.yaml'))).toBe(
+            false,
+        );
+
+        // Check that root files are present
+        expect(existsSync(resolve(outputPath + '-with-template', 'index.md'))).toBe(true);
+        expect(existsSync(resolve(outputPath + '-with-template', 'presets.yaml'))).toBe(false);
+    });
+});

package/e2e/errors.spec.ts

@@ -32,8 +32,8 @@ function test(path: string, expect: Function, additionalArgs: string[] = []) {
 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"; Reason: File is not declared in toc; Line: [existing file](./exists.md)"]',
-            'ERR index.md: 2: YFM003 / unreachable-link Link is unreachable [Context: "Unreachable link: "missed.html"; Reason: File is not declared in toc; Line: [missed file](./missed.md)"]',
+            'ERR index.md: 1: YFM003 / unreachable-link Link is unreachable [Context: "Unreachable link: "exists.html"; Reason: File is not declared in toc; Line: 1"]',
+            'ERR index.md: 2: YFM003 / unreachable-link Link is unreachable [Context: "Unreachable link: "missed.html"; Reason: File is not declared in toc; Line: 2"]',
         ]);
     });
 
@@ -86,7 +86,7 @@ describe('Errors', () => {
 describe('Warnings', () => {
     test('mocks/warning/unreachable-autotitle', ({html}: TestResult) => {
         expectWarnings(html, [
-            'WARN index.md: 1: YFM010 / unreachable-autotitle-anchor Auto title anchor is unreachable [Context: "[Unreachable autotitle anchor: "link.html#unknown_yfm010"][{#T}](./link.md#unknown_yfm010)"]',
+            'WARN index.md: 1: YFM010 / unreachable-autotitle-anchor Auto title anchor is unreachable [Context: "[Unreachable autotitle anchor: "link.html#unknown_yfm010"] [{#T}](./link.md#unknown_yfm010)"]',
         ]);
     });
 });

package/mocks/cleanup-empty-dirs/input/.yfm

@@ -0,0 +1,2 @@
+ignoreStage:
+  - internal

package/mocks/cleanup-empty-dirs/input/active/page.md

@@ -0,0 +1,5 @@
+# Active Page
+
+This is an active page that should be included in the build.
+
+Active variable: {{active_var}}

package/mocks/cleanup-empty-dirs/input/active/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  active_var: active_value

package/mocks/cleanup-empty-dirs/input/active/toc.yaml

@@ -0,0 +1,4 @@
+title: Active Section
+items:
+  - name: Active Page
+    href: page.md

package/mocks/cleanup-empty-dirs/input/empty-section/page.md

@@ -0,0 +1,5 @@
+# Empty Page
+
+This page should be ignored because the TOC has stage "internal".
+
+Empty variable: {{empty_var}}

package/mocks/cleanup-empty-dirs/input/empty-section/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  empty_var: empty_value

package/mocks/cleanup-empty-dirs/input/empty-section/toc.yaml

@@ -0,0 +1,5 @@
+title: Empty Section
+stage: internal
+items:
+  - name: Empty Page
+    href: page.md

package/mocks/cleanup-empty-dirs/input/index.md

@@ -0,0 +1,5 @@
+# Main Page
+
+This is the main page content.
+
+Root variable: {{root_var}}

package/mocks/cleanup-empty-dirs/input/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  root_var: root_value

package/mocks/cleanup-empty-dirs/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Test Documentation
+href: index.md
+items:
+  - name: Active Section
+    href: active/page.md

package/package.json

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