@docusaurus/core 2.0.0-beta.1ec2c95e3 → 2.0.0-beta.21

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/bin/beforeCli.mjs +140 -0
  2. package/bin/docusaurus.mjs +236 -0
  3. package/lib/babel/preset.d.ts +8 -3
  4. package/lib/babel/preset.js +10 -8
  5. package/lib/client/.eslintrc.js +2 -4
  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} +24 -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 +41 -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 -8
  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 +36 -0
  32. package/lib/client/exports/Head.d.ts +2 -3
  33. package/lib/client/exports/Head.js +3 -4
  34. package/lib/client/exports/Interpolate.d.ts +2 -2
  35. package/lib/client/exports/Interpolate.js +20 -49
  36. package/lib/client/exports/Link.d.ts +4 -10
  37. package/lib/client/exports/Link.js +38 -38
  38. package/lib/client/exports/Translate.d.ts +1 -1
  39. package/lib/client/exports/Translate.js +14 -9
  40. package/lib/client/exports/constants.js +1 -11
  41. package/lib/client/exports/isInternalUrl.js +1 -1
  42. package/lib/client/exports/renderRoutes.d.ts +1 -2
  43. package/lib/client/exports/renderRoutes.js +1 -2
  44. package/lib/client/exports/router.d.ts +1 -1
  45. package/lib/client/exports/router.js +1 -1
  46. package/lib/client/exports/useBaseUrl.js +11 -14
  47. package/lib/client/exports/useDocusaurusContext.d.ts +2 -3
  48. package/lib/client/exports/useDocusaurusContext.js +3 -9
  49. package/lib/client/exports/useGlobalData.d.ts +4 -3
  50. package/lib/client/exports/useGlobalData.js +6 -13
  51. package/lib/{server/versions/__tests/index.test.d.ts → client/exports/useIsBrowser.d.ts} +1 -1
  52. package/lib/client/exports/useIsBrowser.js +11 -0
  53. package/lib/client/exports/useRouteContext.d.ts +8 -0
  54. package/lib/client/exports/useRouteContext.js +15 -0
  55. package/lib/client/flat.d.ts +12 -2
  56. package/lib/client/flat.js +19 -15
  57. package/lib/client/normalizeLocation.d.ts +2 -5
  58. package/lib/client/normalizeLocation.js +14 -10
  59. package/lib/client/prefetch.d.ts +1 -2
  60. package/lib/client/prefetch.js +12 -32
  61. package/lib/client/preload.d.ts +3 -4
  62. package/lib/client/preload.js +5 -12
  63. package/lib/client/routeContext.d.ts +13 -0
  64. package/lib/client/routeContext.js +31 -0
  65. package/lib/client/serverEntry.d.ts +10 -0
  66. package/lib/client/serverEntry.js +105 -146
  67. package/lib/client/theme-fallback/Error/index.d.ts +10 -0
  68. package/lib/client/theme-fallback/Error/index.js +45 -0
  69. package/lib/client/theme-fallback/Layout/index.d.ts +10 -0
  70. package/lib/client/theme-fallback/Layout/index.js +2 -26
  71. package/lib/client/theme-fallback/Loading/index.d.ts +9 -0
  72. package/lib/client/theme-fallback/Loading/index.js +50 -116
  73. package/lib/client/{exports/context.js → theme-fallback/NotFound/index.d.ts} +2 -2
  74. package/lib/client/theme-fallback/NotFound/index.js +19 -18
  75. package/lib/client/theme-fallback/Root/index.d.ts +10 -0
  76. package/lib/client/theme-fallback/Root/index.js +2 -6
  77. package/lib/{server/html-tags/htmlTags.d.ts → client/theme-fallback/SiteMetadata/index.d.ts} +2 -1
  78. package/lib/client/theme-fallback/SiteMetadata/index.js +10 -0
  79. package/lib/commands/build.d.ts +6 -2
  80. package/lib/commands/build.js +80 -64
  81. package/lib/commands/clear.d.ts +7 -1
  82. package/lib/commands/clear.js +32 -20
  83. package/lib/commands/deploy.d.ts +5 -2
  84. package/lib/commands/deploy.js +93 -81
  85. package/lib/commands/external.d.ts +2 -2
  86. package/lib/commands/external.js +6 -11
  87. package/lib/commands/serve.d.ts +8 -2
  88. package/lib/commands/serve.js +26 -27
  89. package/lib/commands/start.d.ts +9 -2
  90. package/lib/commands/start.js +106 -92
  91. package/lib/commands/swizzle/actions.d.ts +23 -0
  92. package/lib/commands/swizzle/actions.js +100 -0
  93. package/lib/commands/swizzle/common.d.ts +33 -0
  94. package/lib/commands/swizzle/common.js +56 -0
  95. package/lib/commands/swizzle/components.d.ts +29 -0
  96. package/lib/commands/swizzle/components.js +200 -0
  97. package/lib/commands/swizzle/config.d.ts +10 -0
  98. package/lib/commands/swizzle/config.js +84 -0
  99. package/lib/{server/client-modules/index.d.ts → commands/swizzle/context.d.ts} +2 -2
  100. package/lib/commands/swizzle/context.js +24 -0
  101. package/lib/commands/swizzle/index.d.ts +8 -0
  102. package/lib/commands/swizzle/index.js +116 -0
  103. package/lib/commands/swizzle/prompts.d.ts +12 -0
  104. package/lib/commands/swizzle/prompts.js +110 -0
  105. package/lib/{client/exports/context.d.ts → commands/swizzle/tables.d.ts} +3 -4
  106. package/lib/commands/swizzle/tables.js +113 -0
  107. package/lib/commands/swizzle/themes.d.ts +20 -0
  108. package/lib/commands/swizzle/themes.js +106 -0
  109. package/lib/commands/writeHeadingIds.d.ts +2 -6
  110. package/lib/commands/writeHeadingIds.js +21 -81
  111. package/lib/commands/writeTranslations.d.ts +4 -5
  112. package/lib/commands/writeTranslations.js +39 -20
  113. package/lib/index.d.ts +9 -9
  114. package/lib/index.js +14 -14
  115. package/lib/server/brokenLinks.d.ts +4 -17
  116. package/lib/server/brokenLinks.js +67 -56
  117. package/lib/server/clientModules.d.ts +12 -0
  118. package/lib/server/clientModules.js +20 -0
  119. package/lib/server/config.d.ts +5 -2
  120. package/lib/server/config.js +29 -6
  121. package/lib/server/configValidation.d.ts +4 -4
  122. package/lib/server/configValidation.js +80 -38
  123. package/lib/server/getHostPort.d.ts +14 -0
  124. package/lib/server/getHostPort.js +79 -0
  125. package/lib/server/htmlTags.d.ts +12 -0
  126. package/lib/server/htmlTags.js +62 -0
  127. package/lib/server/i18n.d.ts +3 -13
  128. package/lib/server/i18n.js +19 -55
  129. package/lib/server/index.d.ts +28 -13
  130. package/lib/server/index.js +79 -163
  131. package/lib/server/plugins/configs.d.ts +51 -0
  132. package/lib/server/plugins/configs.js +101 -0
  133. package/lib/server/plugins/index.d.ts +9 -8
  134. package/lib/server/plugins/index.js +72 -135
  135. package/lib/server/plugins/init.d.ts +6 -5
  136. package/lib/server/plugins/init.js +44 -109
  137. package/lib/server/plugins/moduleShorthand.d.ts +9 -0
  138. package/lib/server/plugins/moduleShorthand.js +46 -0
  139. package/lib/server/plugins/pluginIds.d.ts +5 -1
  140. package/lib/server/plugins/pluginIds.js +12 -7
  141. package/lib/server/plugins/presets.d.ts +12 -0
  142. package/lib/server/plugins/presets.js +49 -0
  143. package/lib/server/plugins/routeConfig.d.ts +11 -0
  144. package/lib/server/plugins/routeConfig.js +54 -0
  145. package/lib/server/plugins/synthetic.d.ts +20 -0
  146. package/lib/server/plugins/synthetic.js +112 -0
  147. package/lib/server/routes.d.ts +39 -7
  148. package/lib/server/routes.js +185 -95
  149. package/lib/server/siteMetadata.d.ts +12 -0
  150. package/lib/server/siteMetadata.js +81 -0
  151. package/lib/server/translations/translations.d.ts +11 -14
  152. package/lib/server/translations/translations.js +36 -60
  153. package/lib/server/translations/translationsExtractor.d.ts +10 -4
  154. package/lib/server/translations/translationsExtractor.js +158 -122
  155. package/lib/server/utils.d.ts +9 -3
  156. package/lib/server/utils.js +7 -9
  157. package/lib/webpack/aliases/index.d.ts +34 -0
  158. package/lib/webpack/aliases/index.js +106 -0
  159. package/lib/webpack/base.d.ts +3 -4
  160. package/lib/webpack/base.js +45 -57
  161. package/lib/webpack/client.d.ts +3 -3
  162. package/lib/webpack/client.js +12 -19
  163. package/lib/webpack/plugins/ChunkAssetPlugin.d.ts +13 -3
  164. package/lib/webpack/plugins/ChunkAssetPlugin.js +24 -17
  165. package/lib/webpack/plugins/CleanWebpackPlugin.d.ts +6 -25
  166. package/lib/webpack/plugins/CleanWebpackPlugin.js +33 -17
  167. package/lib/webpack/plugins/LogPlugin.d.ts +1 -1
  168. package/lib/webpack/plugins/LogPlugin.js +4 -5
  169. package/lib/webpack/plugins/WaitPlugin.d.ts +3 -3
  170. package/lib/webpack/plugins/WaitPlugin.js +1 -1
  171. package/lib/webpack/server.d.ts +5 -5
  172. package/lib/webpack/server.js +16 -12
  173. package/lib/{client → webpack}/templates/index.html.template.ejs +0 -0
  174. package/lib/webpack/templates/ssr.html.template.d.ts +8 -0
  175. package/lib/{client → webpack}/templates/ssr.html.template.js +3 -2
  176. package/lib/webpack/utils.d.ts +15 -31
  177. package/lib/webpack/utils.js +61 -182
  178. package/package.json +82 -77
  179. package/bin/docusaurus.js +0 -325
  180. package/lib/.tsbuildinfo +0 -1
  181. package/lib/choosePort.js +0 -105
  182. package/lib/client/.tsbuildinfo +0 -1
  183. package/lib/client/client-lifecycles-dispatcher.d.ts +0 -12
  184. package/lib/client/client-lifecycles-dispatcher.js +0 -27
  185. package/lib/client/nprogress.css +0 -36
  186. package/lib/commands/buildRemoteBranchUrl.d.ts +0 -7
  187. package/lib/commands/buildRemoteBranchUrl.js +0 -27
  188. package/lib/commands/commandUtils.d.ts +0 -3
  189. package/lib/commands/commandUtils.js +0 -21
  190. package/lib/commands/swizzle.d.ts +0 -9
  191. package/lib/commands/swizzle.js +0 -245
  192. package/lib/constants.d.ts +0 -18
  193. package/lib/constants.js +0 -23
  194. package/lib/server/client-modules/index.js +0 -14
  195. package/lib/server/duplicateRoutes.d.ts +0 -10
  196. package/lib/server/duplicateRoutes.js +0 -38
  197. package/lib/server/html-tags/htmlTags.js +0 -40
  198. package/lib/server/html-tags/index.d.ts +0 -9
  199. package/lib/server/html-tags/index.js +0 -43
  200. package/lib/server/loadSetup.d.ts +0 -9
  201. package/lib/server/loadSetup.js +0 -25
  202. package/lib/server/plugins/applyRouteTrailingSlash.d.ts +0 -9
  203. package/lib/server/plugins/applyRouteTrailingSlash.js +0 -19
  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 -40
  208. package/lib/server/themes/index.d.ts +0 -12
  209. package/lib/server/themes/index.js +0 -47
  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
