@diplodoc/cli-tests 5.27.4 → 5.28.0

package/e2e/__snapshots__/crawler-manifest.spec.ts.snap

@@ -0,0 +1,26 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Crawler manifest > generates crawler-manifest.json 1`] = `
+{
+  "ru/index.md": [
+    "https://example.com",
+    "http://http.example.com",
+    "https://autolink.example.com",
+    "https://plain.example.com",
+    "https://image.example.com/logo.png",
+    "https://included.example.com",
+  ],
+  "ru/leading.yaml": [
+    "https://yaml.example.com",
+  ],
+  "ru/old-page": [
+    "https://external-redirect.example.com",
+  ],
+  "ru/references.md": [
+    "https://reference.example.com",
+  ],
+  "toc.yaml": [
+    "https://toc.example.com",
+  ],
+}
+`;

package/e2e/crawler-manifest.spec.ts

@@ -0,0 +1,58 @@
+import {describe, expect, test} from 'vitest';
+import {join} from 'node:path';
+import {access, readFile} from 'node:fs/promises';
+
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+describe('Crawler manifest', () => {
+    test('generates crawler-manifest.json', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/crawler-manifest/with-links');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: '--crawler-manifest',
+        });
+
+        const manifestContent = await readFile(join(outputPath, 'crawler-manifest.json'), 'utf-8');
+
+        expect(JSON.parse(manifestContent)).toMatchSnapshot();
+    });
+
+    test('does not generate manifest when --crawler-manifest flag is absent', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/crawler-manifest/with-links');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+        });
+
+        await expect(access(join(outputPath, 'crawler-manifest.json'))).rejects.toThrow();
+    });
+
+    test('does not generate manifest when there are no external links', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/crawler-manifest/no-links');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: '--crawler-manifest',
+        });
+
+        await expect(access(join(outputPath, 'crawler-manifest.json'))).rejects.toThrow();
+    });
+
+    test('reads crawlerManifest setting from .yfm config file', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/crawler-manifest/config');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+        });
+
+        const manifestContent = await readFile(join(outputPath, 'crawler-manifest.json'), 'utf-8');
+        const manifest = JSON.parse(manifestContent);
+
+        expect(manifest['index.md']).toContain('https://config.example.com');
+    });
+});

package/e2e/openapi-include-size.spec.ts

@@ -0,0 +1,55 @@
+import {readFileSync} from 'node:fs';
+import {resolve} from 'node:path';
+import {glob} from 'glob';
+import {describe, expect, it} from 'vitest';
+
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+const STUB_MARKER = 'This page exceeds the maximum allowed size and cannot be displayed.';
+
+describe('OpenAPI max include size', () => {
+    it('should replace oversized pages with stub when limit is exceeded', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/openapi-include-size-exceeds');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: '--max-openapi-include-size 1K',
+        });
+
+        const files = await glob('**/*.md', {cwd: outputPath, nodir: true});
+        expect(files.length).toBeGreaterThan(0);
+
+        const stubbed = [];
+        const preserved = [];
+        for (const file of files) {
+            const content = readFileSync(resolve(outputPath, file), 'utf-8');
+            if (content.includes(STUB_MARKER)) {
+                stubbed.push(file);
+            } else {
+                preserved.push(file);
+            }
+        }
+
+        // Endpoint pages and main index exceed 1K and should be stubbed
+        expect(stubbed.length).toBeGreaterThan(0);
+    });
+
+    it('should preserve all content when pages are within limit', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/openapi-include-size-within');
+
+        await TestAdapter.testBuildPass(inputPath, outputPath, {
+            md2md: true,
+            md2html: false,
+            args: '--max-openapi-include-size 1K',
+        });
+
+        const files = await glob('**/*.md', {cwd: outputPath, nodir: true});
+        expect(files.length).toBeGreaterThan(0);
+
+        for (const file of files) {
+            const content = readFileSync(resolve(outputPath, file), 'utf-8');
+            expect(content).not.toContain(STUB_MARKER);
+        }
+    });
+});

package/mocks/crawler-manifest/config/input/.yfm

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

package/mocks/crawler-manifest/config/input/index.md

@@ -0,0 +1,3 @@
+# Index
+
+[External link](https://config.example.com)

package/mocks/crawler-manifest/config/input/toc.yaml

@@ -0,0 +1,4 @@
+title: Crawler manifest config test
+items:
+  - name: Index
+    href: index.md

package/mocks/crawler-manifest/no-links/input/index.md

@@ -0,0 +1,5 @@
+# Index
+
+Local link: [other page](./other.md).
+
+Absolute local link: [absolute](/docs/page.md).

package/mocks/crawler-manifest/no-links/input/toc.yaml

@@ -0,0 +1,4 @@
+title: No external links test
+items:
+  - name: Index
+    href: index.md

package/mocks/crawler-manifest/with-links/input/redirects.yaml

@@ -0,0 +1,5 @@
+files:
+  - from: /ru/old-page
+    to: https://external-redirect.example.com
+  - from: /ru/moved
+    to: /ru/index.md

package/mocks/crawler-manifest/with-links/input/ru/_includes/snippet.md

@@ -0,0 +1 @@
+This snippet contains an [included link](https://included.example.com).

package/mocks/crawler-manifest/with-links/input/ru/index.md

@@ -0,0 +1,35 @@
+# Index
+
+Inline link: [example](https://example.com).
+
+Http link: [example](http://http.example.com).
+
+Autolink: <https://autolink.example.com>.
+
+Plain URL: https://plain.example.com.
+
+Local link: [relative](./no-links.md).
+
+`[inline code link](https://inline-code.example.com)`
+
+```
+[block code link](https://block-code.example.com)
+```
+
+~~~
+[tilde code link](https://tilde-code.example.com)
+~~~
+
+```yaml
+url: https://fenced-lang.example.com
+```
+
+![image alt](https://image.example.com/logo.png)
+
+<!-- [hidden link](https://comment.example.com) -->
+
+<!--
+https://multiline-comment.example.com
+-->
+
+{% include [snippet](./_includes/snippet.md) %}

package/mocks/crawler-manifest/with-links/input/ru/leading.yaml

@@ -0,0 +1,5 @@
+blocks:
+  - type: card-with-image
+    title: Card title
+    description: |
+      Description with [external link](https://yaml.example.com) inside.

package/mocks/crawler-manifest/with-links/input/ru/no-links.md

@@ -0,0 +1,3 @@
+# No links
+
+This page has no external links, only text.

package/mocks/crawler-manifest/with-links/input/ru/references.md

@@ -0,0 +1,5 @@
+# References
+
+See [reference link][ref] for details.
+
+[ref]: https://reference.example.com

package/mocks/crawler-manifest/with-links/input/toc.yaml

@@ -0,0 +1,12 @@
+title: Crawler manifest test
+items:
+  - name: Index
+    href: ru/index.md
+  - name: No links
+    href: ru/no-links.md
+  - name: References
+    href: ru/references.md
+  - name: Leading
+    href: ru/leading.yaml
+  - name: External
+    href: https://toc.example.com

package/mocks/openapi-include-size-exceeds/input/openapi-spec.yaml

@@ -0,0 +1,190 @@
+openapi: 3.0.1
+info:
+  title: Large Test API
+  version: v1
+  description: This is a large API specification used for testing the max openapi include size limit.
+servers:
+  - url: http://localhost:8080
+    description: Generated server url
+paths:
+  /users:
+    get:
+      tags:
+        - user-controller
+      summary: Get all users
+      description: Returns a list of all users in the system with their details.
+      operationId: getAllUsers
+      parameters:
+        - name: page
+          in: query
+          required: false
+          description: Page number for pagination
+          schema:
+            type: integer
+        - name: limit
+          in: query
+          required: false
+          description: Number of items per page
+          schema:
+            type: integer
+        - name: sort
+          in: query
+          required: false
+          description: Sort field
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/User'
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    post:
+      tags:
+        - user-controller
+      summary: Create a new user
+      description: Creates a new user in the system.
+      operationId: createUser
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserCreate'
+      responses:
+        "201":
+          description: User created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /users/{id}:
+    get:
+      tags:
+        - user-controller
+      summary: Get user by ID
+      description: Returns a single user by their unique identifier.
+      operationId: getUserById
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The unique identifier of the user
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        "404":
+          description: User not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Unique identifier
+        name:
+          type: string
+          description: Full name of the user
+        email:
+          type: string
+          description: Email address
+        role:
+          type: string
+          description: User role in the system
+          enum: [admin, editor, viewer]
+        address:
+          $ref: '#/components/schemas/Address'
+        metadata:
+          $ref: '#/components/schemas/Metadata'
+    UserCreate:
+      type: object
+      required:
+        - name
+        - email
+      properties:
+        name:
+          type: string
+          description: Full name of the user
+        email:
+          type: string
+          description: Email address
+        role:
+          type: string
+          description: User role in the system
+          enum: [admin, editor, viewer]
+        address:
+          $ref: '#/components/schemas/Address'
+    Address:
+      type: object
+      properties:
+        street:
+          type: string
+          description: Street address
+        city:
+          type: string
+          description: City name
+        state:
+          type: string
+          description: State or province
+        zip:
+          type: string
+          description: Postal code
+        country:
+          type: string
+          description: Country name
+    Metadata:
+      type: object
+      properties:
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        updatedAt:
+          type: string
+          format: date-time
+          description: Last update timestamp
+        lastLogin:
+          type: string
+          format: date-time
+          description: Last login timestamp
+        loginCount:
+          type: integer
+          description: Total number of logins
+    Error:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: Error code
+        message:
+          type: string
+          description: Error message
+        details:
+          type: string
+          description: Detailed error information

package/mocks/openapi-include-size-exceeds/input/toc.yaml

@@ -0,0 +1,9 @@
+title: OpenAPI Size Limit Exceeds Test
+items:
+  - name: API
+    include:
+      path: api
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+      mode: link

package/mocks/openapi-include-size-within/input/openapi-spec.yaml

@@ -0,0 +1,16 @@
+openapi: 3.0.1
+info:
+  title: Small API
+  version: v1
+servers:
+  - url: http://localhost:8080
+paths:
+  /ping:
+    get:
+      tags:
+        - health
+      summary: Health check
+      operationId: ping
+      responses:
+        "200":
+          description: OK

package/mocks/openapi-include-size-within/input/toc.yaml

@@ -0,0 +1,9 @@
+title: OpenAPI Size Limit Within Test
+items:
+  - name: API
+    include:
+      path: api
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+      mode: link

package/package.json

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