@diplodoc/cli-tests 5.43.2 → 5.44.0

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

@@ -35,12 +35,6 @@ 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
@@ -54,13 +48,13 @@ 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`] = `
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 6`] = `
 "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`] = `
+exports[`Cleanup empty directories with stage filtering > should cleanup directories that contain only presets.yaml when TOC is ignored by stage 7`] = `
 "title: Test Documentation
 href: index.md
 items:

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

@@ -0,0 +1,257 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html > filelist 1`] = `
+"[
+  ".yfm",
+  "api.md",
+  "index.md",
+  "llms-full.txt",
+  "llms.txt",
+  "start.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html > filelist 2`] = `
+"[
+  ".yfm",
+  "api.html",
+  "index.html",
+  "llms-full.txt",
+  "llms.txt",
+  "start.html",
+  "toc.js"
+]"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 1`] = `
+"allowHtml: true
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 2`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+description: Full reference of the public HTTP endpoints.
+vcsPath: api.md
+---
+
+# API Reference
+
+## GET /things
+
+Returns the list of things.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 3`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+title: Overview
+description: What this product is and how to get started.
+vcsPath: index.md
+---
+
+# Overview
+
+Welcome to **My Product** — the documentation home page.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 4`] = `
+"# My Product
+
+# Overview
+
+Welcome to **My Product** — the documentation home page.
+
+# Getting Started
+
+Run the installer and create your first project.
+
+## Requirements
+
+- Node.js 18+
+- 2 GB RAM
+
+# API Reference
+
+## GET /things
+
+Returns the list of things.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 5`] = `
+"# My Product
+
+- [Overview](index.md): What this product is and how to get started.
+- [Getting Started](start.md): Install the product and build your first project.
+- [API Reference](api.md): Full reference of the public HTTP endpoints.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 6`] = `
+"---
+metadata:
+  - name: generator
+    content: Diplodoc Platform vDIPLODOC-VERSION
+description: Install the product and build your first project.
+vcsPath: start.md
+---
+
+# Getting Started
+
+Run the installer and create your first project.
+
+<!-- source: _includes/requirements.md -->
+## Requirements
+
+- Node.js 18+
+- 2 GB RAM
+<!-- endsource: _includes/requirements.md -->
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 7`] = `
+"title: My Product
+href: index.md
+items:
+  - name: Getting Started
+    href: start.md
+  - name: API Reference
+    href: api.md
+path: toc.yaml
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 8`] = `
+"allowHtml: true
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 9`] = `
+"<!DOCTYPE html>
+<html lang="ru" dir="ltr">
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <base href="./" />
+        <title>API Reference | My Product</title>
+        <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
+        <meta name="description" content="Full reference of the public HTTP endpoints.">
+        <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
+    </head>
+    <body class="g-root g-root_theme_light">
+        <div id="root"></div>
+        <script type="application/json" id="diplodoc-state">
+            {"data":{"leading":false,"html":"&lt;h2 id=\\"get-/things\\"&gt;&lt;a href=\\"api.html#get-/things\\" class=\\"yfm-anchor yfm-clipboard-anchor\\" aria-hidden=\\"true\\"&gt;&lt;span class=\\"visually-hidden\\" data-no-index=\\"true\\"&gt;GET /things&lt;/span&gt;&lt;/a&gt;GET /things&lt;/h2&gt;/n&lt;p&gt;Returns the list of things.&lt;/p&gt;/n","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"description","content":"Full reference of the public HTTP endpoints."}],"description":"Full reference of the public HTTP endpoints.","vcsPath":"api.md"},"headings":[{"title":"GET /things","href":"api.html#get-/things","level":2}],"title":"API Reference"},"router":{"pathname":"api","depth":1,"base":"./"},"lang":"ru","langs":["ru"],"viewerInterface":{"toc":true,"search":true,"feedback":true}}
+        </script>
+        <script type="application/javascript">
+            const data = document.querySelector('script#diplodoc-state');
+            window.__DATA__ = JSON.parse((function unescape(string) {
+                return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
+              })(data.innerText));
+            window.STATIC_CONTENT = false;
+        </script>
+        <script type="application/javascript" defer src="toc.js"></script>
+    </body>
+</html>"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 10`] = `
+"<!DOCTYPE html>
+<html lang="ru" dir="ltr">
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <base href="./" />
+        <title>Overview | My Product</title>
+        <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
+        <meta name="description" content="What this product is and how to get started.">
+        <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
+    </head>
+    <body class="g-root g-root_theme_light">
+        <div id="root"></div>
+        <script type="application/json" id="diplodoc-state">
+            {"data":{"leading":false,"html":"&lt;p&gt;Welcome to &lt;strong&gt;My Product&lt;/strong&gt; — the documentation home page.&lt;/p&gt;/n","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"description","content":"What this product is and how to get started."}],"title":"Overview","description":"What this product is and how to get started.","vcsPath":"index.md"},"headings":[],"title":"Overview"},"router":{"pathname":"index","depth":1,"base":"./"},"lang":"ru","langs":["ru"],"viewerInterface":{"toc":true,"search":true,"feedback":true}}
+        </script>
+        <script type="application/javascript">
+            const data = document.querySelector('script#diplodoc-state');
+            window.__DATA__ = JSON.parse((function unescape(string) {
+                return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
+              })(data.innerText));
+            window.STATIC_CONTENT = false;
+        </script>
+        <script type="application/javascript" defer src="toc.js"></script>
+    </body>
+</html>"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 11`] = `
+"# My Product
+
+# Overview
+
+Welcome to **My Product** — the documentation home page.
+
+# Getting Started
+
+Run the installer and create your first project.
+
+## Requirements
+
+- Node.js 18+
+- 2 GB RAM
+
+# API Reference
+
+## GET /things
+
+Returns the list of things.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 12`] = `
+"# My Product
+
+- [Overview](index.html): What this product is and how to get started.
+- [Getting Started](start.html): Install the product and build your first project.
+- [API Reference](api.html): Full reference of the public HTTP endpoints.
+"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 13`] = `
+"<!DOCTYPE html>
+<html lang="ru" dir="ltr">
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <base href="./" />
+        <title>Getting Started | My Product</title>
+        <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
+        <meta name="description" content="Install the product and build your first project.">
+        <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
+    </head>
+    <body class="g-root g-root_theme_light">
+        <div id="root"></div>
+        <script type="application/json" id="diplodoc-state">
+            {"data":{"leading":false,"html":"&lt;p&gt;Run the installer and create your first project.&lt;/p&gt;/n&lt;h2 id=\\"requirements\\"&gt;&lt;a href=\\"start.html#requirements\\" class=\\"yfm-anchor yfm-clipboard-anchor\\" aria-hidden=\\"true\\"&gt;&lt;span class=\\"visually-hidden\\" data-no-index=\\"true\\"&gt;Requirements&lt;/span&gt;&lt;/a&gt;Requirements&lt;/h2&gt;/n&lt;ul&gt;/n&lt;li&gt;Node.js 18+&lt;/li&gt;/n&lt;li&gt;2 GB RAM&lt;/li&gt;/n&lt;/ul&gt;/n","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"description","content":"Install the product and build your first project."}],"description":"Install the product and build your first project.","vcsPath":"start.md"},"headings":[{"title":"Requirements","href":"start.html#requirements","level":2}],"title":"Getting Started"},"router":{"pathname":"start","depth":1,"base":"./"},"lang":"ru","langs":["ru"],"viewerInterface":{"toc":true,"search":true,"feedback":true}}
+        </script>
+        <script type="application/javascript">
+            const data = document.querySelector('script#diplodoc-state');
+            window.__DATA__ = JSON.parse((function unescape(string) {
+                return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
+              })(data.innerText));
+            window.STATIC_CONTENT = false;
+        </script>
+        <script type="application/javascript" defer src="toc.js"></script>
+    </body>
+</html>"
+`;
+
+exports[`llms.txt > generates llms.txt and llms-full.txt for md and html 14`] = `"window.__DATA__.data.toc = {"title":"My Product","href":"index.html","items":[{"name":"Getting Started","href":"start.html","id":"UUID"},{"name":"API Reference","href":"api.html","id":"UUID"}],"path":"toc.yaml","id":"UUID"};"`;