package/lib/client/theme-fallback/Root/index.js CHANGED
@@ -4,9 +4,7 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
-
8
7
  import React from 'react';
9
-
10
8
  // Wrapper at the very top of the app, that is applied constantly
11
9
  // and does not depend on current route (unlike the layout)
12
10
  //
@@ -14,8 +12,6 @@ import React from 'react';
14
12
  // and these providers won't reset state when we navigate
15
13
  //
16
14
  // See https://github.com/facebook/docusaurus/issues/3919
17
- function Root({children}) {
18
- return <>{children}</>;
15
+ export default function Root({ children }) {
16
+ return <>{children}</>;
19
17
  }
20
-
21
- export default Root;
package/lib/{server/html-tags/htmlTags.d.ts → client/theme-fallback/SiteMetadata/index.d.ts} RENAMED
@@ -4,4 +4,5 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- export default function htmlTagObjectToString(tagDefinition: unknown): string;
7
+ /// <reference types="react" />
8
+ export default function SiteMetadata(): JSX.Element | null;
package/lib/client/theme-fallback/SiteMetadata/index.js ADDED
@@ -0,0 +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
+ */
7
+ // To be implemented by the theme with <Head>
8
+ export default function SiteMetadata() {
9
+ return null;
10
+ }
package/lib/commands/build.d.ts CHANGED
@@ -4,5 +4,9 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import { BuildCLIOptions } from '@docusaurus/types';
8
- export default function build(siteDir: string, cliOptions?: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;
7
+ import { type LoadContextOptions } from '../server';
8
+ export declare type BuildCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
9
+ bundleAnalyzer?: boolean;
10
+ minify?: boolean;
11
+ };
12
+ export declare function build(siteDir: string, cliOptions: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;
package/lib/commands/build.js CHANGED
@@ -6,29 +6,34 @@
6
6
  * LICENSE file in the root directory of this source tree.
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.build = void 0;
9
10
  const tslib_1 = require("tslib");
10
- const chalk_1 = tslib_1.__importDefault(require("chalk"));
11
- const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
12
11
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
13
12
  const path_1 = tslib_1.__importDefault(require("path"));
13
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
+ const utils_1 = require("@docusaurus/utils");
15
+ const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
14
16
  const react_loadable_ssr_addon_v5_slorber_1 = tslib_1.__importDefault(require("react-loadable-ssr-addon-v5-slorber"));
15
17
  const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
16
18
  const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
17
- const constants_1 = require("../constants");
18
19
  const server_1 = require("../server");
19
20
  const brokenLinks_1 = require("../server/brokenLinks");
20
21
  const client_1 = tslib_1.__importDefault(require("../webpack/client"));
21
22
  const server_2 = tslib_1.__importDefault(require("../webpack/server"));
22
- const utils_1 = require("../webpack/utils");
23
+ const utils_2 = require("../webpack/utils");
23
24
  const CleanWebpackPlugin_1 = tslib_1.__importDefault(require("../webpack/plugins/CleanWebpackPlugin"));
24
25
  const i18n_1 = require("../server/i18n");
25
- const utils_2 = require("@docusaurus/utils");
26
- async function build(siteDir, cliOptions = {},
27
- // TODO what's the purpose of this arg ?
26
+ async function build(siteDir, cliOptions,
27
+ // When running build, we force terminate the process to prevent async
28
+ // operations from never returning. However, if run as part of docusaurus
29
+ // deploy, we have to let deploy finish.
30
+ // See https://github.com/facebook/docusaurus/pull/2496
28
31
  forceTerminate = true) {
32
+ ['SIGINT', 'SIGTERM'].forEach((sig) => {
33
+ process.on(sig, () => process.exit());
34
+ });
29
35
  async function tryToBuildLocale({ locale, isLastLocale, }) {
30
36
  try {
31
- // console.log(chalk.green(`Site successfully built in locale=${locale}`));
32
37
  return await buildLocale({
33
38
  siteDir,
34
39
  locale,
@@ -37,101 +42,110 @@ forceTerminate = true) {
37
42
  isLastLocale,
38
43
  });
39
44
  }
40
- catch (e) {
41
- console.error(`Unable to build website for locale "${locale}".`);
42
- throw e;
45
+ catch (err) {
46
+ logger_1.default.error `Unable to build website for locale name=${locale}.`;
47
+ throw err;
43
48
  }
44
49
  }
45
- const context = await server_1.loadContext(siteDir, {
46
- customOutDir: cliOptions.outDir,
47
- customConfigFilePath: cliOptions.config,
50
+ const context = await (0, server_1.loadContext)({
51
+ siteDir,
52
+ outDir: cliOptions.outDir,
53
+ config: cliOptions.config,
48
54
  locale: cliOptions.locale,
49
55
  localizePath: cliOptions.locale ? false : undefined,
50
56
  });
51
- const i18n = await i18n_1.loadI18n(context.siteConfig, {
57
+ const i18n = await (0, i18n_1.loadI18n)(context.siteConfig, {
52
58
  locale: cliOptions.locale,
53
59
  });
54
60
  if (cliOptions.locale) {
55
61
  return tryToBuildLocale({ locale: cliOptions.locale, isLastLocale: true });
56
62
  }
57
- else {
58
- if (i18n.locales.length > 1) {
59
- console.log(chalk_1.default.yellow(`\nWebsite will be built for all these locales:
60
- - ${i18n.locales.join('\n- ')}`));
61
- }
62
- // We need the default locale to always be the 1st in the list
63
- // If we build it last, it would "erase" the localized sites built in subfolders
64
- const orderedLocales = [
65
- i18n.defaultLocale,
66
- ...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
67
- ];
68
- const results = await utils_2.mapAsyncSequencial(orderedLocales, (locale) => {
69
- const isLastLocale = orderedLocales.indexOf(locale) === orderedLocales.length - 1;
70
- return tryToBuildLocale({ locale, isLastLocale });
71
- });
72
- return results[0];
63
+ if (i18n.locales.length > 1) {
64
+ logger_1.default.info `Website will be built for all these locales: ${i18n.locales}`;
73
65
  }
66
+ // We need the default locale to always be the 1st in the list. If we build it
67
+ // last, it would "erase" the localized sites built in sub-folders
68
+ const orderedLocales = [
69
+ i18n.defaultLocale,
70
+ ...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
71
+ ];
72
+ const results = await (0, utils_1.mapAsyncSequential)(orderedLocales, (locale) => {
73
+ const isLastLocale = orderedLocales.indexOf(locale) === orderedLocales.length - 1;
74
+ return tryToBuildLocale({ locale, isLastLocale });
75
+ });
76
+ return results[0];
74
77
  }
75
- exports.default = build;
78
+ exports.build = build;
76
79
  async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLastLocale, }) {
77
80
  process.env.BABEL_ENV = 'production';
78
81
  process.env.NODE_ENV = 'production';
79
- console.log(chalk_1.default.blue(`\n[${locale}] Creating an optimized production build...`));
80
- const props = await server_1.load(siteDir, {
81
- customOutDir: cliOptions.outDir,
82
- customConfigFilePath: cliOptions.config,
82
+ logger_1.default.info `name=${`[${locale}]`} Creating an optimized production build...`;
83
+ const props = await (0, server_1.load)({
84
+ siteDir,
85
+ outDir: cliOptions.outDir,
86
+ config: cliOptions.config,
83
87
  locale,
84
88
  localizePath: cliOptions.locale ? false : undefined,
85
89
  });
86
90
  // Apply user webpack config.
87
- const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks }, routes, } = props;
91
+ const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks, staticDirectories: staticDirectoriesOption, }, routes, } = props;
88
92
  const clientManifestPath = path_1.default.join(generatedFilesDir, 'client-manifest.json');
89
- let clientConfig = webpack_merge_1.default(client_1.default(props, cliOptions.minify), {
93
+ let clientConfig = (0, webpack_merge_1.default)(await (0, client_1.default)(props, cliOptions.minify), {
90
94
  plugins: [
91
95
  // Remove/clean build folders before building bundles.
92
96
  new CleanWebpackPlugin_1.default({ verbose: false }),
93
- // Visualize size of webpack output files with an interactive zoomable treemap.
97
+ // Visualize size of webpack output files with an interactive zoomable
98
+ // tree map.
94
99
  cliOptions.bundleAnalyzer && new webpack_bundle_analyzer_1.BundleAnalyzerPlugin(),
95
100
  // Generate client manifests file that will be used for server bundle.
96
101
  new react_loadable_ssr_addon_v5_slorber_1.default({
97
102
  filename: clientManifestPath,
98
103
  }),
99
- ].filter(Boolean),
104
+ ].filter((x) => Boolean(x)),
100
105
  });
101
106
  const allCollectedLinks = {};
102
- let serverConfig = server_2.default({
107
+ const headTags = {};
108
+ let serverConfig = await (0, server_2.default)({
103
109
  props,
104
110
  onLinksCollected: (staticPagePath, links) => {
105
111
  allCollectedLinks[staticPagePath] = links;
106
112
  },
113
+ onHeadTagsCollected: (staticPagePath, tags) => {
114
+ headTags[staticPagePath] = tags;
115
+ },
107
116
  });
108
- const staticDir = path_1.default.resolve(siteDir, constants_1.STATIC_DIR_NAME);
109
- if (await fs_extra_1.default.pathExists(staticDir)) {
110
- serverConfig = webpack_merge_1.default(serverConfig, {
117
+ // The staticDirectories option can contain empty directories, or non-existent
118
+ // directories (e.g. user deleted `static`). Instead of issuing an error, we
119
+ // just silently filter them out, because user could have never configured it
120
+ // in the first place (the default option should always "work").
121
+ const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
122
+ const staticDir = path_1.default.resolve(siteDir, dir);
123
+ if ((await fs_extra_1.default.pathExists(staticDir)) &&
124
+ (await fs_extra_1.default.readdir(staticDir)).length > 0) {
125
+ return staticDir;
126
+ }
127
+ return '';
128
+ }))).filter(Boolean);
129
+ if (staticDirectories.length > 0) {
130
+ serverConfig = (0, webpack_merge_1.default)(serverConfig, {
111
131
  plugins: [
112
132
  new copy_webpack_plugin_1.default({
113
- patterns: [
114
- {
115
- from: staticDir,
116
- to: outDir,
117
- },
118
- ],
133
+ patterns: staticDirectories.map((dir) => ({ from: dir, to: outDir })),
119
134
  }),
120
135
  ],
121
136
  });
122
137
  }
123
138
  // Plugin Lifecycle - configureWebpack and configurePostCss.
124
139
  plugins.forEach((plugin) => {
125
- var _a, _b;
126
140
  const { configureWebpack, configurePostCss } = plugin;
127
141
  if (configurePostCss) {
128
- clientConfig = utils_1.applyConfigurePostCss(configurePostCss, clientConfig);
142
+ clientConfig = (0, utils_2.applyConfigurePostCss)(configurePostCss.bind(plugin), clientConfig);
129
143
  }
130
144
  if (configureWebpack) {
131
- clientConfig = utils_1.applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
132
- clientConfig, false, (_a = props.siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader, plugin.content);
133
- serverConfig = utils_1.applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
134
- serverConfig, true, (_b = props.siteConfig.webpack) === null || _b === void 0 ? void 0 : _b.jsLoader, plugin.content);
145
+ clientConfig = (0, utils_2.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
146
+ clientConfig, false, props.siteConfig.webpack?.jsLoader, plugin.content);
147
+ serverConfig = (0, utils_2.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
148
+ serverConfig, true, props.siteConfig.webpack?.jsLoader, plugin.content);
135
149
  }
136
150
  });
137
151
  // Make sure generated client-manifest is cleaned first so we don't reuse
@@ -140,11 +154,9 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
140
154
  await fs_extra_1.default.unlink(clientManifestPath);
141
155
  }
142
156
  // Run webpack to build JS bundle (client) and static html files (server).
143
- await utils_1.compile([clientConfig, serverConfig]);
157
+ await (0, utils_2.compile)([clientConfig, serverConfig]);
144
158
  // Remove server.bundle.js because it is not needed.
145
- if (serverConfig.output &&
146
- serverConfig.output.filename &&
147
- typeof serverConfig.output.filename === 'string') {
159
+ if (typeof serverConfig.output?.filename === 'string') {
148
160
  const serverBundle = path_1.default.join(outDir, serverConfig.output.filename);
149
161
  if (await fs_extra_1.default.pathExists(serverBundle)) {
150
162
  await fs_extra_1.default.unlink(serverBundle);
@@ -155,18 +167,22 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
155
167
  if (!plugin.postBuild) {
156
168
  return;
157
169
  }
158
- await plugin.postBuild(props);
170
+ await plugin.postBuild({
171
+ ...props,
172
+ head: headTags,
173
+ content: plugin.content,
174
+ });
159
175
  }));
160
- await brokenLinks_1.handleBrokenLinks({
176
+ await (0, brokenLinks_1.handleBrokenLinks)({
161
177
  allCollectedLinks,
162
178
  routes,
163
179
  onBrokenLinks,
164
180
  outDir,
165
181
  baseUrl,
166
182
  });
167
- console.log(`${chalk_1.default.green(`Success!`)} Generated static files in "${chalk_1.default.cyan(path_1.default.relative(process.cwd(), outDir))}".`);
183
+ logger_1.default.success `Generated static files in path=${path_1.default.relative(process.cwd(), outDir)}.`;
168
184
  if (isLastLocale) {
169
- console.log(`\nUse ${chalk_1.default.greenBright('`npm run serve`')} command to test your build locally.\n`);
185
+ logger_1.default.info `Use code=${'npm run serve'} command to test your build locally.`;
170
186
  }
171
187
  if (forceTerminate && isLastLocale && !cliOptions.bundleAnalyzer) {
172
188
  process.exit(0);
package/lib/commands/clear.d.ts CHANGED
@@ -1 +1,7 @@
1
- export default function clear(siteDir: string): Promise<unknown>;
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 clear(siteDir: string): Promise<void>;
package/lib/commands/clear.js CHANGED
@@ -1,32 +1,44 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
2
  /**
5
3
  * Copyright (c) Facebook, Inc. and its affiliates.
6
4
  *
7
5
  * This source code is licensed under the MIT license found in the
8
6
  * LICENSE file in the root directory of this source tree.
9
7
  */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.clear = void 0;
10
+ const tslib_1 = require("tslib");
10
11
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
11
12
  const path_1 = tslib_1.__importDefault(require("path"));
12
- const chalk = require("chalk");
13
- const constants_1 = require("../constants");
14
- function removePath(fsPath) {
15
- return fs_extra_1.default
16
- .remove(path_1.default.join(fsPath))
17
- .then(() => {
18
- console.log(chalk.green(`Successfully removed "${fsPath}" directory.`));
19
- })
20
- .catch((err) => {
21
- console.error(`Could not remove ${fsPath} directory.`);
22
- console.error(err);
23
- });
13
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
+ const utils_1 = require("@docusaurus/utils");
15
+ async function removePath(entry) {
16
+ if (!(await fs_extra_1.default.pathExists(entry.path))) {
17
+ return;
18
+ }
19
+ try {
20
+ await fs_extra_1.default.remove(entry.path);
21
+ logger_1.default.success `Removed the ${entry.description} at path=${entry.path}.`;
22
+ }
23
+ catch (err) {
24
+ logger_1.default.error `Could not remove the ${entry.description} at path=${entry.path}.`;
25
+ logger_1.default.error(err);
26
+ }
24
27
  }
25
28
  async function clear(siteDir) {
26
- return Promise.all([
27
- removePath(path_1.default.join(siteDir, constants_1.GENERATED_FILES_DIR_NAME)),
28
- removePath(path_1.default.join(siteDir, constants_1.DEFAULT_BUILD_DIR_NAME)),
29
- removePath(path_1.default.join(siteDir, 'node_modules', '.cache')),
30
- ]);
29
+ const generatedFolder = {
30
+ path: path_1.default.join(siteDir, utils_1.GENERATED_FILES_DIR_NAME),
31
+ description: 'generated folder',
32
+ };
33
+ const buildFolder = {
34
+ path: path_1.default.join(siteDir, utils_1.DEFAULT_BUILD_DIR_NAME),
35
+ description: 'build output folder',
36
+ };
37
+ // In Yarn PnP, cache is stored in `.yarn/.cache` because n_m doesn't exist
38
+ const cacheFolders = ['node_modules', '.yarn'].map((p) => ({
39
+ path: path_1.default.join(siteDir, p, '.cache'),
40
+ description: 'Webpack persistent cache folder',
41
+ }));
42
+ await Promise.all([generatedFolder, buildFolder, ...cacheFolders].map(removePath));
31
43
  }
32
- exports.default = clear;
44
+ exports.clear = clear;
package/lib/commands/deploy.d.ts CHANGED
@@ -4,5 +4,8 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import { BuildCLIOptions } from '@docusaurus/types';
8
- export default function deploy(siteDir: string, cliOptions?: Partial<BuildCLIOptions>): Promise<void>;
7
+ import { type LoadContextOptions } from '../server';
8
+ export declare type DeployCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
9
+ skipBuild?: boolean;
10
+ };
11
+ export declare function deploy(siteDir: string, cliOptions: Partial<DeployCLIOptions>): Promise<void>;
package/lib/commands/deploy.js CHANGED
@@ -6,15 +6,16 @@
6
6
  * LICENSE file in the root directory of this source tree.
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.deploy = void 0;
9
10
  const tslib_1 = require("tslib");
10
11
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
11
- const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
12
- const chalk_1 = tslib_1.__importDefault(require("chalk"));
13
- const server_1 = require("../server");
14
- const build_1 = tslib_1.__importDefault(require("./build"));
15
12
  const path_1 = tslib_1.__importDefault(require("path"));
16
13
  const os_1 = tslib_1.__importDefault(require("os"));
17
- const buildRemoteBranchUrl_1 = require("./buildRemoteBranchUrl");
14
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
15
+ const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
16
+ const utils_1 = require("@docusaurus/utils");
17
+ const server_1 = require("../server");
18
+ const build_1 = require("./build");
18
19
  // GIT_PASS env variable should not appear in logs
19
20
  function obfuscateGitPass(str) {
20
21
  const gitPass = process.env.GIT_PASS;
@@ -25,80 +26,101 @@ function obfuscateGitPass(str) {
25
26
  function shellExecLog(cmd) {
26
27
  try {
27
28
  const result = shelljs_1.default.exec(cmd);
28
- console.log(`${chalk_1.default.cyan('CMD:')} ${obfuscateGitPass(cmd)} ${chalk_1.default.cyan(`(code: ${result.code})`)}`);
29
+ logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.code}`}`;
29
30
  return result;
30
31
  }
31
- catch (e) {
32
- console.log(`${chalk_1.default.red('CMD:')} ${obfuscateGitPass(cmd)}`);
33
- throw e;
32
+ catch (err) {
33
+ logger_1.default.error `code=${obfuscateGitPass(cmd)}`;
34
+ throw err;
34
35
  }
35
36
  }
36
- async function deploy(siteDir, cliOptions = {}) {
37
- const { outDir, siteConfig, siteConfigPath } = await server_1.loadContext(siteDir, {
38
- customConfigFilePath: cliOptions.config,
39
- customOutDir: cliOptions.outDir,
37
+ async function deploy(siteDir, cliOptions) {
38
+ const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)({
39
+ siteDir,
40
+ config: cliOptions.config,
41
+ outDir: cliOptions.outDir,
40
42
  });
41
43
  if (typeof siteConfig.trailingSlash === 'undefined') {
42
- console.warn(chalk_1.default.yellow(`
43
- Docusaurus recommendation:
44
- When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
44
+ logger_1.default.warn(`When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
45
45
  Otherwise, GitHub Pages will add an extra trailing slash to your site urls only on direct-access (not when navigation) with a server redirect.
46
46
  This behavior can have SEO impacts and create relative link issues.
47
- `));
47
+ `);
48
48
  }
49
- console.log('Deploy command invoked...');
49
+ logger_1.default.info('Deploy command invoked...');
50
50
  if (!shelljs_1.default.which('git')) {
51
51
  throw new Error('Git not installed or on the PATH!');
52
52
  }
53
+ // Source repo is the repo from where the command is invoked
54
+ const sourceRepoUrl = shelljs_1.default
55
+ .exec('git config --get remote.origin.url', { silent: true })
56
+ .stdout.trim();
57
+ // The source branch; defaults to the currently checked out branch
58
+ const sourceBranch = process.env.CURRENT_BRANCH ??
59
+ shelljs_1.default.exec('git rev-parse --abbrev-ref HEAD', { silent: true }).stdout.trim();
53
60
  const gitUser = process.env.GIT_USER;
54
- if (!gitUser) {
55
- throw new Error('Please set the GIT_USER environment variable!');
61
+ let useSSH = process.env.USE_SSH !== undefined &&
62
+ process.env.USE_SSH.toLowerCase() === 'true';
63
+ if (!gitUser && !useSSH) {
64
+ // If USE_SSH is unspecified: try inferring from repo URL
65
+ if (process.env.USE_SSH === undefined && (0, utils_1.hasSSHProtocol)(sourceRepoUrl)) {
66
+ useSSH = true;
67
+ }
68
+ else {
69
+ throw new Error('Please set the GIT_USER environment variable, or explicitly specify USE_SSH instead!');
70
+ }
56
71
  }
57
- // The branch that contains the latest docs changes that will be deployed.
58
- const currentBranch = process.env.CURRENT_BRANCH ||
59
- shelljs_1.default.exec('git rev-parse --abbrev-ref HEAD').stdout.trim();
60
- const organizationName = process.env.ORGANIZATION_NAME ||
61
- process.env.CIRCLE_PROJECT_USERNAME ||
72
+ const organizationName = process.env.ORGANIZATION_NAME ??
73
+ process.env.CIRCLE_PROJECT_USERNAME ??
62
74
  siteConfig.organizationName;
63
75
  if (!organizationName) {
64
76
  throw new Error(`Missing project organization name. Did you forget to define "organizationName" in ${siteConfigPath}? You may also export it via the ORGANIZATION_NAME environment variable.`);
65
77
  }
66
- console.log(`${chalk_1.default.cyan('organizationName:')} ${organizationName}`);
67
- const projectName = process.env.PROJECT_NAME ||
68
- process.env.CIRCLE_PROJECT_REPONAME ||
78
+ logger_1.default.info `organizationName: name=${organizationName}`;
79
+ const projectName = process.env.PROJECT_NAME ??
80
+ process.env.CIRCLE_PROJECT_REPONAME ??
69
81
  siteConfig.projectName;
70
82
  if (!projectName) {
71
83
  throw new Error(`Missing project name. Did you forget to define "projectName" in ${siteConfigPath}? You may also export it via the PROJECT_NAME environment variable.`);
72
84
  }
73
- console.log(`${chalk_1.default.cyan('projectName:')} ${projectName}`);
85
+ logger_1.default.info `projectName: name=${projectName}`;
74
86
  // We never deploy on pull request.
75
- const isPullRequest = process.env.CI_PULL_REQUEST || process.env.CIRCLE_PULL_REQUEST;
87
+ const isPullRequest = process.env.CI_PULL_REQUEST ?? process.env.CIRCLE_PULL_REQUEST;
76
88
  if (isPullRequest) {
77
89
  shelljs_1.default.echo('Skipping deploy on a pull request.');
78
90
  shelljs_1.default.exit(0);
79
91
  }
80
- // github.io indicates organization repos that deploy via master. All others use gh-pages.
81
- const deploymentBranch = process.env.DEPLOYMENT_BRANCH ||
82
- (projectName.indexOf('.github.io') !== -1 ? 'master' : 'gh-pages');
83
- console.log(`${chalk_1.default.cyan('deploymentBranch:')} ${deploymentBranch}`);
84
- const githubHost = process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';
85
- const githubPort = process.env.GITHUB_PORT || siteConfig.githubPort;
86
- const gitPass = process.env.GIT_PASS;
87
- let gitCredentials = `${gitUser}`;
88
- if (gitPass) {
89
- gitCredentials = `${gitCredentials}:${gitPass}`;
92
+ // github.io indicates organization repos that deploy via default branch. All
93
+ // others use gh-pages (either case can be configured actually, but we can
94
+ // make educated guesses). Organization deploys look like:
95
+ // - Git repo: https://github.com/<organization>/<organization>.github.io
96
+ // - Site url: https://<organization>.github.io
97
+ const isGitHubPagesOrganizationDeploy = projectName.includes('.github.io');
98
+ if (isGitHubPagesOrganizationDeploy &&
99
+ !process.env.DEPLOYMENT_BRANCH &&
100
+ !siteConfig.deploymentBranch) {
101
+ throw new Error(`For GitHub pages organization deployments, 'docusaurus deploy' does not assume anymore that 'master' is your default Git branch.
102
+ Please provide the branch name to deploy to as an environment variable, for example DEPLOYMENT_BRANCH=main or DEPLOYMENT_BRANCH=master .
103
+ You can also set the deploymentBranch property in docusaurus.config.js .`);
104
+ }
105
+ const deploymentBranch = process.env.DEPLOYMENT_BRANCH ?? siteConfig.deploymentBranch ?? 'gh-pages';
106
+ logger_1.default.info `deploymentBranch: name=${deploymentBranch}`;
107
+ const githubHost = process.env.GITHUB_HOST ?? siteConfig.githubHost ?? 'github.com';
108
+ const githubPort = process.env.GITHUB_PORT ?? siteConfig.githubPort;
109
+ let deploymentRepoURL;
110
+ if (useSSH) {
111
+ deploymentRepoURL = (0, utils_1.buildSshUrl)(githubHost, organizationName, projectName, githubPort);
90
112
  }
91
- const useSSH = process.env.USE_SSH;
92
- const remoteBranch = buildRemoteBranchUrl_1.buildUrl(githubHost, githubPort, gitCredentials, organizationName, projectName, useSSH !== undefined && useSSH.toLowerCase() === 'true');
93
- console.log(`${chalk_1.default.cyan('Remote branch:')} ${obfuscateGitPass(remoteBranch)}`);
113
+ else {
114
+ const gitPass = process.env.GIT_PASS;
115
+ const gitCredentials = gitPass ? `${gitUser}:${gitPass}` : gitUser;
116
+ deploymentRepoURL = (0, utils_1.buildHttpsUrl)(gitCredentials, githubHost, organizationName, projectName, githubPort);
117
+ }
118
+ logger_1.default.info `Remote repo URL: name=${obfuscateGitPass(deploymentRepoURL)}`;
94
119
  // Check if this is a cross-repo publish.
95
- const currentRepoUrl = shelljs_1.default
96
- .exec('git config --get remote.origin.url')
97
- .stdout.trim();
98
- const crossRepoPublish = !currentRepoUrl.endsWith(`${organizationName}/${projectName}.git`);
120
+ const crossRepoPublish = !sourceRepoUrl.endsWith(`${organizationName}/${projectName}.git`);
99
121
  // We don't allow deploying to the same branch unless it's a cross publish.
100
- if (currentBranch === deploymentBranch && !crossRepoPublish) {
101
- throw new Error(`You cannot deploy from this branch (${currentBranch}).` +
122
+ if (sourceBranch === deploymentBranch && !crossRepoPublish) {
123
+ throw new Error(`You cannot deploy from this branch (${sourceBranch}).` +
102
124
  '\nYou will need to checkout to a different branch!');
103
125
  }
104
126
  // Save the commit hash that triggers publish-gh-pages before checking
@@ -107,42 +129,32 @@ This behavior can have SEO impacts and create relative link issues.
107
129
  const runDeploy = async (outputDirectory) => {
108
130
  const fromPath = outputDirectory;
109
131
  const toPath = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
110
- if (shellExecLog(`git clone ${remoteBranch} ${toPath}`).code !== 0) {
111
- throw new Error(`Running "git clone" command in "${toPath}" failed.`);
112
- }
113
132
  shelljs_1.default.cd(toPath);
114
- // If the default branch is the one we're deploying to, then we'll fail
115
- // to create it. This is the case of a cross-repo publish, where we clone
116
- // a github.io repo with a default master branch.
117
- const defaultBranch = shelljs_1.default
118
- .exec('git rev-parse --abbrev-ref HEAD')
119
- .stdout.trim();
120
- if (defaultBranch !== deploymentBranch) {
121
- if (shellExecLog(`git checkout origin/${deploymentBranch}`).code !== 0) {
122
- if (shellExecLog(`git checkout --orphan ${deploymentBranch}`).code !== 0) {
123
- throw new Error(`Running "git checkout ${deploymentBranch}" command failed.`);
124
- }
125
- }
126
- else if (shellExecLog(`git checkout -b ${deploymentBranch}`).code +
127
- shellExecLog(`git branch --set-upstream-to=origin/${deploymentBranch}`).code !==
128
- 0) {
129
- throw new Error(`Running "git checkout ${deploymentBranch}" command failed.`);
130
- }
133
+ // Check out deployment branch when cloning repository, and then remove all
134
+ // the files in the directory. If the 'clone' command fails, assume that
135
+ // the deployment branch doesn't exist, and initialize git in an empty
136
+ // directory, check out a clean deployment branch and add remote.
137
+ if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code === 0) {
138
+ shellExecLog('git rm -rf .');
139
+ }
140
+ else {
141
+ shellExecLog('git init');
142
+ shellExecLog(`git checkout -b ${deploymentBranch}`);
143
+ shellExecLog(`git remote add origin ${deploymentRepoURL}`);
131
144
  }
132
- shellExecLog('git rm -rf .');
133
145
  try {
134
146
  await fs_extra_1.default.copy(fromPath, toPath);
135
147
  }
136
- catch (error) {
137
- throw new Error(`Copying build assets from "${fromPath}" to "${toPath}" failed with error "${error}".`);
148
+ catch (err) {
149
+ logger_1.default.error `Copying build assets from path=${fromPath} to path=${toPath} failed.`;
150
+ throw err;
138
151
  }
139
- shelljs_1.default.cd(toPath);
140
152
  shellExecLog('git add --all');
141
- const commitMessage = process.env.CUSTOM_COMMIT_MESSAGE ||
153
+ const commitMessage = process.env.CUSTOM_COMMIT_MESSAGE ??
142
154
  `Deploy website - based on ${currentCommit}`;
143
155
  const commitResults = shellExecLog(`git commit -m "${commitMessage}"`);
144
156
  if (shellExecLog(`git push --force origin ${deploymentBranch}`).code !== 0) {
145
- throw new Error('Running "git push" command failed.');
157
+ throw new Error('Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?');
146
158
  }
147
159
  else if (commitResults.code === 0) {
148
160
  // The commit might return a non-zero value when site is up to date.
@@ -161,13 +173,13 @@ This behavior can have SEO impacts and create relative link issues.
161
173
  }
162
174
  };
163
175
  if (!cliOptions.skipBuild) {
164
- // Build static html files, then push to deploymentBranch branch of specified repo.
176
+ // Build site, then push to deploymentBranch branch of specified repo.
165
177
  try {
166
- await runDeploy(await build_1.default(siteDir, cliOptions, false));
178
+ await (0, build_1.build)(siteDir, cliOptions, false).then(runDeploy);
167
179
  }
168
- catch (buildError) {
169
- console.error(buildError);
170
- process.exit(1);
180
+ catch (err) {
181
+ logger_1.default.error('Deployment of the build output failed.');
182
+ throw err;
171
183
  }
172
184
  }
173
185
  else {
@@ -175,4 +187,4 @@ This behavior can have SEO impacts and create relative link issues.
175
187
  await runDeploy(outDir);
176
188
  }
177
189
  }
178
- exports.default = deploy;
190
+ exports.deploy = deploy;