@docusaurus/core 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

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 (222) hide show
  1. package/README.md +1 -0
  2. package/bin/beforeCli.mjs +140 -0
  3. package/bin/docusaurus.mjs +221 -0
  4. package/lib/babel/preset.d.ts +8 -3
  5. package/lib/babel/preset.js +10 -8
  6. package/lib/client/App.d.ts +2 -3
  7. package/lib/client/App.js +31 -28
  8. package/lib/client/BaseUrlIssueBanner/index.d.ts +27 -0
  9. package/lib/client/{baseUrlIssueBanner/BaseUrlIssueBanner.js → BaseUrlIssueBanner/index.js} +25 -14
  10. package/lib/client/{baseUrlIssueBanner → BaseUrlIssueBanner}/styles.module.css +0 -0
  11. package/lib/client/ClientLifecyclesDispatcher.d.ts +16 -0
  12. package/lib/client/ClientLifecyclesDispatcher.js +39 -0
  13. package/lib/client/LinksCollector.d.ts +3 -3
  14. package/lib/client/LinksCollector.js +8 -13
  15. package/lib/client/PendingNavigation.d.ts +17 -3
  16. package/lib/client/PendingNavigation.js +47 -72
  17. package/lib/client/{baseUrlIssueBanner/BaseUrlIssueBanner.d.ts → SiteMetadataDefaults.d.ts} +1 -2
  18. package/lib/client/SiteMetadataDefaults.js +21 -0
  19. package/lib/{choosePort.d.ts → client/browserContext.d.ts} +5 -5
  20. package/lib/client/browserContext.js +22 -0
  21. package/lib/client/clientEntry.js +14 -9
  22. package/lib/client/docusaurus.d.ts +12 -6
  23. package/lib/client/docusaurus.js +30 -43
  24. package/lib/client/docusaurusContext.d.ts +12 -0
  25. package/lib/client/docusaurusContext.js +25 -0
  26. package/lib/client/exports/BrowserOnly.d.ts +3 -5
  27. package/lib/client/exports/BrowserOnly.js +14 -7
  28. package/lib/client/exports/ComponentCreator.d.ts +6 -2
  29. package/lib/client/exports/ComponentCreator.js +75 -42
  30. package/lib/client/exports/ErrorBoundary.d.ts +18 -0
  31. package/lib/client/exports/ErrorBoundary.js +37 -0
  32. package/lib/client/exports/ExecutionEnvironment.js +7 -8
  33. package/lib/client/exports/Head.d.ts +2 -3
  34. package/lib/client/exports/Head.js +3 -4
  35. package/lib/client/exports/Interpolate.d.ts +2 -2
  36. package/lib/client/exports/Interpolate.js +20 -49
  37. package/lib/client/exports/Link.d.ts +4 -10
  38. package/lib/client/exports/Link.js +44 -38
  39. package/lib/client/exports/Translate.d.ts +1 -1
  40. package/lib/client/exports/Translate.js +14 -9
  41. package/lib/client/exports/constants.js +1 -11
  42. package/lib/client/exports/isInternalUrl.js +1 -1
  43. package/lib/client/exports/renderRoutes.d.ts +1 -2
  44. package/lib/client/exports/renderRoutes.js +1 -2
  45. package/lib/client/exports/router.d.ts +1 -1
  46. package/lib/client/exports/router.js +1 -1
  47. package/lib/client/exports/useBaseUrl.js +11 -14
  48. package/lib/client/exports/useDocusaurusContext.d.ts +2 -3
  49. package/lib/client/exports/useDocusaurusContext.js +3 -9
  50. package/lib/client/exports/useGlobalData.d.ts +4 -3
  51. package/lib/client/exports/useGlobalData.js +8 -15
  52. package/lib/{server/versions/__tests/index.test.d.ts → client/exports/useIsBrowser.d.ts} +1 -1
  53. package/lib/client/exports/useIsBrowser.js +11 -0
  54. package/lib/client/exports/useRouteContext.d.ts +8 -0
  55. package/lib/client/exports/useRouteContext.js +15 -0
  56. package/lib/client/flat.d.ts +12 -2
  57. package/lib/client/flat.js +19 -15
  58. package/lib/client/normalizeLocation.d.ts +2 -5
  59. package/lib/client/normalizeLocation.js +14 -10
  60. package/lib/client/prefetch.d.ts +1 -2
  61. package/lib/client/prefetch.js +12 -32
  62. package/lib/client/preload.d.ts +3 -4
  63. package/lib/client/preload.js +5 -12
  64. package/lib/client/routeContext.d.ts +13 -0
  65. package/lib/client/routeContext.js +31 -0
  66. package/lib/client/serverEntry.d.ts +10 -0
  67. package/lib/client/serverEntry.js +109 -136
  68. package/lib/client/theme-fallback/Error/index.d.ts +10 -0
  69. package/lib/client/theme-fallback/Error/index.js +45 -0
  70. package/lib/client/theme-fallback/Layout/index.d.ts +10 -0
  71. package/lib/client/theme-fallback/Layout/index.js +2 -26
  72. package/lib/client/theme-fallback/Loading/index.d.ts +9 -0
  73. package/lib/client/theme-fallback/Loading/index.js +50 -116
  74. package/lib/client/{exports/context.js → theme-fallback/NotFound/index.d.ts} +2 -2
  75. package/lib/client/theme-fallback/NotFound/index.js +19 -18
  76. package/lib/client/theme-fallback/Root/index.d.ts +10 -0
  77. package/lib/client/theme-fallback/Root/index.js +2 -6
  78. package/lib/{server/html-tags/htmlTags.d.ts → client/theme-fallback/SiteMetadata/index.d.ts} +2 -1
  79. package/lib/client/theme-fallback/SiteMetadata/index.js +10 -0
  80. package/lib/commands/build.d.ts +6 -2
  81. package/lib/commands/build.js +81 -64
  82. package/lib/commands/clear.d.ts +7 -1
  83. package/lib/commands/clear.js +34 -21
  84. package/lib/commands/deploy.d.ts +5 -2
  85. package/lib/commands/deploy.js +102 -81
  86. package/lib/commands/external.d.ts +2 -2
  87. package/lib/commands/external.js +9 -11
  88. package/lib/commands/serve.d.ts +8 -2
  89. package/lib/commands/serve.js +40 -20
  90. package/lib/commands/start.d.ts +9 -2
  91. package/lib/commands/start.js +111 -101
  92. package/lib/commands/swizzle/actions.d.ts +23 -0
  93. package/lib/commands/swizzle/actions.js +106 -0
  94. package/lib/commands/swizzle/common.d.ts +33 -0
  95. package/lib/commands/swizzle/common.js +56 -0
  96. package/lib/commands/swizzle/components.d.ts +29 -0
  97. package/lib/commands/swizzle/components.js +200 -0
  98. package/lib/commands/swizzle/config.d.ts +10 -0
  99. package/lib/commands/swizzle/config.js +84 -0
  100. package/lib/{server/client-modules/index.d.ts → commands/swizzle/context.d.ts} +2 -2
  101. package/lib/commands/swizzle/context.js +24 -0
  102. package/lib/commands/swizzle/index.d.ts +8 -0
  103. package/lib/commands/swizzle/index.js +119 -0
  104. package/lib/commands/swizzle/prompts.d.ts +12 -0
  105. package/lib/commands/swizzle/prompts.js +110 -0
  106. package/lib/{client/exports/context.d.ts → commands/swizzle/tables.d.ts} +3 -4
  107. package/lib/commands/swizzle/tables.js +113 -0
  108. package/lib/commands/swizzle/themes.d.ts +20 -0
  109. package/lib/commands/swizzle/themes.js +106 -0
  110. package/lib/commands/writeHeadingIds.d.ts +2 -6
  111. package/lib/commands/writeHeadingIds.js +22 -81
  112. package/lib/commands/writeTranslations.d.ts +4 -5
  113. package/lib/commands/writeTranslations.js +48 -28
  114. package/lib/index.d.ts +9 -9
  115. package/lib/index.js +14 -14
  116. package/lib/server/brokenLinks.d.ts +4 -17
  117. package/lib/server/brokenLinks.js +67 -56
  118. package/lib/server/clientModules.d.ts +12 -0
  119. package/lib/server/clientModules.js +20 -0
  120. package/lib/server/config.d.ts +5 -2
  121. package/lib/server/config.js +29 -6
  122. package/lib/server/configValidation.d.ts +5 -3
  123. package/lib/server/configValidation.js +105 -44
  124. package/lib/server/getHostPort.d.ts +14 -0
  125. package/lib/server/getHostPort.js +79 -0
  126. package/lib/server/htmlTags.d.ts +12 -0
  127. package/lib/server/htmlTags.js +62 -0
  128. package/lib/server/i18n.d.ts +3 -13
  129. package/lib/server/i18n.js +21 -55
  130. package/lib/server/index.d.ts +28 -6
  131. package/lib/server/index.js +86 -173
  132. package/lib/server/plugins/configs.d.ts +51 -0
  133. package/lib/server/plugins/configs.js +101 -0
  134. package/lib/server/plugins/index.d.ts +10 -10
  135. package/lib/server/plugins/index.js +76 -128
  136. package/lib/server/plugins/init.d.ts +6 -9
  137. package/lib/server/plugins/init.js +44 -109
  138. package/lib/server/plugins/moduleShorthand.d.ts +9 -0
  139. package/lib/server/plugins/moduleShorthand.js +46 -0
  140. package/lib/server/plugins/pluginIds.d.ts +6 -2
  141. package/lib/server/plugins/pluginIds.js +12 -7
  142. package/lib/server/plugins/presets.d.ts +12 -0
  143. package/lib/server/plugins/presets.js +49 -0
  144. package/lib/server/plugins/routeConfig.d.ts +11 -0
  145. package/lib/server/plugins/routeConfig.js +54 -0
  146. package/lib/server/plugins/synthetic.d.ts +20 -0
  147. package/lib/server/plugins/synthetic.js +111 -0
  148. package/lib/server/routes.d.ts +39 -7
  149. package/lib/server/routes.js +182 -95
  150. package/lib/server/siteMetadata.d.ts +12 -0
  151. package/lib/server/siteMetadata.js +81 -0
  152. package/lib/server/translations/translations.d.ts +16 -22
  153. package/lib/server/translations/translations.js +41 -73
  154. package/lib/server/translations/translationsExtractor.d.ts +10 -5
  155. package/lib/server/translations/translationsExtractor.js +158 -122
  156. package/lib/server/utils.d.ts +9 -3
  157. package/lib/server/utils.js +7 -9
  158. package/lib/webpack/aliases/index.d.ts +34 -0
  159. package/lib/webpack/aliases/index.js +106 -0
  160. package/lib/webpack/base.d.ts +3 -4
  161. package/lib/webpack/base.js +56 -58
  162. package/lib/webpack/client.d.ts +3 -3
  163. package/lib/webpack/client.js +12 -19
  164. package/lib/webpack/plugins/ChunkAssetPlugin.d.ts +13 -3
  165. package/lib/webpack/plugins/ChunkAssetPlugin.js +24 -17
  166. package/lib/webpack/plugins/CleanWebpackPlugin.d.ts +6 -25
  167. package/lib/webpack/plugins/CleanWebpackPlugin.js +34 -18
  168. package/lib/webpack/plugins/LogPlugin.d.ts +1 -1
  169. package/lib/webpack/plugins/LogPlugin.js +4 -5
  170. package/lib/webpack/plugins/WaitPlugin.d.ts +3 -3
  171. package/lib/webpack/plugins/WaitPlugin.js +1 -1
  172. package/lib/webpack/server.d.ts +5 -5
  173. package/lib/webpack/server.js +23 -8
  174. package/lib/{client → webpack}/templates/index.html.template.ejs +0 -0
  175. package/lib/webpack/templates/ssr.html.template.d.ts +8 -0
  176. package/lib/{client → webpack}/templates/ssr.html.template.js +5 -4
  177. package/lib/webpack/utils.d.ts +16 -31
  178. package/lib/webpack/utils.js +63 -183
  179. package/package.json +83 -77
  180. package/bin/docusaurus.js +0 -326
  181. package/lib/.tsbuildinfo +0 -5682
  182. package/lib/choosePort.js +0 -105
  183. package/lib/client/.eslintrc.js +0 -29
  184. package/lib/client/.tsbuildinfo +0 -4127
  185. package/lib/client/client-lifecycles-dispatcher.d.ts +0 -12
  186. package/lib/client/client-lifecycles-dispatcher.js +0 -27
  187. package/lib/client/nprogress.css +0 -36
  188. package/lib/commands/buildRemoteBranchUrl.d.ts +0 -7
  189. package/lib/commands/buildRemoteBranchUrl.js +0 -27
  190. package/lib/commands/commandUtils.d.ts +0 -3
  191. package/lib/commands/commandUtils.js +0 -21
  192. package/lib/commands/swizzle.d.ts +0 -9
  193. package/lib/commands/swizzle.js +0 -245
  194. package/lib/constants.d.ts +0 -18
  195. package/lib/constants.js +0 -23
  196. package/lib/server/client-modules/index.js +0 -14
  197. package/lib/server/duplicateRoutes.d.ts +0 -10
  198. package/lib/server/duplicateRoutes.js +0 -38
  199. package/lib/server/html-tags/htmlTags.js +0 -39
  200. package/lib/server/html-tags/index.d.ts +0 -9
  201. package/lib/server/html-tags/index.js +0 -43
  202. package/lib/server/loadSetup.d.ts +0 -9
  203. package/lib/server/loadSetup.js +0 -25
  204. package/lib/server/presets/index.d.ts +0 -11
  205. package/lib/server/presets/index.js +0 -48
  206. package/lib/server/themes/alias.d.ts +0 -8
  207. package/lib/server/themes/alias.js +0 -39
  208. package/lib/server/themes/index.d.ts +0 -8
  209. package/lib/server/themes/index.js +0 -35
  210. package/lib/server/versions/__fixtures__/dummy-plugin.js +0 -0
  211. package/lib/server/versions/__fixtures__/package.json +0 -3
  212. package/lib/server/versions/__tests/index.test.js +0 -25
  213. package/lib/server/versions/index.d.ts +0 -10
  214. package/lib/server/versions/index.js +0 -50
  215. package/lib/webpack/react-dev-utils-webpack5/README.md +0 -11
  216. package/lib/webpack/react-dev-utils-webpack5/evalSourceMapMiddleware.js +0 -57
  217. package/lib/webpack/react-dev-utils-webpack5/formatWebpackMessages.js +0 -138
  218. package/lib/webpack/react-dev-utils-webpack5/webpackHotDevClient.js +0 -285
  219. package/lib/webpack/sharedModuleAliases.d.ts +0 -10
  220. package/lib/webpack/sharedModuleAliases.js +0 -18
  221. package/tsconfig.client.json +0 -13
  222. package/tsconfig.json +0 -13
