@docusaurus/core 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

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 (91) hide show
  1. package/bin/beforeCli.js +125 -0
  2. package/bin/docusaurus.js +36 -105
  3. package/lib/.tsbuildinfo +1 -1
  4. package/lib/babel/preset.js +1 -1
  5. package/lib/choosePort.js +10 -11
  6. package/lib/client/.tsbuildinfo +1 -1
  7. package/lib/client/App.js +8 -22
  8. package/lib/client/PendingNavigation.d.ts +24 -1
  9. package/lib/client/PendingNavigation.js +1 -1
  10. package/lib/client/baseUrlIssueBanner/BaseUrlIssueBanner.js +1 -0
  11. package/lib/client/docusaurus.js +0 -1
  12. package/lib/client/exports/BrowserOnly.js +5 -3
  13. package/lib/client/exports/Interpolate.js +4 -0
  14. package/lib/client/exports/Link.js +11 -11
  15. package/lib/client/exports/Translate.d.ts +2 -2
  16. package/lib/client/exports/Translate.js +13 -9
  17. package/lib/client/exports/browserContext.d.ts +11 -0
  18. package/lib/client/exports/browserContext.js +21 -0
  19. package/lib/client/exports/constants.js +1 -11
  20. package/lib/client/exports/{context.d.ts → docusaurusContext.d.ts} +5 -3
  21. package/lib/client/exports/docusaurusContext.js +25 -0
  22. package/lib/client/exports/useBaseUrl.js +1 -1
  23. package/lib/client/exports/useDocusaurusContext.js +2 -7
  24. package/lib/client/exports/useGlobalData.js +1 -5
  25. package/lib/client/exports/{context.js → useIsBrowser.d.ts} +1 -2
  26. package/lib/client/exports/useIsBrowser.js +11 -0
  27. package/lib/client/normalizeLocation.d.ts +1 -3
  28. package/lib/client/prefetch.js +0 -1
  29. package/lib/client/serverEntry.js +11 -27
  30. package/lib/commands/build.js +26 -23
  31. package/lib/commands/clear.js +2 -2
  32. package/lib/commands/commandUtils.js +2 -2
  33. package/lib/commands/deploy.js +24 -14
  34. package/lib/commands/external.js +4 -4
  35. package/lib/commands/serve.js +13 -13
  36. package/lib/commands/start.js +74 -72
  37. package/lib/commands/swizzle.js +33 -33
  38. package/lib/commands/writeHeadingIds.d.ts +8 -5
  39. package/lib/commands/writeHeadingIds.js +32 -31
  40. package/lib/commands/writeTranslations.js +25 -11
  41. package/lib/constants.d.ts +1 -0
  42. package/lib/constants.js +4 -1
  43. package/lib/server/brokenLinks.js +13 -13
  44. package/lib/server/config.js +4 -4
  45. package/lib/server/configValidation.js +4 -3
  46. package/lib/server/duplicateRoutes.js +2 -2
  47. package/lib/server/html-tags/htmlTags.js +5 -5
  48. package/lib/server/html-tags/index.d.ts +2 -2
  49. package/lib/server/html-tags/index.js +3 -3
  50. package/lib/server/i18n.js +4 -4
  51. package/lib/server/index.js +99 -62
  52. package/lib/server/loadSetup.js +3 -3
  53. package/lib/server/plugins/applyRouteTrailingSlash.d.ts +2 -1
  54. package/lib/server/plugins/applyRouteTrailingSlash.js +3 -3
  55. package/lib/server/plugins/index.d.ts +3 -4
  56. package/lib/server/plugins/index.js +41 -27
  57. package/lib/server/plugins/init.d.ts +2 -6
  58. package/lib/server/plugins/init.js +7 -10
  59. package/lib/server/plugins/pluginIds.d.ts +2 -2
  60. package/lib/server/plugins/pluginIds.js +2 -2
  61. package/lib/server/presets/index.js +4 -7
  62. package/lib/server/routes.js +41 -23
  63. package/lib/server/themes/alias.d.ts +3 -2
  64. package/lib/server/themes/alias.js +24 -12
  65. package/lib/server/themes/index.d.ts +6 -2
  66. package/lib/server/themes/index.js +19 -9
  67. package/lib/server/translations/translations.d.ts +4 -5
  68. package/lib/server/translations/translations.js +9 -9
  69. package/lib/server/translations/translationsExtractor.d.ts +2 -3
  70. package/lib/server/translations/translationsExtractor.js +58 -47
  71. package/lib/server/utils.d.ts +8 -2
  72. package/lib/server/utils.js +8 -10
  73. package/lib/server/versions/__fixtures__/dummy-plugin.d.ts +0 -0
  74. package/lib/server/versions/__tests/index.test.js +5 -5
  75. package/lib/server/versions/index.js +6 -6
  76. package/lib/webpack/base.js +28 -19
  77. package/lib/webpack/client.js +8 -17
  78. package/lib/webpack/plugins/CleanWebpackPlugin.js +2 -5
  79. package/lib/webpack/plugins/LogPlugin.js +3 -4
  80. package/lib/webpack/plugins/WaitPlugin.js +4 -4
  81. package/lib/webpack/react-dev-utils-webpack5/evalSourceMapMiddleware.d.ts +2 -0
  82. package/lib/webpack/react-dev-utils-webpack5/formatWebpackMessages.d.ts +5 -0
  83. package/lib/webpack/react-dev-utils-webpack5/formatWebpackMessages.js +1 -1
  84. package/lib/webpack/react-dev-utils-webpack5/webpackHotDevClient.d.ts +1 -0
  85. package/lib/webpack/server.js +11 -7
  86. package/lib/webpack/sharedModuleAliases.js +1 -1
  87. package/lib/webpack/utils.d.ts +2 -1
  88. package/lib/webpack/utils.js +28 -25
  89. package/package.json +45 -39
  90. package/tsconfig.client.json +1 -2
  91. package/tsconfig.json +5 -4