package/e2e/assets.spec.ts

@@ -1,4 +1,6 @@
-import {describe, it} from 'vitest';
+import {describe, expect, it} from 'vitest';
+import fs from 'node:fs';
+import {join} from 'node:path';
 
 import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
 
@@ -13,4 +15,17 @@ describe('Assets', () => {
         });
         await compareDirectories(outputPath);
     });
+
+    it('Assets HTML', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/assets');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: false,
+            md2html: true,
+            args: '-j2',
+        });
+
+        expect(fs.existsSync(join(outputPath, '_images/mountain.jpg'))).toBe(true);
+        expect(fs.existsSync(join(outputPath, '_images/versions.png'))).toBe(true);
+    });
 });

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

@@ -22,8 +22,8 @@ describe('Cleanup empty directories with stage filtering', () => {
         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);
+        expect(existsSync(resolve(outputPath, 'empty-section'))).toBe(false);
+        expect(existsSync(resolve(outputPath, 'empty-section/presets.yaml'))).toBe(false);
 
         // Check that root files are present
         expect(existsSync(resolve(outputPath, 'index.md'))).toBe(true);

package/e2e/crawler-manifest.spec.ts

@@ -86,13 +86,13 @@ describe('Crawler manifest', () => {
         const manifest = JSON.parse(manifestContent);
 
         expect(manifest.notifications).toEqual({
-            channels: ['email', 'messenger'],
             interval: 'daily',
-            receivers: ['user1', 'user2'],
+            emailReceivers: ['user1', 'user2'],
+            messengerReceivers: ['user1', 'user2'],
         });
     });
 
-    test('includes notifications from docs-viewer.crawler config with default channel', async () => {
+    test('includes notifications from docs-viewer.crawler config with default interval', async () => {
         const {inputPath, outputPath} = getTestPaths(
             'mocks/crawler-manifest/notifications-docs-viewer',
         );
@@ -106,9 +106,8 @@ describe('Crawler manifest', () => {
         const manifest = JSON.parse(manifestContent);
 
         expect(manifest.notifications).toEqual({
-            channels: ['email'],
             interval: 'weekly',
-            receivers: ['user3'],
+            emailReceivers: ['user3'],
         });
     });
 

package/e2e/llms.spec.ts

@@ -0,0 +1,24 @@
+import {describe, test} from 'vitest';
+
+import {TestAdapter, compareDirectories, getTestPaths} from '../fixtures';
+
+describe('llms.txt', () => {
+    // Builds the same fixture in both md and html with `--llms` (variant B):
+    //   - md  output -> `${outputPath}`      (llms-full.txt has includes merged)
+    //   - html output -> `${outputPath}-html` (llms-full.txt keeps include directives)
+    // The fixture also has per-page frontmatter descriptions (surfaced in
+    // llms.txt) and a `when: showBeta` page that the default version filters
+    // out — proving the artifacts stay consistent with the built "version".
+    test('generates llms.txt and llms-full.txt for md and html', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/llms');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: true,
+            args: '--llms',
+        });
+
+        await compareDirectories(outputPath);
+        await compareDirectories(`${outputPath}-html`);
+    });
+});

package/mocks/crawler-manifest/notifications-docs-viewer/input/.yfm

@@ -4,5 +4,5 @@ docs-viewer:
   crawler:
     notifications:
       interval: weekly
-      receivers:
+      emailReceivers:
         - user3

package/mocks/crawler-manifest/notifications-root/input/.yfm

@@ -3,7 +3,9 @@ crawlerManifest: true
 crawler:
   notifications:
     interval: daily
-    channels: ['email', 'messenger']
-    receivers:
+    emailReceivers:
+      - user1
+      - user2
+    messengerReceivers:
       - user1
       - user2

package/mocks/llms/input/.yfm

@@ -0,0 +1 @@
+allowHtml: true

package/mocks/llms/input/_includes/requirements.md

@@ -0,0 +1,4 @@
+## Requirements
+
+- Node.js 18+
+- 2 GB RAM

package/mocks/llms/input/api.md

@@ -0,0 +1,9 @@
+---
+description: Full reference of the public HTTP endpoints.
+---
+
+# API Reference
+
+## GET /things
+
+Returns the list of things.

package/mocks/llms/input/beta.md

@@ -0,0 +1,4 @@
+# Beta Feature
+
+This page is gated behind `when: showBeta` and must NOT appear in the llms
+artifacts for the default (showBeta = false) version.

package/mocks/llms/input/index.md

@@ -0,0 +1,8 @@
+---
+title: Overview
+description: What this product is and how to get started.
+---
+
+# Overview
+
+Welcome to **My Product** — the documentation home page.

package/mocks/llms/input/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  showBeta: false

package/mocks/llms/input/start.md

@@ -0,0 +1,9 @@
+---
+description: Install the product and build your first project.
+---
+
+# Getting Started
+
+Run the installer and create your first project.
+
+{% include [Requirements](_includes/requirements.md) %}

package/mocks/llms/input/toc.yaml

@@ -0,0 +1,11 @@
+title: My Product
+href: index.md
+
+items:
+  - name: Getting Started
+    href: start.md
+  - name: API Reference
+    href: api.md
+  - name: Beta Feature
+    href: beta.md
+    when: showBeta

package/package.json

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