@docusaurus/utils-validation 2.0.0-beta.fc64c12e4 → 2.0.0

package/src/__tests__/validationSchemas.test.ts

@@ -1,131 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import Joi from '../Joi';
-
-import {
-  AdmonitionsSchema,
-  RehypePluginsSchema,
-  RemarkPluginsSchema,
-  PluginIdSchema,
-  URISchema,
-} from '../validationSchemas';
-
-function createTestHelpers({
-  schema,
-  defaultValue,
-}: {
-  schema: Joi.Schema;
-  defaultValue?: unknown;
-}) {
-  function testOK(value: unknown) {
-    expect(Joi.attempt(value, schema)).toEqual(value ?? defaultValue);
-  }
-
-  function testFail(value: unknown) {
-    expect(() => Joi.attempt(value, schema)).toThrowErrorMatchingSnapshot(
-      `for value=${JSON.stringify(value)}`,
-    );
-  }
-
-  return {testOK, testFail};
-}
-
-function testMarkdownPluginSchemas(schema: Joi.Schema) {
-  const {testOK, testFail} = createTestHelpers({
-    schema,
-    defaultValue: [],
-  });
-
-  testOK(undefined);
-  testOK([function () {}]);
-  testOK([[function () {}, {attr: 'val'}]]);
-  testOK([
-    [function () {}, {attr: 'val'}],
-    function () {},
-    [function () {}, {attr: 'val'}],
-  ]);
-
-  testFail(null);
-  testFail(false);
-  testFail(3);
-  testFail([null]);
-  testFail([false]);
-  testFail([3]);
-  testFail([[]]);
-  testFail([[function () {}, undefined]]);
-  testFail([[function () {}, true]]);
-}
-
-describe('validation schemas', () => {
-  test('PluginIdSchema', () => {
-    const {testOK, testFail} = createTestHelpers({
-      schema: PluginIdSchema,
-      defaultValue: 'default',
-    });
-
-    testOK(undefined);
-    testOK('docs');
-    testOK('default');
-    testOK('plugin-id_with-simple-special-chars');
-
-    testFail('/docs');
-    testFail('docs/');
-    testFail('do/cs');
-    testFail('do cs');
-    testFail(null);
-    testFail(3);
-    testFail(true);
-    testFail([]);
-  });
-
-  test('AdmonitionsSchema', () => {
-    const {testOK, testFail} = createTestHelpers({
-      schema: AdmonitionsSchema,
-      defaultValue: {},
-    });
-
-    testOK(undefined);
-    testOK({});
-    testOK({attr: 'val'});
-
-    testFail(null);
-    testFail(3);
-    testFail(true);
-    testFail([]);
-  });
-
-  test('RemarkPluginsSchema', () => {
-    testMarkdownPluginSchemas(RemarkPluginsSchema);
-  });
-
-  test('RehypePluginsSchema', () => {
-    testMarkdownPluginSchemas(RehypePluginsSchema);
-  });
-
-  test('URISchema', () => {
-    const {testFail, testOK} = createTestHelpers({schema: URISchema});
-
-    const validURL = 'https://docusaurus.io';
-    const doubleHash = 'https://docusaurus.io#github#/:';
-    const invalidURL = 'spaces are invalid in a URL';
-    const relativeURL = 'relativeURL';
-    const relativeURLWithParent = '../relativeURLWithParent';
-    const urlFromIssue = 'https://riot.im/app/#/room/#ligo-public:matrix.org';
-    testOK(validURL);
-    testOK(doubleHash);
-    testFail(invalidURL);
-    testOK(relativeURL);
-    testOK(relativeURLWithParent);
-    testOK(urlFromIssue);
-
-    const protocolRelativeUrl1 = '//docusaurus.io/path';
-    const protocolRelativeUrl2 = '//docusaurus.io/docs/doc1#hash';
-    testOK(protocolRelativeUrl1);
-    testOK(protocolRelativeUrl2);
-  });
-});

package/src/__tests__/validationUtils.test.ts

@@ -1,64 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import Joi from '../Joi';
-import {JoiFrontMatter, validateFrontMatter} from '../validationUtils';
-
-describe('validateFrontMatter', () => {
-  test('should accept good values', () => {
-    const schema = Joi.object<{test: string}>({
-      test: Joi.string(),
-    });
-    const frontMatter = {
-      test: 'hello',
-    };
-    expect(validateFrontMatter(frontMatter, schema)).toEqual(frontMatter);
-  });
-
-  test('should reject bad values', () => {
-    const consoleError = jest.spyOn(console, 'error').mockImplementation();
-    const schema = Joi.object<{test: string}>({
-      test: Joi.string(),
-    });
-    const frontMatter = {
-      test: true,
-    };
-    expect(() =>
-      validateFrontMatter(frontMatter, schema),
-    ).toThrowErrorMatchingInlineSnapshot(`"\\"test\\" must be a string"`);
-    expect(consoleError).toHaveBeenCalledWith(
-      expect.stringContaining('The following frontmatter'),
-    );
-  });
-
-  // Fix Yaml trying to convert strings to numbers automatically
-  // We only want to deal with a single type in the final frontmatter (not string | number)
-  test('should convert number values to string when string schema', () => {
-    const schema = Joi.object<{test: string}>({
-      test: JoiFrontMatter.string(),
-    });
-    const frontMatter = {
-      test: 42,
-    };
-    expect(validateFrontMatter(frontMatter, schema)).toEqual({test: '42'});
-  });
-
-  // Helps to fix Yaml trying to convert strings to dates automatically
-  // We only want to deal with a single type in the final frontmatter (not string | Date)
-  test('should convert date values when string schema', () => {
-    const schema = Joi.object<{test: string}>({
-      test: JoiFrontMatter.string(),
-    });
-    const date = new Date();
-    const frontMatter = {
-      test: date,
-    };
-    expect(validateFrontMatter(frontMatter, schema)).toEqual({
-      test: date.toString(),
-    });
-  });
-});

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "rootDir": "src",
-    "outDir": "lib"
-  }
-}