@docusaurus/plugin-content-docs 0.0.0-5039 → 0.0.0-5042

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/lib/cli.d.ts +1 -1
  2. package/lib/client/index.js +1 -2
  3. package/package.json +9 -9
  4. package/src/cli.ts +2 -2
  5. package/src/client/index.ts +3 -2
  6. package/src/index.ts +1 -1
  7. package/src/options.ts +1 -1
  8. package/src/versions/files.ts +1 -1
package/lib/cli.d.ts CHANGED
@@ -6,4 +6,4 @@
6
6
  */
7
7
  import type { PluginOptions } from '@docusaurus/plugin-content-docs';
8
8
  import type { LoadContext } from '@docusaurus/types';
9
- export declare function cliDocsVersionCommand(version: string, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;
9
+ export declare function cliDocsVersionCommand(version: unknown, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;
package/lib/client/index.js CHANGED
@@ -12,8 +12,7 @@ import { getActivePlugin, getLatestVersion, getActiveVersion, getActiveDocContex
12
12
  const StableEmptyObject = {};
13
13
  // In blog-only mode, docs hooks are still used by the theme. We need a fail-
14
14
  // safe fallback when the docs plugin is not in use
15
- export const useAllDocsData = () => useAllPluginInstancesData('docusaurus-plugin-content-docs') ??
16
- StableEmptyObject;
15
+ export const useAllDocsData = () => useAllPluginInstancesData('docusaurus-plugin-content-docs') ?? StableEmptyObject;
17
16
  export const useDocsData = (pluginId) => usePluginData('docusaurus-plugin-content-docs', pluginId, {
18
17
  failfast: true,
19
18
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/plugin-content-docs",
3
- "version": "0.0.0-5039",
3
+ "version": "0.0.0-5042",
4
4
  "description": "Docs plugin for Docusaurus.",
5
5
  "main": "lib/index.js",
6
6
  "sideEffects": false,
@@ -25,11 +25,11 @@
25
25
  },
26
26
  "license": "MIT",
27
27
  "dependencies": {
28
- "@docusaurus/core": "0.0.0-5039",
29
- "@docusaurus/logger": "0.0.0-5039",
30
- "@docusaurus/mdx-loader": "0.0.0-5039",
31
- "@docusaurus/utils": "0.0.0-5039",
32
- "@docusaurus/utils-validation": "0.0.0-5039",
28
+ "@docusaurus/core": "0.0.0-5042",
29
+ "@docusaurus/logger": "0.0.0-5042",
30
+ "@docusaurus/mdx-loader": "0.0.0-5042",
31
+ "@docusaurus/utils": "0.0.0-5042",
32
+ "@docusaurus/utils-validation": "0.0.0-5042",
33
33
  "combine-promises": "^1.1.0",
34
34
  "fs-extra": "^10.1.0",
35
35
  "import-fresh": "^3.3.0",
@@ -41,8 +41,8 @@
41
41
  "webpack": "^5.72.1"
42
42
  },
43
43
  "devDependencies": {
44
- "@docusaurus/module-type-aliases": "0.0.0-5039",
45
- "@docusaurus/types": "0.0.0-5039",
44
+ "@docusaurus/module-type-aliases": "0.0.0-5042",
45
+ "@docusaurus/types": "0.0.0-5042",
46
46
  "@types/js-yaml": "^4.0.5",
47
47
  "@types/picomatch": "^2.3.0",
48
48
  "commander": "^5.1.0",
@@ -58,5 +58,5 @@
58
58
  "engines": {
59
59
  "node": ">=14"
60
60
  },
61
- "gitHead": "a38798a05ef1ae945cadb0b6624b27b48baeafc3"
61
+ "gitHead": "af5fa0b311db8cf3934d437d74435966eb456c38"
62
62
  }
package/src/cli.ts CHANGED
@@ -53,7 +53,7 @@ async function createVersionedSidebarFile({
53
53
 
54
54
  // Tests depend on non-default export for mocking.
55
55
  export async function cliDocsVersionCommand(
56
- version: string,
56
+ version: unknown,
57
57
  {id: pluginId, path: docsPath, sidebarPath}: PluginOptions,
58
58
  {siteDir, i18n}: LoadContext,
59
59
  ): Promise<void> {
@@ -70,7 +70,7 @@ export async function cliDocsVersionCommand(
70
70
  }
71
71
 
72
72
  // Load existing versions.
73
- let versions = [];
73
+ let versions: string[] = [];
74
74
  const versionsJSONFile = getVersionsFilePath(siteDir, pluginId);
75
75
  if (await fs.pathExists(versionsJSONFile)) {
76
76
  versions = await fs.readJSON(versionsJSONFile);
package/src/client/index.ts CHANGED
@@ -34,8 +34,9 @@ const StableEmptyObject = {};
34
34
  // In blog-only mode, docs hooks are still used by the theme. We need a fail-
35
35
  // safe fallback when the docs plugin is not in use
36
36
  export const useAllDocsData = (): {[pluginId: string]: GlobalPluginData} =>
37
- useAllPluginInstancesData('docusaurus-plugin-content-docs') ??
38
- StableEmptyObject;
37
+ (useAllPluginInstancesData('docusaurus-plugin-content-docs') as {
38
+ [pluginId: string]: GlobalPluginData;
39
+ }) ?? StableEmptyObject;
39
40
 
40
41
  export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
41
42
  usePluginData('docusaurus-plugin-content-docs', pluginId, {
package/src/index.ts CHANGED
@@ -100,7 +100,7 @@ export default async function pluginContentDocs(
100
100
  .command(command)
101
101
  .arguments('<version>')
102
102
  .description(commandDescription)
103
- .action((version) => {
103
+ .action((version: unknown) => {
104
104
  cliDocsVersionCommand(version, options, context);
105
105
  });
106
106
  },
package/src/options.ts CHANGED
@@ -98,7 +98,7 @@ const OptionsSchema = Joi.object<PluginOptions>({
98
98
  Joi.function(),
99
99
  // Convert boolean values to functions
100
100
  Joi.alternatives().conditional(Joi.boolean(), {
101
- then: Joi.custom((val) =>
101
+ then: Joi.custom((val: boolean) =>
102
102
  val ? DefaultNumberPrefixParser : DisabledNumberPrefixParser,
103
103
  ),
104
104
  }),
package/src/versions/files.ts CHANGED
@@ -95,7 +95,7 @@ async function readVersionsFile(
95
95
  ): Promise<string[] | null> {
96
96
  const versionsFilePath = getVersionsFilePath(siteDir, pluginId);
97
97
  if (await fs.pathExists(versionsFilePath)) {
98
- const content = await fs.readJSON(versionsFilePath);
98
+ const content: unknown = await fs.readJSON(versionsFilePath);
99
99
  validateVersionNames(content);
100
100
  return content;
101
101
  }