fix(types): fix type of PluginModule (#10420)

facebook · Aug 19, 2024 · dccf751 · dccf751
1 parent ac9deab
commit dccf751
Show file tree

Hide file tree

Showing 2 changed files with 339 additions and 259 deletions.
diff --git a/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap b/packages/docusaurus/src/server/__tests__/__snapshots__/configValidation.test.ts.snap
@@ -1,6 +1,30 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`normalizeConfig should throw error if plugins is not a string and it's not an array #1 for the input of: [123] 1`] = `
+exports[`normalizeConfig throws error for required fields 1`] = `
+""baseUrl" is required
+"title" is required
+"url" is required
+"themes" must be an array
+"presets" must be an array
+"scripts" must be an array
+"stylesheets" must be an array
+These field(s) ("invalidField",) are not recognized in docusaurus.config.js.
+If you still want these fields to be in your configuration, put them in the "customFields" field.
+See https://docusaurus.io/docs/api/docusaurus-config/#customfields"
+`;
+
+exports[`normalizeConfig throws error for unknown field 1`] = `
+"These field(s) ("invalid",) are not recognized in docusaurus.config.js.
+If you still want these fields to be in your configuration, put them in the "customFields" field.
+See https://docusaurus.io/docs/api/docusaurus-config/#customfields"
+`;
+
+exports[`onBrokenLinks throws for "error" reporting severity 1`] = `
+""onBrokenLinks" must be one of [ignore, log, warn, throw]
+"
+`;
+
+exports[`plugins should throw error if plugins is not a string and it's not an array #1 for the input of: [123] 1`] = `
 " => Bad Docusaurus plugin value plugins[0].
 Example valid plugin config:
 {
@@ -16,7 +40,7 @@ Example valid plugin config:
 "
 `;
 
-exports[`normalizeConfig should throw error if plugins is not an array of [string, object][] #1 for the input of: [[Array]] 1`] = `
+exports[`plugins should throw error if plugins is not an array of [string, object][] #1 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus plugin value plugins[0].
 Example valid plugin config:
 {
@@ -32,7 +56,7 @@ Example valid plugin config:
 "
 `;
 
-exports[`normalizeConfig should throw error if plugins is not an array of [string, object][] #2 for the input of: [[Array]] 1`] = `
+exports[`plugins should throw error if plugins is not an array of [string, object][] #2 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus plugin value plugins[0].
 Example valid plugin config:
 {
@@ -48,7 +72,7 @@ Example valid plugin config:
 "
 `;
 
-exports[`normalizeConfig should throw error if plugins is not an array of [string, object][] #3 for the input of: [[Array]] 1`] = `
+exports[`plugins should throw error if plugins is not an array of [string, object][] #3 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus plugin value plugins[0].
 Example valid plugin config:
 {
@@ -64,12 +88,12 @@ Example valid plugin config:
 "
 `;
 
-exports[`normalizeConfig should throw error if plugins is not array for the input of: {} 1`] = `
+exports[`plugins should throw error if plugins is not array for the input of: {} 1`] = `
 ""plugins" must be an array
 "
 `;
 
-exports[`normalizeConfig should throw error if themes is not a string and it's not an array #1 for the input of: [123] 1`] = `
+exports[`themes should throw error if themes is not a string and it's not an array #1 for the input of: [123] 1`] = `
 " => Bad Docusaurus theme value themes[0].
 Example valid theme config:
 {
@@ -85,7 +109,7 @@ Example valid theme config:
 "
 `;
 
-exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #1 for the input of: [[Array]] 1`] = `
+exports[`themes should throw error if themes is not an array of [string, object][] #1 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus theme value themes[0].
 Example valid theme config:
 {
@@ -101,7 +125,7 @@ Example valid theme config:
 "
 `;
 
-exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #2 for the input of: [[Array]] 1`] = `
+exports[`themes should throw error if themes is not an array of [string, object][] #2 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus theme value themes[0].
 Example valid theme config:
 {
@@ -117,7 +141,7 @@ Example valid theme config:
 "
 `;
 
-exports[`normalizeConfig should throw error if themes is not an array of [string, object][] #3 for the input of: [[Array]] 1`] = `
+exports[`themes should throw error if themes is not an array of [string, object][] #3 for the input of: [[Array]] 1`] = `
 " => Bad Docusaurus theme value themes[0].
 Example valid theme config:
 {
@@ -133,31 +157,7 @@ Example valid theme config:
 "
 `;
 
-exports[`normalizeConfig should throw error if themes is not array for the input of: {} 1`] = `
+exports[`themes should throw error if themes is not array for the input of: {} 1`] = `
 ""themes" must be an array
 "
 `;
-
-exports[`normalizeConfig throws error for required fields 1`] = `
-""baseUrl" is required
-"title" is required
-"url" is required
-"themes" must be an array
-"presets" must be an array
-"scripts" must be an array
-"stylesheets" must be an array
-These field(s) ("invalidField",) are not recognized in docusaurus.config.js.
-If you still want these fields to be in your configuration, put them in the "customFields" field.
-See https://docusaurus.io/docs/api/docusaurus-config/#customfields"
-`;
-
-exports[`normalizeConfig throws error for unknown field 1`] = `
-"These field(s) ("invalid",) are not recognized in docusaurus.config.js.
-If you still want these fields to be in your configuration, put them in the "customFields" field.
-See https://docusaurus.io/docs/api/docusaurus-config/#customfields"
-`;
-
-exports[`normalizeConfig throws for "error" reporting severity 1`] = `
-""onBrokenLinks" must be one of [ignore, log, warn, throw]
-"
-`;