feat(v2): add option validation for remaining official plugins (#2970)

* feat(v2): add option validation lifecycle method * chore(v2): add dependencies * chore(v2): add yup dependency * feat(v2): add option validation for plugin-content-docs * chore(v2): add facebook copyright * refactor(v2): remove unused variable * chore(v2): add dependencies * chore(v2): add copyright * fix(v2): use strict for option validation * feat(v2): add option validation for plugin-content-pages * feat(v2): add schema for plugin-google-analytics and plugin-google-gtag * feat(v2): add option validation for plugin-sitemap * chore(v2): add dependency for yup * fix(v2): remove strict to allow normalization * refactor(v2): refactor validate method * feat(v2): modify existing tests * feat(v2): add tests for plugin normalization * style(v2): use a more descriptive filename for schema * feat(v2): add normalization tests * feat(v2): add more tests for option validation * refactor(v2): remove unused code * refactor(v2): remove unused code * refactor(v2): refactor methods and types * feat(v2): replace Yup with Joi * fix(v2): fix plugin-content-docs schema * feat(v2): modify tests for plugin-content-docs * fix(v2): fix a typo * refactor(v2): improve tests and refactor code * feat(v2): support both commonjs and ES modules * refactor(v2): refactor validateOption method * style(v2): fix eslint errors and typo in types * chore(v2): remove unused yup dependency * style(v2): standardize naming across official plugins * chore(v2): update test snapshots * chore(v2): remove obsolete snapshots * chore(v2): fix a typo and check test * feat(v2): add validation for new field * feat(v2): add test for new field
2025-05-13 00:57:53 +02:00 · 2020-06-26 21:14:59 +08:00 · 2020-06-26 21:14:59 +08:00 · 0f59cd1599
commit 0f59cd1599
parent 3213955e72
24 changed files with 444 additions and 169 deletions
--- a/packages/docusaurus-plugin-content-docs/src/tests/pluginOptionSchema.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/tests/pluginOptionSchema.test.ts
@ -0,0 +1,83 @@
+/**
+ * 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 {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
+
+export default function normalizePluginOptions(options) {
+  const {value, error} = PluginOptionSchema.validate(options, {
+    convert: false,
+  });
+  if (error) {
+    throw error;
+  } else {
+    return value;
+  }
+}
+
+describe('normalizeDocsPluginOptions', () => {
+  test('should return default options for undefined user options', async () => {
+    const {value} = await PluginOptionSchema.validate({});
+    expect(value).toEqual(DEFAULT_OPTIONS);
+  });
+
+  test('should accept correctly defined user options', async () => {
+    const userOptions = {
+      path: 'my-docs', // Path to data on filesystem, relative to site dir.
+      routeBasePath: 'my-docs', // URL Route.
+      homePageId: 'home', // Document id for docs home page.
+      include: ['**/*.{md,mdx}'], // Extensions to include.
+      sidebarPath: 'my-sidebar', // Path to sidebar configuration for showing a list of markdown pages.
+      docLayoutComponent: '@theme/DocPage',
+      docItemComponent: '@theme/DocItem',
+      remarkPlugins: [],
+      rehypePlugins: [],
+      showLastUpdateTime: true,
+      showLastUpdateAuthor: true,
+      admonitions: {},
+      excludeNextVersionDocs: true,
+    };
+
+    const {value} = await PluginOptionSchema.validate(userOptions);
+    expect(value).toEqual(userOptions);
+  });
+
+  test('should reject bad path inputs', () => {
+    expect(() => {
+      normalizePluginOptions({
+        path: 2,
+      });
+    }).toThrowErrorMatchingInlineSnapshot(`"\\"path\\" must be a string"`);
+  });
+
+  test('should reject bad include inputs', () => {
+    expect(() => {
+      normalizePluginOptions({
+        include: '**/*.{md,mdx}',
+      });
+    }).toThrowErrorMatchingInlineSnapshot(`"\\"include\\" must be an array"`);
+  });
+
+  test('should reject bad showLastUpdateTime inputs', () => {
+    expect(() => {
+      normalizePluginOptions({
+        showLastUpdateTime: 'true',
+      });
+    }).toThrowErrorMatchingInlineSnapshot(
+      `"\\"showLastUpdateTime\\" must be a boolean"`,
+    );
+  });
+
+  test('should reject bad remarkPlugins input', () => {
+    expect(() => {
+      normalizePluginOptions({
+        remarkPlugins: 'remark-math',
+      });
+    }).toThrowErrorMatchingInlineSnapshot(
+      `"\\"remarkPlugins\\" must be an array"`,
+    );
+  });
+});