@@ -8,13 +8,12 @@ const tslib_1 = require("tslib");
8
8
  * This source code is licensed under the MIT license found in the
9
9
  * LICENSE file in the root directory of this source tree.
10
10
  */
11
- const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
12
- const traverse_1 = tslib_1.__importDefault(require("@babel/traverse"));
13
- const generator_1 = tslib_1.__importDefault(require("@babel/generator"));
14
- const chalk_1 = tslib_1.__importDefault(require("chalk"));
11
+ const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
12
+ const traverse_1 = (0, tslib_1.__importDefault)(require("@babel/traverse"));
13
+ const generator_1 = (0, tslib_1.__importDefault)(require("@babel/generator"));
14
+ const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
15
15
  const core_1 = require("@babel/core");
16
- const lodash_1 = require("lodash");
17
- const path_1 = tslib_1.__importDefault(require("path"));
16
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
18
17
  const constants_1 = require("../../constants");
19
18
  const utils_1 = require("../utils");
20
19
  // We only support extracting source code translations from these kind of files
@@ -48,7 +47,7 @@ function getPluginSourceCodeFilePaths(plugin) {
48
47
  return codePaths;
49
48
  }
50
49
  async function globSourceCodeFilePaths(dirPaths) {
51
- const filePaths = await utils_1.safeGlobby(dirPaths);
50
+ const filePaths = await (0, utils_1.safeGlobby)(dirPaths);
52
51
  return filePaths.filter(isTranslatableSourceCodePath);
53
52
  }
54
53
  exports.globSourceCodeFilePaths = globSourceCodeFilePaths;
@@ -57,11 +56,11 @@ async function getSourceCodeFilePaths(siteDir, plugins) {
57
56
  // The getPathsToWatch() generally returns the js/jsx/ts/tsx/md/mdx file paths
58
57
  // We can use this method as well to know which folders we should try to extract translations from
59
58
  // Hacky/implicit, but do we want to introduce a new lifecycle method for that???
60
- const pluginsPaths = lodash_1.flatten(plugins.map(getPluginSourceCodeFilePaths));
59
+ const pluginsPaths = plugins.flatMap(getPluginSourceCodeFilePaths);
61
60
  const allPaths = [...sitePaths, ...pluginsPaths];
62
61
  return globSourceCodeFilePaths(allPaths);
63
62
  }
64
- async function extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions) {
63
+ async function extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions, extraSourceCodeFilePaths = []) {
65
64
  // Should we warn here if the same translation "key" is found in multiple source code files?
66
65
  function toTranslationFileContent(sourceCodeFileTranslations) {
67
66
  return sourceCodeFileTranslations.reduce((acc, item) => {
@@ -69,7 +68,11 @@ async function extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions)
69
68
  }, {});
70
69
  }
71
70
  const sourceCodeFilePaths = await getSourceCodeFilePaths(siteDir, plugins);
72
- const sourceCodeFilesTranslations = await extractAllSourceCodeFileTranslations(sourceCodeFilePaths, babelOptions);
71
+ const allSourceCodeFilePaths = [
72
+ ...sourceCodeFilePaths,
73
+ ...extraSourceCodeFilePaths,
74
+ ];
75
+ const sourceCodeFilesTranslations = await extractAllSourceCodeFileTranslations(allSourceCodeFilePaths, babelOptions);
73
76
  logSourceCodeFileTranslationsWarnings(sourceCodeFilesTranslations);
74
77
  return toTranslationFileContent(sourceCodeFilesTranslations);
75
78
  }
@@ -82,23 +85,26 @@ function logSourceCodeFileTranslationsWarnings(sourceCodeFilesTranslations) {
82
85
  });
83
86
  }
