@diplodoc/cli-tests 5.32.1 → 5.33.0

package/e2e/__snapshots__/init.test.ts.snap

@@ -0,0 +1,283 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm > filelist 1`] = `
+"[
+  ".yfm",
+  "en/index.md",
+  "en/toc.yaml",
+  "ru/index.md",
+  "ru/toc.yaml"
+]"
+`;
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm 1`] = `
+"allowHtml: true
+lang: en
+langs: ['ru', 'en']"
+`;
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm 3`] = `
+"title: My Docs
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm 4`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > --default-lang sets lang field in .yfm 5`] = `
+"title: My Docs
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files > filelist 1`] = `
+"[
+  ".yfm",
+  "en/index.md",
+  "en/toc.yaml",
+  "ru/index.md",
+  "ru/toc.yaml"
+]"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files 1`] = `
+"allowHtml: true
+lang: ru
+langs: ['ru', 'en']"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files 3`] = `
+"title: My Docs
+href: index.md
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files 4`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > --no-header removes navigation from all toc.yaml files 5`] = `
+"title: My Docs
+href: index.md
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — multi-lang > creates project structure > filelist 1`] = `
+"[
+  ".yfm",
+  "en/index.md",
+  "en/toc.yaml",
+  "ru/index.md",
+  "ru/toc.yaml"
+]"
+`;
+
+exports[`yfm init — multi-lang > creates project structure 1`] = `
+"allowHtml: true
+lang: ru
+langs: ['ru', 'en']"
+`;
+
+exports[`yfm init — multi-lang > creates project structure 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > creates project structure 3`] = `
+"title: My Docs
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — multi-lang > creates project structure 4`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — multi-lang > creates project structure 5`] = `
+"title: My Docs
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — single-lang > --no-header removes navigation block > filelist 1`] = `
+"[
+  ".yfm",
+  "index.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`yfm init — single-lang > --no-header removes navigation block 1`] = `"lang: en"`;
+
+exports[`yfm init — single-lang > --no-header removes navigation block 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — single-lang > --no-header removes navigation block 3`] = `
+"title: My Docs
+href: index.md
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — single-lang > creates project structure > filelist 1`] = `
+"[
+  ".yfm",
+  "index.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`yfm init — single-lang > creates project structure 1`] = `"lang: en"`;
+
+exports[`yfm init — single-lang > creates project structure 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — single-lang > creates project structure 3`] = `
+"title: My Docs
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;
+
+exports[`yfm init — single-lang > derives project name from output directory basename > filelist 1`] = `
+"[
+  ".yfm",
+  "index.md",
+  "toc.yaml"
+]"
+`;
+
+exports[`yfm init — single-lang > derives project name from output directory basename 1`] = `"lang: en"`;
+
+exports[`yfm init — single-lang > derives project name from output directory basename 2`] = `
+"# Welcome
+
+This is your documentation project created with [Diplodoc](https://diplodoc.com).
+
+## Getting started
+
+Edit this file or add new pages and update \`toc.yaml\`.
+"
+`;
+
+exports[`yfm init — single-lang > derives project name from output directory basename 3`] = `
+"title: my-project
+href: index.md
+navigation:
+  header:
+    rightItems:
+      - type: controls
+items:
+  - name: Overview
+    href: index.md
+"
+`;

package/e2e/init.test.ts

@@ -0,0 +1,105 @@
+import {mkdtemp, rm} from 'node:fs/promises';
+import {tmpdir} from 'node:os';
+import {join} from 'node:path';
+import {afterEach, beforeEach, describe, expect, it} from 'vitest';
+
+import {TestAdapter, compareDirectories} from '../fixtures';
+
+function run(args: string[]) {
+    return TestAdapter.runner.runYfmDocs(['init', ...args]);
+}
+
+let tmpDir: string;
+
+beforeEach(async () => {
+    tmpDir = await mkdtemp(join(tmpdir(), 'yfm-init-'));
+});
+
+afterEach(async () => {
+    await rm(tmpDir, {recursive: true, force: true});
+});
+
+describe('yfm init — single-lang', () => {
+    it('creates project structure', async () => {
+        const out = join(tmpDir, 'proj');
+        const report = await run(['--output', out, '--name', 'My Docs', '--skip-interactive']);
+
+        expect(report.code).toBe(0);
+        await compareDirectories(out);
+    });
+
+    it('derives project name from output directory basename', async () => {
+        const out = join(tmpDir, 'my-project');
+        await run(['--output', out]);
+
+        await compareDirectories(out);
+    });
+
+    it('--no-header removes navigation block', async () => {
+        const out = join(tmpDir, 'proj');
+        await run(['--output', out, '--name', 'My Docs', '--no-header', '--skip-interactive']);
+
+        await compareDirectories(out);
+    });
+});
+
+describe('yfm init — multi-lang', () => {
+    it('creates project structure', async () => {
+        const out = join(tmpDir, 'proj');
+        const report = await run([
+            '--output',
+            out,
+            '--langs',
+            'ru,en',
+            '--name',
+            'My Docs',
+            '--skip-interactive',
+        ]);
+
+        expect(report.code).toBe(0);
+        await compareDirectories(out);
+    });
+
+    it('--default-lang sets lang field in .yfm', async () => {
+        const out = join(tmpDir, 'proj');
+        await run([
+            '--output',
+            out,
+            '--langs',
+            'ru,en',
+            '--default-lang',
+            'en',
+            '--name',
+            'My Docs',
+            '--skip-interactive',
+        ]);
+
+        await compareDirectories(out);
+    });
+
+    it('--no-header removes navigation from all toc.yaml files', async () => {
+        const out = join(tmpDir, 'proj');
+        await run([
+            '--output',
+            out,
+            '--langs',
+            'ru,en',
+            '--no-header',
+            '--name',
+            'My Docs',
+            '--skip-interactive',
+        ]);
+
+        await compareDirectories(out);
+    });
+});
+
+describe('yfm init — errors', () => {
+    it('fails with non-zero exit code if output directory is not empty', async () => {
+        const out = join(tmpDir, 'proj');
+        await run(['--output', out]);
+
+        const report = await run(['--output', out]);
+        expect(report.code).toBeGreaterThan(0);
+    });
+});

package/package.json

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