@@ -1,12 +0,0 @@
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
- */
7
- interface Dispatchers {
8
- onRouteUpdate: (...args: any) => void;
9
- onRouteUpdateDelayed: (...args: any) => void;
10
- }
11
- declare const clientLifecyclesDispatchers: Dispatchers;
12
- export default clientLifecyclesDispatchers;
@@ -1,27 +0,0 @@
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
- */
7
- // too dynamic
8
- /* eslint-disable @typescript-eslint/no-explicit-any */
9
- import clientModules from '@generated/client-modules';
10
- function dispatchLifecycleAction(lifecycleAction, ...args) {
11
- clientModules.forEach((clientModule) => {
12
- var _a, _b;
13
- const lifecycleFunction = (_b = (_a = clientModule === null || clientModule === void 0 ? void 0 : clientModule.default) === null || _a === void 0 ? void 0 : _a[lifecycleAction]) !== null && _b !== void 0 ? _b : clientModule[lifecycleAction];
14
- if (lifecycleFunction) {
15
- lifecycleFunction(...args);
16
- }
17
- });
18
- }
19
- const clientLifecyclesDispatchers = {
20
- onRouteUpdate(...args) {
21
- dispatchLifecycleAction('onRouteUpdate', ...args);
22
- },
23
- onRouteUpdateDelayed(...args) {
24
- dispatchLifecycleAction('onRouteUpdateDelayed', ...args);
25
- },
26
- };
27
- export default clientLifecyclesDispatchers;
@@ -1,36 +0,0 @@
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
- */
7
-
8
- /**
9
- * Styles for NProgress
10
- * Copied over to remove unused styles for the spinner.
11
- * https://github.com/rstacruz/nprogress/blob/master/nprogress.css
12
- */
13
-
14
- #nprogress {
15
- pointer-events: none;
16
- }
17
-
18
- #nprogress .bar {
19
- background: #29d;
20
- position: fixed;
21
- z-index: 1031;
22
- top: 0;
23
- left: 0;
24
- width: 100%;
25
- height: 2px;
26
- }
27
-
28
- #nprogress .peg {
29
- position: absolute;
30
- right: 0px;
31
- width: 100px;
32
- height: 100%;
33
- box-shadow: 0 0 10px #29d, 0 0 5px #29d;
34
- opacity: 1;
35
- transform: rotate(3deg) translate(0px, -4px);
36
- }
@@ -1,7 +0,0 @@
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
- */
7
- export declare function buildUrl(githubHost: string, githubPort: string | undefined, gitCredentials: string | undefined, organizationName: string, projectName: string, useSSH: boolean | undefined): string;
@@ -1,27 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.buildUrl = void 0;
10
- function buildUrl(githubHost, githubPort, gitCredentials, organizationName, projectName, useSSH) {
11
- return useSSH
12
- ? buildSshUrl(githubHost, organizationName, projectName, githubPort)
13
- : buildHttpsUrl(gitCredentials, githubHost, organizationName, projectName, githubPort);
14
- }
15
- exports.buildUrl = buildUrl;
16
- function buildSshUrl(githubHost, organizationName, projectName, githubPort) {
17
- if (githubPort) {
18
- return `ssh://git@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
19
- }
20
- return `git@${githubHost}:${organizationName}/${projectName}.git`;
21
- }
22
- function buildHttpsUrl(gitCredentials, githubHost, organizationName, projectName, githubPort) {
23
- if (githubPort) {
24
- return `https://${gitCredentials}@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
25
- }
26
- return `https://${gitCredentials}@${githubHost}/${organizationName}/${projectName}.git`;
27
- }
@@ -1,3 +0,0 @@
1
- import { HostPortCLIOptions } from '@docusaurus/types';
2
- export declare function getCLIOptionHost(hostOption: HostPortCLIOptions['host']): string;
3
- export declare function getCLIOptionPort(portOption: HostPortCLIOptions['port'], host: string): Promise<number | null>;
@@ -1,21 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getCLIOptionPort = exports.getCLIOptionHost = void 0;
4
- const tslib_1 = require("tslib");
5
- /**
6
- * Copyright (c) Facebook, Inc. and its affiliates.
7
- *
8
- * This source code is licensed under the MIT license found in the
9
- * LICENSE file in the root directory of this source tree.
10
- */
11
- const choosePort_1 = tslib_1.__importDefault(require("../choosePort"));
12
- const constants_1 = require("../constants");
13
- function getCLIOptionHost(hostOption) {
14
- return hostOption || 'localhost';
15
- }
16
- exports.getCLIOptionHost = getCLIOptionHost;
17
- async function getCLIOptionPort(portOption, host) {
18
- const basePort = portOption ? parseInt(portOption, 10) : constants_1.DEFAULT_PORT;
19
- return choosePort_1.default(host, basePort);
20
- }
21
- exports.getCLIOptionPort = getCLIOptionPort;
@@ -1,9 +0,0 @@
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
- */
7
- import { PluginConfig } from '@docusaurus/types';
8
- export declare function getPluginNames(plugins: PluginConfig[]): string[];
9
- export default function swizzle(siteDir: string, themeName?: string, componentName?: string, typescript?: boolean, danger?: boolean): Promise<void>;
@@ -1,245 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.getPluginNames = void 0;
10
- const tslib_1 = require("tslib");
11
- const chalk = require("chalk");
12
- const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
13
- const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
14
- const path_1 = tslib_1.__importDefault(require("path"));
15
- const leven_1 = tslib_1.__importDefault(require("leven"));
16
- const lodash_1 = require("lodash");
17
- const constants_1 = require("../constants");
18
- const server_1 = require("../server");
19
- const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
20
- const utils_validation_1 = require("@docusaurus/utils-validation");
21
- function getPluginNames(plugins) {
22
- return plugins
23
- .filter((plugin) => typeof plugin === 'string' ||
24
- (Array.isArray(plugin) && typeof plugin[0] === 'string'))
25
- .map((plugin) => {
26
- const pluginPath = Array.isArray(plugin) ? plugin[0] : plugin;
27
- if (typeof pluginPath === 'string') {
28
- let packagePath = path_1.default.dirname(pluginPath);
29
- while (packagePath) {
30
- if (fs_extra_1.default.existsSync(path_1.default.join(packagePath, 'package.json'))) {
31
- break;
32
- }
33
- else {
34
- packagePath = path_1.default.dirname(packagePath);
35
- }
36
- }
37
- if (packagePath === '.') {
38
- return pluginPath;
39
- }
40
- return import_fresh_1.default(path_1.default.join(packagePath, 'package.json')).name;
41
- }
42
- return '';
43
- })
44
- .filter((plugin) => plugin !== '');
45
- }
46
- exports.getPluginNames = getPluginNames;
47
- function walk(dir) {
48
- let results = [];
49
- const list = fs_extra_1.default.readdirSync(dir);
50
- list.forEach((file) => {
51
- const fullPath = path_1.default.join(dir, file);
52
- const stat = fs_extra_1.default.statSync(fullPath);
53
- if (stat && stat.isDirectory()) {
54
- results = results.concat(walk(fullPath));
55
- }
56
- else if (!/node_modules|.css|.d.ts|.d.map/.test(fullPath)) {
57
- results.push(fullPath);
58
- }
59
- });
60
- return results;
61
- }
62
- const formatComponentName = (componentName) => componentName
63
- .replace(/(\/|\\)index.(js|tsx|ts|jsx)/, '')
64
- .replace(/.(js|tsx|ts|jsx)/, '');
65
- function readComponent(themePath) {
66
- return walk(themePath).map((filePath) => formatComponentName(path_1.default.relative(themePath, filePath)));
67
- }
68
- // load components from theme based on configurations
69
- function getComponentName(themePath, plugin, danger) {
70
- var _a, _b;
71
- // support both commonjs and ES style exports
72
- const getSwizzleComponentList = (_b = (_a = plugin.default) === null || _a === void 0 ? void 0 : _a.getSwizzleComponentList) !== null && _b !== void 0 ? _b : plugin.getSwizzleComponentList;
73
- if (getSwizzleComponentList) {
74
- const allowedComponent = getSwizzleComponentList();
75
- if (danger) {
76
- return readComponent(themePath);
77
- }
78
- return allowedComponent;
79
- }
80
- return readComponent(themePath);
81
- }
82
- function themeComponents(themePath, plugin) {
83
- const components = colorCode(themePath, plugin);
84
- if (components.length === 0) {
85
- return `${chalk.red('No component to swizzle')}`;
86
- }
87
- return `
88
- ${chalk.cyan('Theme components available for swizzle')}
89
-
90
- ${chalk.green('green =>')} safe: lower breaking change risk
91
- ${chalk.red('red =>')} unsafe: higher breaking change risk
92
-
93
- ${components.join('\n')}
94
- `;
95
- }
96
- function formattedThemeNames(themeNames) {
97
- return `Themes available for swizzle:\n${themeNames.join('\n')}`;
98
- }
99
- function colorCode(themePath, plugin) {
100
- var _a, _b;
101
- // support both commonjs and ES style exports
102
- const getSwizzleComponentList = (_b = (_a = plugin.default) === null || _a === void 0 ? void 0 : _a.getSwizzleComponentList) !== null && _b !== void 0 ? _b : plugin.getSwizzleComponentList;
103
- const components = readComponent(themePath);
104
- const allowedComponent = getSwizzleComponentList
105
- ? getSwizzleComponentList()
106
- : [];
107
- const [greenComponents, redComponents] = lodash_1.partition(components, (comp) => allowedComponent.includes(comp));
108
- return [
109
- ...greenComponents.map((component) => chalk.green(`safe: ${component}`)),
110
- ...redComponents.map((component) => chalk.red(`unsafe: ${component}`)),
111
- ];
112
- }
113
- async function swizzle(siteDir, themeName, componentName, typescript, danger) {
114
- var _a, _b, _c, _d, _e;
115
- const context = await server_1.loadContext(siteDir);
116
- const pluginConfigs = server_1.loadPluginConfigs(context);
117
- const pluginNames = getPluginNames(pluginConfigs);
118
- const plugins = init_1.default({
119
- pluginConfigs,
120
- context,
121
- });
122
- const themeNames = pluginNames.filter((_, index) => typescript
123
- ? plugins[index].getTypeScriptThemePath
124
- : plugins[index].getThemePath);
125
- if (!themeName) {
126
- console.log(formattedThemeNames(themeNames));
127
- process.exit(1);
128
- }
129
- let pluginModule;
130
- try {
131
- pluginModule = import_fresh_1.default(themeName);
132
- }
133
- catch {
134
- let suggestion;
135
- themeNames.forEach((name) => {
136
- if (leven_1.default(name, themeName) < 4) {
137
- suggestion = name;
138
- }
139
- });
140
- chalk.red(`Theme ${themeName} not found. ${suggestion
141
- ? `Did you mean "${suggestion}" ?`
142
- : formattedThemeNames(themeNames)}`);
143
- process.exit(1);
144
- }
145
- let pluginOptions = {};
146
- const resolvedThemeName = require.resolve(themeName);
147
- // find the plugin from list of plugin and get options if specified
148
- pluginConfigs.forEach((pluginConfig) => {
149
- // plugin can be a [string], [string,object] or string.
150
- if (Array.isArray(pluginConfig) && typeof pluginConfig[0] === 'string') {
151
- if (require.resolve(pluginConfig[0]) === resolvedThemeName) {
152
- if (pluginConfig.length === 2) {
153
- const [, options] = pluginConfig;
154
- pluginOptions = options;
155
- }
156
- }
157
- }
158
- });
159
- // support both commonjs and ES style exports
160
- const validateOptions = (_b = (_a = pluginModule.default) === null || _a === void 0 ? void 0 : _a.validateOptions) !== null && _b !== void 0 ? _b : pluginModule.validateOptions;
161
- if (validateOptions) {
162
- pluginOptions = validateOptions({
163
- validate: utils_validation_1.normalizePluginOptions,
164
- options: pluginOptions,
165
- });
166
- }
167
- // support both commonjs and ES style exports
168
- const plugin = (_c = pluginModule.default) !== null && _c !== void 0 ? _c : pluginModule;
169
- const pluginInstance = plugin(context, pluginOptions);
170
- const themePath = typescript
171
- ? (_d = pluginInstance.getTypeScriptThemePath) === null || _d === void 0 ? void 0 : _d.call(pluginInstance)
172
- : (_e = pluginInstance.getThemePath) === null || _e === void 0 ? void 0 : _e.call(pluginInstance);
173
- if (!themePath) {
174
- console.warn(chalk.yellow(typescript
175
- ? `${themeName} does not provide TypeScript theme code via "getTypeScriptThemePath()".`
176
- : `${themeName} does not provide any theme code.`));
177
- process.exit(1);
178
- }
179
- if (!componentName) {
180
- console.warn(themeComponents(themePath, pluginModule));
181
- process.exit(1);
182
- }
183
- const components = getComponentName(themePath, pluginModule, Boolean(danger));
184
- const formattedComponentName = formatComponentName(componentName);
185
- const isComponentExists = components.find((component) => component === formattedComponentName);
186
- let mostSuitableComponent = componentName;
187
- if (!isComponentExists) {
188
- let mostSuitableMatch = componentName;
189
- let score = formattedComponentName.length;
190
- components.forEach((component) => {
191
- if (component.toLowerCase() === formattedComponentName.toLowerCase()) {
192
- // may be components with same lowercase key, try to match closest component
193
- const currentScore = leven_1.default(formattedComponentName, component);
194
- if (currentScore < score) {
195
- score = currentScore;
196
- mostSuitableMatch = component;
197
- }
198
- }
199
- });
200
- if (mostSuitableMatch !== componentName) {
201
- mostSuitableComponent = mostSuitableMatch;
202
- console.log(chalk.red(`Component "${componentName}" doesn't exists.`), chalk.yellow(`"${mostSuitableComponent}" is swizzled instead of "${componentName}".`));
203
- }
204
- }
205
- let fromPath = path_1.default.join(themePath, mostSuitableComponent);
206
- let toPath = path_1.default.resolve(siteDir, constants_1.THEME_PATH, mostSuitableComponent);
207
- // Handle single TypeScript/JavaScript file only.
208
- // E.g: if <fromPath> does not exist, we try to swizzle <fromPath>.(ts|tsx|js) instead
209
- if (!fs_extra_1.default.existsSync(fromPath)) {
210
- if (fs_extra_1.default.existsSync(`${fromPath}.ts`)) {
211
- [fromPath, toPath] = [`${fromPath}.ts`, `${toPath}.ts`];
212
- }
213
- else if (fs_extra_1.default.existsSync(`${fromPath}.tsx`)) {
214
- [fromPath, toPath] = [`${fromPath}.tsx`, `${toPath}.tsx`];
215
- }
216
- else if (fs_extra_1.default.existsSync(`${fromPath}.js`)) {
217
- [fromPath, toPath] = [`${fromPath}.js`, `${toPath}.js`];
218
- }
219
- else {
220
- let suggestion;
221
- components.forEach((name) => {
222
- if (leven_1.default(name, mostSuitableComponent) < 3) {
223
- suggestion = name;
224
- }
225
- });
226
- console.warn(chalk.red(`Component ${mostSuitableComponent} not found.`));
227
- console.warn(suggestion
228
- ? `Did you mean "${suggestion}"?`
229
- : `${themeComponents(themePath, pluginModule)}`);
230
- process.exit(1);
231
- }
232
- }
233
- if (!components.includes(mostSuitableComponent) && !danger) {
234
- console.warn(chalk.red(`${mostSuitableComponent} is an internal component, and have a higher breaking change probability. If you want to swizzle it, use the "--danger" flag.`));
235
- process.exit(1);
236
- }
237
- await fs_extra_1.default.copy(fromPath, toPath);
238
- const relativeDir = path_1.default.relative(process.cwd(), toPath);
239
- const fromMsg = chalk.blue(mostSuitableComponent
240
- ? `${themeName} ${chalk.yellow(mostSuitableComponent)}`
241
- : themeName);
242
- const toMsg = chalk.cyan(relativeDir);
243
- console.log(`\n${chalk.green('Success!')} Copied ${fromMsg} to ${toMsg}.\n`);
244
- }
245
- exports.default = swizzle;
@@ -1,18 +0,0 @@
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
- */
7
- export declare const NODE_MAJOR_VERSION: number;
8
- export declare const NODE_MINOR_VERSION: number;
9
- export declare const DEFAULT_BUILD_DIR_NAME = "build";
10
- export declare const DEFAULT_CONFIG_FILE_NAME = "docusaurus.config.js";
11
- export declare const BABEL_CONFIG_FILE_NAME: string;
12
- export declare const GENERATED_FILES_DIR_NAME: string;
13
- export declare const SRC_DIR_NAME = "src";
14
- export declare const STATIC_DIR_NAME = "static";
15
- export declare const OUTPUT_STATIC_ASSETS_DIR_NAME = "assets";
16
- export declare const THEME_PATH: string;
17
- export declare const DEFAULT_PORT = 3000;
18
- export declare const DEFAULT_PLUGIN_ID = "default";
package/lib/constants.js DELETED
@@ -1,23 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.DEFAULT_PLUGIN_ID = exports.DEFAULT_PORT = exports.THEME_PATH = exports.OUTPUT_STATIC_ASSETS_DIR_NAME = exports.STATIC_DIR_NAME = exports.SRC_DIR_NAME = exports.GENERATED_FILES_DIR_NAME = exports.BABEL_CONFIG_FILE_NAME = exports.DEFAULT_CONFIG_FILE_NAME = exports.DEFAULT_BUILD_DIR_NAME = exports.NODE_MINOR_VERSION = exports.NODE_MAJOR_VERSION = void 0;
10
- exports.NODE_MAJOR_VERSION = parseInt(process.versions.node.split('.')[0], 10);
11
- exports.NODE_MINOR_VERSION = parseInt(process.versions.node.split('.')[1], 10);
12
- // Can be overridden with cli option --out-dir
13
- exports.DEFAULT_BUILD_DIR_NAME = 'build';
14
- // Can be overridden with cli option --config
15
- exports.DEFAULT_CONFIG_FILE_NAME = 'docusaurus.config.js';
16
- exports.BABEL_CONFIG_FILE_NAME = process.env.DOCUSAURUS_BABEL_CONFIG_FILE_NAME || 'babel.config.js';
17
- exports.GENERATED_FILES_DIR_NAME = process.env.DOCUSAURUS_GENERATED_FILES_DIR_NAME || '.docusaurus';
18
- exports.SRC_DIR_NAME = 'src';
19
- exports.STATIC_DIR_NAME = 'static';
20
- exports.OUTPUT_STATIC_ASSETS_DIR_NAME = 'assets'; // files handled by webpack, hashed (can be cached aggressively)
21
- exports.THEME_PATH = `${exports.SRC_DIR_NAME}/theme`;
22
- exports.DEFAULT_PORT = 3000;
23
- exports.DEFAULT_PLUGIN_ID = 'default';
@@ -1,14 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- function loadClientModules(plugins) {
10
- return [].concat(...plugins
11
- .map((plugin) => { var _a, _b; return (_b = (_a = plugin.getClientModules) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : []; })
12
- .filter(Boolean));
13
- }
14
- exports.default = loadClientModules;
@@ -1,10 +0,0 @@
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
- */
7
- import { ReportingSeverity, RouteConfig } from '@docusaurus/types';
8
- export declare function getAllDuplicateRoutes(pluginsRouteConfigs: RouteConfig[]): string[];
9
- export declare function getDuplicateRoutesMessage(allDuplicateRoutes: string[]): string;
10
- export declare function handleDuplicateRoutes(pluginsRouteConfigs: RouteConfig[], onDuplicateRoutes: ReportingSeverity): void;
@@ -1,38 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.handleDuplicateRoutes = exports.getDuplicateRoutesMessage = exports.getAllDuplicateRoutes = void 0;
4
- const utils_1 = require("@docusaurus/utils");
5
- const utils_2 = require("./utils");
6
- function getAllDuplicateRoutes(pluginsRouteConfigs) {
7
- const allRoutes = utils_2.getAllFinalRoutes(pluginsRouteConfigs).map((routeConfig) => routeConfig.path);
8
- const seenRoutes = {};
9
- return allRoutes.filter((route) => {
10
- if (Object.prototype.hasOwnProperty.call(seenRoutes, route)) {
11
- return true;
12
- }
13
- else {
14
- seenRoutes[route] = true;
15
- return false;
16
- }
17
- });
18
- }
19
- exports.getAllDuplicateRoutes = getAllDuplicateRoutes;
20
- function getDuplicateRoutesMessage(allDuplicateRoutes) {
21
- const message = allDuplicateRoutes
22
- .map((duplicateRoute) => `Attempting to create page at ${duplicateRoute}, but a page already exists at this route`)
23
- .join('\n');
24
- return message;
25
- }
26
- exports.getDuplicateRoutesMessage = getDuplicateRoutesMessage;
27
- function handleDuplicateRoutes(pluginsRouteConfigs, onDuplicateRoutes) {
28
- if (onDuplicateRoutes === 'ignore') {
29
- return;
30
- }
31
- const duplicatePaths = getAllDuplicateRoutes(pluginsRouteConfigs);
32
- const message = getDuplicateRoutesMessage(duplicatePaths);
33
- if (message) {
34
- const finalMessage = `Duplicate routes found!\n${message}\nThis could lead to non-deterministic routing behavior`;
35
- utils_1.reportMessage(finalMessage, onDuplicateRoutes);
36
- }
37
- }
38
- exports.handleDuplicateRoutes = handleDuplicateRoutes;
@@ -1,39 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- const tslib_1 = require("tslib");
10
- const lodash_1 = require("lodash");
11
- const html_tags_1 = tslib_1.__importDefault(require("html-tags"));
12
- const void_1 = tslib_1.__importDefault(require("html-tags/void"));
13
- function assertIsHtmlTagObject(val) {
14
- if (!lodash_1.isPlainObject(val)) {
15
- throw new Error(`"${val}" is not a valid HTML tag object`);
16
- }
17
- // @ts-expect-error: If tagName doesn't exist, it will throw.
18
- if (typeof val.tagName !== 'string') {
19
- throw new Error(`${JSON.stringify(val)} is not a valid HTML tag object. "tagName" must be defined as a string`);
20
- }
21
- }
22
- function htmlTagObjectToString(tagDefinition) {
23
- assertIsHtmlTagObject(tagDefinition);
24
- if (html_tags_1.default.indexOf(tagDefinition.tagName) === -1) {
25
- throw new Error(`Error loading ${JSON.stringify(tagDefinition)}, "${tagDefinition.tagName}" is not a valid HTML tags`);
26
- }
27
- const isVoidTag = void_1.default.indexOf(tagDefinition.tagName) !== -1;
28
- const tagAttributes = tagDefinition.attributes || {};
29
- const attributes = Object.keys(tagAttributes)
30
- .filter((attributeName) => tagAttributes[attributeName] !== false)
31
- .map((attributeName) => {
32
- if (tagAttributes[attributeName] === true) {
33
- return attributeName;
34
- }
35
- return `${attributeName}="${tagAttributes[attributeName]}"`;
36
- });
37
- return `<${[tagDefinition.tagName].concat(attributes).join(' ')}>${(!isVoidTag && tagDefinition.innerHTML) || ''}${isVoidTag ? '' : `</${tagDefinition.tagName}>`}`;
38
- }
39
- exports.default = htmlTagObjectToString;
@@ -1,9 +0,0 @@
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
- */
7
- import { Plugin, InjectedHtmlTags, HtmlTags } from '@docusaurus/types';
8
- export declare function createHtmlTagsString(tags: HtmlTags): string;
9
- export declare function loadHtmlTags(plugins: Plugin<unknown>[]): InjectedHtmlTags;
@@ -1,43 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.loadHtmlTags = exports.createHtmlTagsString = void 0;
10
- const tslib_1 = require("tslib");
11
- const htmlTags_1 = tslib_1.__importDefault(require("./htmlTags"));
12
- function toString(val) {
13
- return typeof val === 'string' ? val : htmlTags_1.default(val);
14
- }
15
- function createHtmlTagsString(tags) {
16
- return Array.isArray(tags) ? tags.map(toString).join('\n') : toString(tags);
17
- }
18
- exports.createHtmlTagsString = createHtmlTagsString;
19
- function loadHtmlTags(plugins) {
20
- const htmlTags = plugins.reduce((acc, plugin) => {
21
- if (!plugin.injectHtmlTags) {
22
- return acc;
23
- }
24
- const { headTags, preBodyTags, postBodyTags } = plugin.injectHtmlTags() || {};
25
- return {
26
- headTags: headTags
27
- ? `${acc.headTags}\n${createHtmlTagsString(headTags)}`
28
- : acc.headTags,
29
- preBodyTags: preBodyTags
30
- ? `${acc.preBodyTags}\n${createHtmlTagsString(preBodyTags)}`
31
- : acc.preBodyTags,
32
- postBodyTags: postBodyTags
33
- ? `${acc.postBodyTags}\n${createHtmlTagsString(postBodyTags)}`
34
- : acc.postBodyTags,
35
- };
36
- }, { headTags: '', preBodyTags: '', postBodyTags: '' });
37
- return {
38
- headTags: htmlTags.headTags.trim(),
39
- preBodyTags: htmlTags.preBodyTags.trim(),
40
- postBodyTags: htmlTags.postBodyTags.trim(),
41
- };
42
- }
43
- exports.loadHtmlTags = loadHtmlTags;
@@ -1,9 +0,0 @@
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
- */
7
- import { Props } from '@docusaurus/types';
8
- declare const loadSetup: (name: string) => Promise<Props>;
9
- export default loadSetup;
@@ -1,25 +0,0 @@
1
- "use strict";
2
- /**
3
- * Copyright (c) Facebook, Inc. and its affiliates.
4
- *
5
- * This source code is licensed under the MIT license found in the
6
- * LICENSE file in the root directory of this source tree.
7
- */
8
- Object.defineProperty(exports, "__esModule", { value: true });
9
- const tslib_1 = require("tslib");
10
- const path_1 = tslib_1.__importDefault(require("path"));
11
- const index_1 = require("./index");
12
- // Helper methods to setup dummy/fake projects.
13
- const loadSetup = async (name) => {
14
- const fixtures = path_1.default.join(__dirname, '__tests__', '__fixtures__');
15
- const simpleSite = path_1.default.join(fixtures, 'simple-site');
16
- const customSite = path_1.default.join(fixtures, 'custom-site');
17
- switch (name) {
18
- case 'custom':
19
- return index_1.load(customSite);
20
- case 'simple':
21
- default:
22
- return index_1.load(simpleSite);
23
- }
24
- };
25
- exports.default = loadSetup;
@@ -1,11 +0,0 @@
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
- */
7
- import { LoadContext, PluginConfig } from '@docusaurus/types';
8
- export default function loadPresets(context: LoadContext): {
9
- plugins: PluginConfig[];
10
- themes: PluginConfig[];
11
- };