84
87
  async function extractAllSourceCodeFileTranslations(sourceCodeFilePaths, babelOptions) {
85
- return lodash_1.flatten(await Promise.all(sourceCodeFilePaths.map((sourceFilePath) => extractSourceCodeFileTranslations(sourceFilePath, babelOptions))));
88
+ return Promise.all(sourceCodeFilePaths.flatMap((sourceFilePath) => extractSourceCodeFileTranslations(sourceFilePath, babelOptions)));
86
89
  }
87
90
  exports.extractAllSourceCodeFileTranslations = extractAllSourceCodeFileTranslations;
88
91
  async function extractSourceCodeFileTranslations(sourceCodeFilePath, babelOptions) {
89
92
  try {
90
93
  const code = await fs_extra_1.default.readFile(sourceCodeFilePath, 'utf8');
91
- const ast = core_1.parse(code, {
94
+ const ast = (0, core_1.parse)(code, {
92
95
  ...babelOptions,
93
96
  ast: true,
94
97
  // filename is important, because babel does not process the same files according to their js/ts extensions
95
98
  // see see https://twitter.com/NicoloRibaudo/status/1321130735605002243
96
99
  filename: sourceCodeFilePath,
97
100
  });
98
- return await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);
101
+ const translations = await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);
102
+ return translations;
99
103
  }
100
104
  catch (e) {
101
- e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`;
105
+ if (e instanceof Error) {
106
+ e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`;
107
+ }
102
108
  throw e;
103
109
  }
104
110
  }
@@ -112,20 +118,14 @@ https://github.com/formatjs/formatjs/blob/main/packages/babel-plugin-formatjs/in
112
118
  https://github.com/pugjs/babel-walk
113
119
  */
