@diplodoc/cli-tests 5.2.0 → 5.2.1

package/e2e/redirects-validation.spec.ts

@@ -0,0 +1,61 @@
+import {describe, expect, it} from 'vitest';
+import {TestAdapter, getTestPaths} from '../fixtures';
+
+describe('Redirects validation', () => {
+    it('should emit an error on an unparseable redirects.yaml', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/unparseable');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(expect.stringMatching(/redirects.yaml parsing error/));
+    });
+
+    it.skip('should emit a warning when supplied with a `redirects.yaml` that mentions file extensions', async () => {
+        const {inputPath, outputPath} = getTestPaths(
+            'mocks/redirects-validation/extensions-deprecation',
+        );
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(0);
+        expect(report.warns).toContainEqual(
+            expect.stringMatching(/Redirects with explicit extensions are deprecated./),
+        );
+    });
+
+    it('should emit an error when an invalid regular expression pattern is encountered', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/invalid-regex');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(
+                /Redirects configuration results in a non-valid regular expression/,
+            ),
+        );
+    });
+
+    it('should emit an error when a redirect is malformed', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/malformed-redirect');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(/One of the two parameters is missing/),
+        );
+    });
+
+    it('should emit an error when a redirect leads to the same path', async () => {
+        const {inputPath, outputPath} = getTestPaths('mocks/redirects-validation/same-path');
+
+        const report = await TestAdapter.build.run(inputPath, outputPath, ['-f', 'md']);
+
+        expect(report.code).toBe(1);
+        expect(report.errors).toContainEqual(
+            expect.stringMatching(/Parameters must be different/),
+        );
+    });
+});

package/mocks/redirects-validation/extensions-deprecation/input/redirects.yaml

@@ -0,0 +1,5 @@
+common:
+  - from: /foo.md
+    to: /bar.md
+  - from: /barbar.md
+    to: /baz.md

package/mocks/redirects-validation/extensions-deprecation/input/toc.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Blah
+    href: blah.md
+    

package/mocks/redirects-validation/invalid-regex/input/redirects.yaml

@@ -0,0 +1,3 @@
+common:
+  - from: /(foo.md
+    to: /bar.md

package/mocks/redirects-validation/invalid-regex/input/toc.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Blah
+    href: blah.md
+    

package/mocks/redirects-validation/malformed-redirect/input/redirects.yaml

@@ -0,0 +1,6 @@
+common:
+  - form: /foo.md
+    to: /bar.md
+  - match: /barbar.md
+    redirect: /baz.md
+  -

package/mocks/redirects-validation/malformed-redirect/input/toc.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Blah
+    href: blah.md
+    

package/mocks/redirects-validation/same-path/input/redirects.yaml

@@ -0,0 +1,3 @@
+common:
+  - from: /foo
+    to: /foo

package/mocks/redirects-validation/same-path/input/toc.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Blah
+    href: blah.md
+    

package/mocks/redirects-validation/unparseable/input/redirects.yaml

@@ -0,0 +1,11 @@
+common:
+  - from: /foo.md
+    to: /bar.md
+
+<<<<<<< HEAD
+
+  - from: /barbar.md
+    to: /baz.md
+
+=======
+>>>>>>> merge-branch

package/mocks/redirects-validation/unparseable/input/toc.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Blah
+    href: blah.md
+    

package/package.json

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