@docusaurus/core 4.0.0-canary-6944 → 4.0.0-canary-6946

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 (4) hide show
  1. package/lib/server/configValidation.d.ts +1 -0
  2. package/lib/server/configValidation.js +7 -1
  3. package/lib/ssg/ssgParams.js +1 -1
  4. package/package.json +12 -12
package/lib/server/configValidation.d.ts CHANGED
@@ -12,5 +12,6 @@ export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
12
12
  export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'storage' | 'vcs' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
13
13
  export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig & {
14
14
  onBrokenMarkdownLinks: never;
15
+ ssrTemplate: never;
15
16
  }>;
16
17
  export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;
package/lib/server/configValidation.js CHANGED
@@ -222,6 +222,7 @@ const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
222
222
  .optional()
223
223
  .default(exports.DEFAULT_FUTURE_CONFIG);
224
224
  // TODO move to @docusaurus/utils-validation
225
+ // TODO Docusaurus v5: remove these never types for removed/renamed options
225
226
  exports.ConfigSchema = utils_validation_1.Joi.object({
226
227
  url: SiteUrlSchema.required(),
227
228
  baseUrl: BaseUrlSchema.required(),
@@ -272,7 +273,12 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
272
273
  'array.includes': '{#label} is invalid. A script must be a plain string (the src), or an object with at least a "src" property.',
273
274
  })
274
275
  .default(exports.DEFAULT_CONFIG.scripts),
275
- ssrTemplate: utils_validation_1.Joi.string(),
276
+ ssgTemplate: utils_validation_1.Joi.string(),
277
+ ssrTemplate: utils_validation_1.Joi.any()
278
+ .forbidden()
279
+ .messages({
280
+ 'any.unknown': `The Docusaurus config ${logger_1.default.code('siteConfig.ssrTemplate')} has been renamed to ${logger_1.default.code('siteConfig.ssgTemplate')}. Please rename it in your site config.`,
281
+ }),
276
282
  headTags: utils_validation_1.Joi.array()
277
283
  .items(utils_validation_1.Joi.object({
278
284
  tagName: utils_validation_1.Joi.string().required(),
package/lib/ssg/ssgParams.js CHANGED
@@ -22,7 +22,7 @@ async function createSSGParams({ props, serverBundlePath, clientManifestPath, })
22
22
  headTags: props.headTags,
23
23
  preBodyTags: props.preBodyTags,
24
24
  postBodyTags: props.postBodyTags,
25
- ssgTemplateContent: props.siteConfig.ssrTemplate ?? ssgTemplate_html_1.default,
25
+ ssgTemplateContent: props.siteConfig.ssgTemplate ?? ssgTemplate_html_1.default,
26
26
  noIndex: props.siteConfig.noIndex,
27
27
  DOCUSAURUS_VERSION: utils_1.DOCUSAURUS_VERSION,
28
28
  serverBundlePath,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@docusaurus/core",
3
3
  "description": "Easy to Maintain Open Source Documentation Websites",
4
- "version": "4.0.0-canary-6944",
4
+ "version": "4.0.0-canary-6946",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
7
7
  "access": "public"
@@ -27,15 +27,15 @@
27
27
  "url": "https://github.com/facebook/docusaurus/issues"
28
28
  },
29
29
  "dependencies": {
30
- "@docusaurus/babel": "4.0.0-canary-6944",
31
- "@docusaurus/bundler": "4.0.0-canary-6944",
32
- "@docusaurus/fs": "4.0.0-canary-6944",
33
- "@docusaurus/glob": "4.0.0-canary-6944",
34
- "@docusaurus/logger": "4.0.0-canary-6944",
35
- "@docusaurus/mdx-loader": "4.0.0-canary-6944",
36
- "@docusaurus/utils": "4.0.0-canary-6944",
37
- "@docusaurus/utils-common": "4.0.0-canary-6944",
38
- "@docusaurus/utils-validation": "4.0.0-canary-6944",
30
+ "@docusaurus/babel": "4.0.0-canary-6946",
31
+ "@docusaurus/bundler": "4.0.0-canary-6946",
32
+ "@docusaurus/fs": "4.0.0-canary-6946",
33
+ "@docusaurus/glob": "4.0.0-canary-6946",
34
+ "@docusaurus/logger": "4.0.0-canary-6946",
35
+ "@docusaurus/mdx-loader": "4.0.0-canary-6946",
36
+ "@docusaurus/utils": "4.0.0-canary-6946",
37
+ "@docusaurus/utils-common": "4.0.0-canary-6946",
38
+ "@docusaurus/utils-validation": "4.0.0-canary-6946",
39
39
  "@rspack/core": "^2.2.3",
40
40
  "@rspack/dev-server": "^2.2.1",
41
41
  "boxen": "^9.0.0",
@@ -68,8 +68,8 @@
68
68
  "webpack-merge": "^6.0.1"
69
69
  },
70
70
  "devDependencies": {
71
- "@docusaurus/module-type-aliases": "4.0.0-canary-6944",
72
- "@docusaurus/types": "4.0.0-canary-6944",
71
+ "@docusaurus/module-type-aliases": "4.0.0-canary-6946",
72
+ "@docusaurus/types": "4.0.0-canary-6946",
73
73
  "@total-typescript/shoehorn": "^0.1.2",
74
74
  "@types/escape-html": "^1.0.4",
75
75
  "@types/history": "^4.7.11",