114
120
  function extractSourceCodeAstTranslations(ast, sourceCodeFilePath) {
115
- function staticTranslateJSXWarningPart() {
116
- return 'Translate content could not be extracted.\nIt has to be a static string and use optional but static props, like <Translate id="my-id" description="my-description">text</Translate>.';
117
- }
118
- function sourceFileWarningPart(node) {
121
+ function sourceWarningPart(node) {
119
122
  var _a;
120
- return `File=${sourceCodeFilePath} at line=${(_a = node.loc) === null || _a === void 0 ? void 0 : _a.start.line}`;
121
- }
122
- function generateCode(node) {
123
- return generator_1.default(node).code;
123
+ return `File: ${sourceCodeFilePath} at ${(_a = node.loc) === null || _a === void 0 ? void 0 : _a.start.line} line\nFull code: ${(0, generator_1.default)(node).code}`;
124
124
  }
125
125
  const translations = {};
126
126
  const warnings = [];
127
127
  // TODO we should check the presence of the correct @docusaurus imports here!
128
- traverse_1.default(ast, {
128
+ (0, traverse_1.default)(ast, {
129
129
  JSXElement(path) {
130
130
  if (!path
131
131
  .get('openingElement')
@@ -150,41 +150,52 @@ function extractSourceCodeAstTranslations(ast, sourceCodeFilePath) {
150
150
  return attributeValueEvaluated.value;
151
151
  }
152
152
  else {
153
- warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.\nExample: <Translate id="optional.id" description="optional description">Message</Translate>\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceFileWarningPart(path.node)}\n${generateCode(path.node)}`);
153
+ warnings.push(`<Translate> prop=${propName} should be a statically evaluable object.\nExample: <Translate id="optional.id" description="optional description">Message</Translate>\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceWarningPart(path.node)}`);
154
154
  }
155
155
  }
156
156
  return undefined;
157
157
  }
158
- // We only handle the optimistic case where we have a single non-empty content
159
- const singleChildren = path
160
- .get('children')
158
+ const id = evaluateJSXProp('id');
159
+ const description = evaluateJSXProp('description');
160
+ let message;
161
+ const childrenPath = path.get('children');
162
+ // Handle empty content
163
+ if (!childrenPath.length) {
164
+ if (!id) {
165
+ warnings.push(`
166
+ <Translate> without children must have id prop.\nExample: <Translate id="my-id" />\n${sourceWarningPart(path.node)}
167
+ `);
168
+ }
169
+ else {
170
+ translations[id] = {
171
+ message: message !== null && message !== void 0 ? message : id,
172
+ ...(description && { description }),
173
+ };
174
+ }
175
+ return;
176
+ }
177
+ // Handle single non-empty content
178
+ const singleChildren = childrenPath
161
179
  // Remove empty/useless text nodes that might be around our translation!
162
180
  // Makes the translation system more reliable to JSX formatting issues
163
- .filter((childrenPath) => !(childrenPath.isJSXText() &&
164
- childrenPath.node.value.replace('\n', '').trim() === ''))
181
+ .filter((children) => !(children.isJSXText() &&
182
+ children.node.value.replace('\n', '').trim() === ''))
165
183
  .pop();
166
- if (singleChildren && singleChildren.isJSXText()) {
167
- const message = singleChildren.node.value.trim().replace(/\s+/g, ' ');
168
- const id = evaluateJSXProp('id');
169
- const description = evaluateJSXProp('description');
170
- translations[id !== null && id !== void 0 ? id : message] = {
171
- message,
172
- ...(description && { description }),
173
- };
174
- }
175
- else if (singleChildren &&
184
+ const isJSXText = singleChildren && singleChildren.isJSXText();
185
+ const isJSXExpressionContainer = singleChildren &&
176
186
  singleChildren.isJSXExpressionContainer() &&
177
- singleChildren.get('expression').evaluate().confident) {
178
- const message = singleChildren.get('expression').evaluate().value;
179
- const id = evaluateJSXProp('id');
180
- const description = evaluateJSXProp('description');
187
+ singleChildren.get('expression').evaluate().confident;
188
+ if (isJSXText || isJSXExpressionContainer) {
189
+ message = isJSXText
190
+ ? singleChildren.node.value.trim().replace(/\s+/g, ' ')
191
+ : singleChildren.get('expression').evaluate().value;
181
192
  translations[id !== null && id !== void 0 ? id : message] = {
182
193
  message,
183
194
  ...(description && { description }),
184
195
  };
185
196
  }
186
197
  else {
187
- warnings.push(`${staticTranslateJSXWarningPart()}\n${sourceFileWarningPart(path.node)}\n${generateCode(path.node)}`);
198
+ warnings.push(`Translate content could not be extracted. It has to be a static string and use optional but static props, like <Translate id="my-id" description="my-description">text</Translate>.\n${sourceWarningPart(path.node)}`);
188
199
  }
189
200
  },
190
201
  CallExpression(path) {
@@ -202,16 +213,16 @@ function extractSourceCodeAstTranslations(ast, sourceCodeFilePath) {
202
213
  typeof firstArgEvaluated.value === 'object') {
203
214
  const { message, id, description } = firstArgEvaluated.value;
204
215
  translations[id !== null && id !== void 0 ? id : message] = {
205
- message,
216
+ message: message !== null && message !== void 0 ? message : id,
206
217
  ...(description && { description }),
207
218
  };
208
219
  }
209
220
  else {
210
- warnings.push(`translate() first arg should be a statically evaluable object.\nExample: translate({message: "text",id: "optional.id",description: "optional description"}\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceFileWarningPart(path.node)}\n${generateCode(path.node)}`);
221
+ warnings.push(`translate() first arg should be a statically evaluable object.\nExample: translate({message: "text",id: "optional.id",description: "optional description"}\nDynamically constructed values are not allowed, because they prevent translations to be extracted.\n${sourceWarningPart(path.node)}`);
211
222
  }
212
223
  }
213
224
  else {
214
- warnings.push(`translate() function only takes 1 or 2 args\n${sourceFileWarningPart(path.node)}\n${generateCode(path.node)}`);
225
+ warnings.push(`translate() function only takes 1 or 2 args\n${sourceWarningPart(path.node)}`);
215
226
  }
216
227
  },
217
228
  });
@@ -1,4 +1,10 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
1
7
  import { RouteConfig } from '@docusaurus/types';
2
- import globby from 'globby';
8
+ import { Globby } from '@docusaurus/utils';
3
9
  export declare function getAllFinalRoutes(routeConfig: RouteConfig[]): RouteConfig[];
4
- export declare function safeGlobby(patterns: string[], options?: globby.GlobbyOptions): Promise<string[]>;
10
+ export declare function safeGlobby(patterns: string[], options?: Globby.GlobbyOptions): Promise<string[]>;
@@ -1,23 +1,21 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.safeGlobby = exports.getAllFinalRoutes = void 0;
4
- const tslib_1 = require("tslib");
5
2
  /**
6
3
  * Copyright (c) Facebook, Inc. and its affiliates.
7
4
  *
8
5
  * This source code is licensed under the MIT license found in the
9
6
  * LICENSE file in the root directory of this source tree.
10
7
  */
11
- const lodash_1 = require("lodash");
12
- const globby_1 = tslib_1.__importDefault(require("globby"));
13
- const path_1 = tslib_1.__importDefault(require("path"));
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.safeGlobby = exports.getAllFinalRoutes = void 0;
10
+ const tslib_1 = require("tslib");
11
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
14
12
  const utils_1 = require("@docusaurus/utils");
15
13
  // Recursively get the final routes (routes with no subroutes)
16
14
  function getAllFinalRoutes(routeConfig) {
17
15
  function getFinalRoutes(route) {
18
- return route.routes ? lodash_1.flatMap(route.routes, getFinalRoutes) : [route];
16
+ return route.routes ? route.routes.flatMap(getFinalRoutes) : [route];
19
17
  }
20
- return lodash_1.flatMap(routeConfig, getFinalRoutes);
18
+ return routeConfig.flatMap(getFinalRoutes);
21
19
  }
22
20
  exports.getAllFinalRoutes = getAllFinalRoutes;
23
21
  // Globby that fix Windows path patterns
@@ -25,7 +23,7 @@ exports.getAllFinalRoutes = getAllFinalRoutes;
25
23
  async function safeGlobby(patterns, options) {
26
24
  // Required for Windows support, as paths using \ should not be used by globby
27
25
  // (also using the windows hard drive prefix like c: is not a good idea)
28
- const globPaths = patterns.map((dirPath) => utils_1.posixPath(path_1.default.relative(process.cwd(), dirPath)));
29
- return globby_1.default(globPaths, options);
26
+ const globPaths = patterns.map((dirPath) => (0, utils_1.posixPath)(path_1.default.relative(process.cwd(), dirPath)));
27
+ return (0, utils_1.Globby)(globPaths, options);
30
28
  }
31
29
  exports.safeGlobby = safeGlobby;
@@ -10,16 +10,16 @@ const __1 = require("..");
10
10
  const path_1 = require("path");
11
11
  describe('getPluginVersion', () => {
12
12
  it('Can detect external packages plugins versions of correctly.', () => {
13
- expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'),
13
+ expect((0, __1.getPluginVersion)((0, path_1.join)(__dirname, '..', '__fixtures__', 'dummy-plugin.js'),
14
14
  // Make the plugin appear external.
15
- path_1.join(__dirname, '..', '..', '..', '..', '..', '..', 'website'))).toEqual({ type: 'package', version: 'random-version' });
15
+ (0, path_1.join)(__dirname, '..', '..', '..', '..', '..', '..', 'website'))).toEqual({ type: 'package', version: 'random-version' });
16
16
  });
17
17
  it('Can detect project plugins versions correctly.', () => {
18
- expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'),
18
+ expect((0, __1.getPluginVersion)((0, path_1.join)(__dirname, '..', '__fixtures__', 'dummy-plugin.js'),
19
19
  // Make the plugin appear project local.
20
- path_1.join(__dirname, '..', '__fixtures__'))).toEqual({ type: 'project' });
20
+ (0, path_1.join)(__dirname, '..', '__fixtures__'))).toEqual({ type: 'project' });
21
21
  });
22
22
  it('Can detect local packages versions correctly.', () => {
23
- expect(__1.getPluginVersion('/', '/')).toEqual({ type: 'local' });
23
+ expect((0, __1.getPluginVersion)('/', '/')).toEqual({ type: 'local' });
24
24
  });
25
25
  });
@@ -10,7 +10,7 @@ exports.getPluginVersion = exports.getPackageJsonName = exports.getPackageJsonVe
10
10
  const fs_extra_1 = require("fs-extra");
11
11
  const path_1 = require("path");
12
12
  function getPackageJsonVersion(packageJsonPath) {
13
- if (fs_extra_1.existsSync(packageJsonPath)) {
13
+ if ((0, fs_extra_1.existsSync)(packageJsonPath)) {
14
14
  // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
15
15
  const { version } = require(packageJsonPath);
16
16
  return typeof version === 'string' ? version : undefined;
@@ -19,7 +19,7 @@ function getPackageJsonVersion(packageJsonPath) {
19
19
  }
20
20
  exports.getPackageJsonVersion = getPackageJsonVersion;
21
21
  function getPackageJsonName(packageJsonPath) {
22
- if (fs_extra_1.existsSync(packageJsonPath)) {
22
+ if ((0, fs_extra_1.existsSync)(packageJsonPath)) {
23
23
  // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
24
24
  const { name } = require(packageJsonPath);
25
25
  return typeof name === 'string' ? name : undefined;
@@ -28,10 +28,10 @@ function getPackageJsonName(packageJsonPath) {
28
28
  }
29
29
  exports.getPackageJsonName = getPackageJsonName;
30
30
  function getPluginVersion(pluginPath, siteDir) {
31
- let potentialPluginPackageJsonDirectory = path_1.dirname(pluginPath);
31
+ let potentialPluginPackageJsonDirectory = (0, path_1.dirname)(pluginPath);
32
32
  while (potentialPluginPackageJsonDirectory !== '/') {
33
- const packageJsonPath = path_1.join(potentialPluginPackageJsonDirectory, 'package.json');
34
- if (fs_extra_1.existsSync(packageJsonPath) && fs_extra_1.lstatSync(packageJsonPath).isFile()) {
33
+ const packageJsonPath = (0, path_1.join)(potentialPluginPackageJsonDirectory, 'package.json');
34
+ if ((0, fs_extra_1.existsSync)(packageJsonPath) && (0, fs_extra_1.lstatSync)(packageJsonPath).isFile()) {
35
35
  if (potentialPluginPackageJsonDirectory === siteDir) {
36
36
  // If the plugin belongs to the same docusaurus project, we classify it as local plugin.
37
37
  return { type: 'project' };
@@ -42,7 +42,7 @@ function getPluginVersion(pluginPath, siteDir) {
42
42
  version: getPackageJsonVersion(packageJsonPath),
43
43
  };
44
44
  }
45
- potentialPluginPackageJsonDirectory = path_1.dirname(potentialPluginPackageJsonDirectory);
45
+ potentialPluginPackageJsonDirectory = (0, path_1.dirname)(potentialPluginPackageJsonDirectory);
46
46
  }
47
47
  // In rare cases where a plugin is a path where no parent directory contains package.json, we can only classify it as local.
48
48
  return { type: 'local' };
@@ -8,12 +8,13 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.createBaseConfig = exports.getDocusaurusAliases = exports.excludeJS = exports.clientDir = void 0;
10
10
  const tslib_1 = require("tslib");
11
- const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
12
- const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
13
- const path_1 = tslib_1.__importDefault(require("path"));
11
+ const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
12
+ const mini_css_extract_plugin_1 = (0, tslib_1.__importDefault)(require("mini-css-extract-plugin"));
13
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
14
14
  const utils_1 = require("./utils");
15
15
  const constants_1 = require("../constants");
16
- const sharedModuleAliases_1 = tslib_1.__importDefault(require("./sharedModuleAliases"));
16
+ const themes_1 = require("../server/themes");
17
+ const utils_2 = require("@docusaurus/utils");
17
18
  const CSS_REGEX = /\.css$/;
18
19
  const CSS_MODULE_REGEX = /\.module\.css$/;
19
20
  exports.clientDir = path_1.default.join(__dirname, '..', 'client');
@@ -48,32 +49,39 @@ function getDocusaurusAliases() {
48
49
  exports.getDocusaurusAliases = getDocusaurusAliases;
49
50
  function createBaseConfig(props, isServer, minify = true) {
50
51
  var _a;
51
- const { outDir, siteDir, siteConfig, baseUrl, generatedFilesDir, routesPaths, siteMetadata, } = props;
52
+ const { outDir, siteDir, siteConfig, siteConfigPath, baseUrl, generatedFilesDir, routesPaths, siteMetadata, plugins, } = props;
52
53
  const totalPages = routesPaths.length;
53
54
  const isProd = process.env.NODE_ENV === 'production';
54
55
  const minimizeEnabled = minify && isProd && !isServer;
55
56
  const useSimpleCssMinifier = process.env.USE_SIMPLE_CSS_MINIFIER === 'true';
56
- const fileLoaderUtils = utils_1.getFileLoaderUtils();
57
+ const fileLoaderUtils = (0, utils_1.getFileLoaderUtils)();
57
58
  const name = isServer ? 'server' : 'client';
58
59
  const mode = isProd ? 'production' : 'development';
60
+ const themeAliases = (0, themes_1.loadPluginsThemeAliases)({ siteDir, plugins });
59
61
  return {
60
62
  mode,
61
63
  name,
62
64
  cache: {
63
- // TODO temporary env variable to reduce risk of Webpack 5 release
64
- // maybe expose an official api, once this is solved? https://github.com/webpack/webpack/issues/13034
65
- type: process.env.DOCUSAURUS_WEBPACK_CACHE_TYPE ||
66
- 'filesystem',
65
+ type: 'filesystem',
67
66
  // Can we share the same cache across locales?
68
67
  // Exploring that question at https://github.com/webpack/webpack/issues/13034
69
68
  // name: `${name}-${mode}`,
70
69
  name: `${name}-${mode}-${props.i18n.currentLocale}`,
71
- version: siteMetadata.docusaurusVersion,
70
+ // When version string changes, cache is evicted
71
+ version: [
72
+ siteMetadata.docusaurusVersion,
73
+ // Webpack does not evict the cache correctly on alias/swizzle change, so we force eviction.
74
+ // See https://github.com/webpack/webpack/issues/13627
75
+ (0, utils_2.md5Hash)(JSON.stringify(themeAliases)),
76
+ ].join('-'),
77
+ // When one of those modules/dependencies change (including transitive deps), cache is invalidated
72
78
  buildDependencies: {
73
- // When one of dependencies change, cache is invalidated
74
79
  config: [
75
80
  __filename,
76
81
  path_1.default.join(__dirname, isServer ? 'server.js' : 'client.js'),
82
+ // Docusaurus config changes can affect MDX/JSX compilation, so we'd rather evict the cache.
83
+ // See https://github.com/questdb/questdb.io/issues/493
84
+ siteConfigPath,
77
85
  ],
78
86
  },
79
87
  },
@@ -85,6 +93,7 @@ function createBaseConfig(props, isServer, minify = true) {
85
93
  ? 'assets/js/[name].[contenthash:8].js'
86
94
  : '[name].js',
87
95
  publicPath: baseUrl,
96
+ hashFunction: 'xxhash64',
88
97
  },
89
98
  // Don't throw warning when asset created is over 250kb
90
99
  performance: {
@@ -104,13 +113,13 @@ function createBaseConfig(props, isServer, minify = true) {
104
113
  process.cwd(),
105
114
  ],
106
115
  alias: {
107
- ...sharedModuleAliases_1.default,
108
116
  '@site': siteDir,
109
117
  '@generated': generatedFilesDir,
110
118
  // Note: a @docusaurus alias would also catch @docusaurus/theme-common,
111
119
  // so we use fine-grained aliases instead
112
120
  // '@docusaurus': path.resolve(__dirname, '../client/exports'),
113
121
  ...getDocusaurusAliases(),
122
+ ...themeAliases,
114
123
  },
115
124
  // This allows you to set a fallback for where Webpack should look for modules.
116
125
  // We want `@docusaurus/core` own dependencies/`node_modules` to "win" if there is conflict
@@ -130,7 +139,7 @@ function createBaseConfig(props, isServer, minify = true) {
130
139
  // Only minimize client bundle in production because server bundle is only used for static site generation
131
140
  minimize: minimizeEnabled,
132
141
  minimizer: minimizeEnabled
133
- ? utils_1.getMinimizer(useSimpleCssMinifier)
142
+ ? (0, utils_1.getMinimizer)(useSimpleCssMinifier)
134
143
  : undefined,
135
144
  splitChunks: isServer
136
145
  ? false
@@ -170,16 +179,16 @@ function createBaseConfig(props, isServer, minify = true) {
170
179
  test: /\.(j|t)sx?$/,
171
180
  exclude: excludeJS,
172
181
  use: [
173
- utils_1.getCustomizableJSLoader((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
182
+ (0, utils_1.getCustomizableJSLoader)((_a = siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader)({
174
183
  isServer,
175
- babelOptions: utils_1.getCustomBabelConfigFilePath(siteDir),
184
+ babelOptions: (0, utils_1.getCustomBabelConfigFilePath)(siteDir),
176
185
  }),
177
186
  ],
178
187
  },
179
188
  {
180
189
  test: CSS_REGEX,
181
190
  exclude: CSS_MODULE_REGEX,
182
- use: utils_1.getStyleLoaders(isServer, {
191
+ use: (0, utils_1.getStyleLoaders)(isServer, {
183
192
  importLoaders: 1,
184
193
  sourceMap: !isProd,
185
194
  }),
@@ -188,11 +197,11 @@ function createBaseConfig(props, isServer, minify = true) {
188
197
  // using the extension .module.css
189
198
  {
190
199
  test: CSS_MODULE_REGEX,
191
- use: utils_1.getStyleLoaders(isServer, {
200
+ use: (0, utils_1.getStyleLoaders)(isServer, {
192
201
  modules: {
193
202
  localIdentName: isProd
194
203
  ? `[local]_[contenthash:base64:4]`
195
- : `[local]_[path]`,
204
+ : `[local]_[path][name]`,
196
205
  exportOnlyLocals: isServer,
197
206
  },
198
207
  importLoaders: 1,
@@ -7,28 +7,19 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const chalk_1 = tslib_1.__importDefault(require("chalk"));
11
- const path_1 = tslib_1.__importDefault(require("path"));
12
- const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
10
+ const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
11
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
12
+ const webpack_merge_1 = (0, tslib_1.__importDefault)(require("webpack-merge"));
13
13
  const base_1 = require("./base");
14
- const ChunkAssetPlugin_1 = tslib_1.__importDefault(require("./plugins/ChunkAssetPlugin"));
15
- const LogPlugin_1 = tslib_1.__importDefault(require("./plugins/LogPlugin"));
14
+ const ChunkAssetPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/ChunkAssetPlugin"));
15
+ const LogPlugin_1 = (0, tslib_1.__importDefault)(require("./plugins/LogPlugin"));
16
16
  function createClientConfig(props, minify = true) {
17
17
  var _a;
18
- const isProd = process.env.NODE_ENV === 'production';
19
18
  const isBuilding = process.argv[2] === 'build';
20
- const config = base_1.createBaseConfig(props, false, minify);
21
- const clientConfig = webpack_merge_1.default(config, {
19
+ const config = (0, base_1.createBaseConfig)(props, false, minify);
20
+ const clientConfig = (0, webpack_merge_1.default)(config, {
22
21
  // target: 'browserslist', // useless, disabled on purpose (errors on existing sites with no browserslist cfg)
23
- entry: [
24
- // Instead of the default WebpackDevServer client, we use a custom one
25
- // like CRA to bring better experience.
26
- // note: the one in ./dev is modified to work with Docusaurus
27
- // !isProd && require.resolve('react-dev-utils/hotDevServer.js'),
28
- !isProd &&
29
- require.resolve('./react-dev-utils-webpack5/webpackHotDevClient.js'),
30
- path_1.default.resolve(__dirname, '../client/clientEntry.js'),
31
- ].filter(Boolean),
22
+ entry: path_1.default.resolve(__dirname, '../client/clientEntry.js'),
32
23
  optimization: {
33
24
  // Keep the runtime chunk separated to enable long term caching
34
25
  // https://twitter.com/wSokra/status/969679223278505985
@@ -7,7 +7,7 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const path_1 = tslib_1.__importDefault(require("path"));
10
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
11
11
  const del_1 = require("del");
12
12
  class CleanWebpackPlugin {
13
13
  constructor(options = {}) {
@@ -41,7 +41,6 @@ class CleanWebpackPlugin {
41
41
  }
42
42
  apply(compiler) {
43
43
  if (!compiler.options.output || !compiler.options.output.path) {
44
- // eslint-disable-next-line no-console
45
44
  console.warn('clean-webpack-plugin: options.output.path not defined. Plugin disabled...');
46
45
  return;
47
46
  }
@@ -76,7 +75,6 @@ class CleanWebpackPlugin {
76
75
  */
77
76
  if (stats.hasErrors()) {
78
77
  if (this.verbose) {
79
- // eslint-disable-next-line no-console
80
78
  console.warn('clean-webpack-plugin: pausing due to webpack errors');
81
79
  }
82
80
  return;
@@ -116,7 +114,7 @@ class CleanWebpackPlugin {
116
114
  }
117
115
  removeFiles(patterns) {
118
116
  try {
119
- const deleted = del_1.sync(patterns, {
117
+ const deleted = (0, del_1.sync)(patterns, {
120
118
  force: false,
121
119
  // Change context to build directory
122
120
  cwd: this.outputPath,
@@ -135,7 +133,6 @@ class CleanWebpackPlugin {
135
133
  * https://github.com/webpack/webpack/issues/1904
136
134
  * https://github.com/johnagan/clean-webpack-plugin/issues/11
137
135
  */
138
- // eslint-disable-next-line no-console
139
136
  console.warn(`clean-webpack-plugin: removed ${filename}`);
140
137
  });
141
138
  }
@@ -7,9 +7,8 @@ const tslib_1 = require("tslib");
7
7
  * This source code is licensed under the MIT license found in the
8
8
  * LICENSE file in the root directory of this source tree.
9
9
  */
10
- const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
11
- // import formatWebpackMessages from 'react-dev-utils/formatWebpackMessages';
12
- const formatWebpackMessages_1 = tslib_1.__importDefault(require("../react-dev-utils-webpack5/formatWebpackMessages"));
10
+ const webpackbar_1 = (0, tslib_1.__importDefault)(require("webpackbar"));
11
+ const formatWebpackMessages_1 = (0, tslib_1.__importDefault)(require("react-dev-utils/formatWebpackMessages"));
13
12
  function showError(arr) {
14
13
  console.log(`\n\n${arr.join('\n')}`);
15
14
  }
@@ -23,7 +22,7 @@ class LogPlugin extends webpackbar_1.default {
23
22
  // TODO do we really want to keep this legacy logic?
24
23
  // let's wait and see how the react-dev-utils support Webpack5
25
24
  // we probably want to print the error stacktraces here
26
- const messages = formatWebpackMessages_1.default(errorsWarnings);
25
+ const messages = (0, formatWebpackMessages_1.default)(errorsWarnings);
27
26
  if (messages.errors.length) {
28
27
  showError(messages.errors);
29
28
  }
@@ -7,9 +7,9 @@
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  const tslib_1 = require("tslib");
10
- const path_1 = tslib_1.__importDefault(require("path"));
11
- const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
12
- const wait_on_1 = tslib_1.__importDefault(require("wait-on"));
10
+ const path_1 = (0, tslib_1.__importDefault)(require("path"));
11
+ const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
12
+ const wait_on_1 = (0, tslib_1.__importDefault)(require("wait-on"));
13
13
  class WaitPlugin {
14
14
  constructor(options) {
15
15
  this.filepath = options.filepath;
@@ -20,7 +20,7 @@ class WaitPlugin {
20
20
  // To prevent 'waitFile' error on waiting non-existing directory
21
21
  fs_extra_1.default.ensureDir(path_1.default.dirname(this.filepath), {}, () => {
22
22
  // Wait until file exist
23
- wait_on_1.default({
23
+ (0, wait_on_1.default)({
24
24
  resources: [this.filepath],
25
25
  interval: 300,
26
26
  })
@@ -0,0 +1,2 @@
1
+ declare function _exports(server: any): (req: any, res: any, next: any) => void;
2
+ export = _exports;
@@ -0,0 +1,5 @@
1
+ export = formatWebpackMessages;
2
+ declare function formatWebpackMessages(json: any): {
3
+ errors: any;
4
+ warnings: any;
5
+ };
@@ -38,7 +38,7 @@ function formatMessage(message) {
38
38
  }
39
39
 
40
40
  // Strip webpack-added headers off errors/warnings
41
- // https://github.com/webpack/webpack/blob/master/lib/ModuleError.js
41
+ // https://github.com/webpack/webpack/blob/main/lib/ModuleError.js
42
42
  lines = lines.filter((line) => !/Module [A-z ]+\(from/.test(line));
43
43
 
44
44
  // Transform parsing error into syntax error