@docusaurus/core 2.0.0-beta.2 → 2.0.0-beta.22

package/lib/commands/deploy.js

@@ -6,15 +6,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.deploy = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const server_1 = require("../server");
-const build_1 = tslib_1.__importDefault(require("./build"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const os_1 = tslib_1.__importDefault(require("os"));
-const buildRemoteBranchUrl_1 = require("./buildRemoteBranchUrl");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
+const utils_1 = require("@docusaurus/utils");
+const server_1 = require("../server");
+const build_1 = require("./build");
 // GIT_PASS env variable should not appear in logs
 function obfuscateGitPass(str) {
     const gitPass = process.env.GIT_PASS;
@@ -25,124 +26,146 @@ function obfuscateGitPass(str) {
 function shellExecLog(cmd) {
     try {
         const result = shelljs_1.default.exec(cmd);
-        console.log(`${chalk_1.default.cyan('CMD:')} ${obfuscateGitPass(cmd)} ${chalk_1.default.cyan(`(code: ${result.code})`)}`);
+        logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.code}`}`;
         return result;
     }
-    catch (e) {
-        console.log(`${chalk_1.default.red('CMD:')} ${obfuscateGitPass(cmd)}`);
-        throw e;
+    catch (err) {
+        logger_1.default.error `code=${obfuscateGitPass(cmd)}`;
+        throw err;
     }
 }
-async function deploy(siteDir, cliOptions = {}) {
-    const { outDir, siteConfig, siteConfigPath } = await server_1.loadContext(siteDir, {
-        customConfigFilePath: cliOptions.config,
-        customOutDir: cliOptions.outDir,
+async function deploy(siteDirParam = '.', cliOptions = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
+    const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)({
+        siteDir,
+        config: cliOptions.config,
+        outDir: cliOptions.outDir,
     });
     if (typeof siteConfig.trailingSlash === 'undefined') {
-        console.warn(chalk_1.default.yellow(`
-Docusaurus recommendation:
-When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
+        logger_1.default.warn(`When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
 Otherwise, GitHub Pages will add an extra trailing slash to your site urls only on direct-access (not when navigation) with a server redirect.
 This behavior can have SEO impacts and create relative link issues.
-`));
+`);
     }
-    console.log('Deploy command invoked...');
+    logger_1.default.info('Deploy command invoked...');
     if (!shelljs_1.default.which('git')) {
         throw new Error('Git not installed or on the PATH!');
     }
+    // Source repo is the repo from where the command is invoked
+    const sourceRepoUrl = shelljs_1.default
+        .exec('git config --get remote.origin.url', { silent: true })
+        .stdout.trim();
+    // The source branch; defaults to the currently checked out branch
+    const sourceBranch = process.env.CURRENT_BRANCH ??
+        shelljs_1.default.exec('git rev-parse --abbrev-ref HEAD', { silent: true }).stdout.trim();
     const gitUser = process.env.GIT_USER;
-    if (!gitUser) {
-        throw new Error('Please set the GIT_USER environment variable!');
+    let useSSH = process.env.USE_SSH !== undefined &&
+        process.env.USE_SSH.toLowerCase() === 'true';
+    if (!gitUser && !useSSH) {
+        // If USE_SSH is unspecified: try inferring from repo URL
+        if (process.env.USE_SSH === undefined && (0, utils_1.hasSSHProtocol)(sourceRepoUrl)) {
+            useSSH = true;
+        }
+        else {
+            throw new Error('Please set the GIT_USER environment variable, or explicitly specify USE_SSH instead!');
+        }
     }
-    // The branch that contains the latest docs changes that will be deployed.
-    const currentBranch = process.env.CURRENT_BRANCH ||
-        shelljs_1.default.exec('git rev-parse --abbrev-ref HEAD').stdout.trim();
-    const organizationName = process.env.ORGANIZATION_NAME ||
-        process.env.CIRCLE_PROJECT_USERNAME ||
+    const organizationName = process.env.ORGANIZATION_NAME ??
+        process.env.CIRCLE_PROJECT_USERNAME ??
         siteConfig.organizationName;
     if (!organizationName) {
         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.`);
     }
-    console.log(`${chalk_1.default.cyan('organizationName:')} ${organizationName}`);
-    const projectName = process.env.PROJECT_NAME ||
-        process.env.CIRCLE_PROJECT_REPONAME ||
+    logger_1.default.info `organizationName: name=${organizationName}`;
+    const projectName = process.env.PROJECT_NAME ??
+        process.env.CIRCLE_PROJECT_REPONAME ??
         siteConfig.projectName;
     if (!projectName) {
         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.`);
     }
-    console.log(`${chalk_1.default.cyan('projectName:')} ${projectName}`);
+    logger_1.default.info `projectName: name=${projectName}`;
     // We never deploy on pull request.
-    const isPullRequest = process.env.CI_PULL_REQUEST || process.env.CIRCLE_PULL_REQUEST;
+    const isPullRequest = process.env.CI_PULL_REQUEST ?? process.env.CIRCLE_PULL_REQUEST;
     if (isPullRequest) {
         shelljs_1.default.echo('Skipping deploy on a pull request.');
         shelljs_1.default.exit(0);
     }
-    // github.io indicates organization repos that deploy via master. All others use gh-pages.
-    const deploymentBranch = process.env.DEPLOYMENT_BRANCH ||
-        (projectName.indexOf('.github.io') !== -1 ? 'master' : 'gh-pages');
-    console.log(`${chalk_1.default.cyan('deploymentBranch:')} ${deploymentBranch}`);
-    const githubHost = process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';
-    const githubPort = process.env.GITHUB_PORT || siteConfig.githubPort;
-    const gitPass = process.env.GIT_PASS;
-    let gitCredentials = `${gitUser}`;
-    if (gitPass) {
-        gitCredentials = `${gitCredentials}:${gitPass}`;
+    // github.io indicates organization repos that deploy via default branch. All
+    // others use gh-pages (either case can be configured actually, but we can
+    // make educated guesses). Organization deploys look like:
+    // - Git repo: https://github.com/<organization>/<organization>.github.io
+    // - Site url: https://<organization>.github.io
+    const isGitHubPagesOrganizationDeploy = projectName.includes('.github.io');
+    if (isGitHubPagesOrganizationDeploy &&
+        !process.env.DEPLOYMENT_BRANCH &&
+        !siteConfig.deploymentBranch) {
+        throw new Error(`For GitHub pages organization deployments, 'docusaurus deploy' does not assume anymore that 'master' is your default Git branch.
+Please provide the branch name to deploy to as an environment variable, for example DEPLOYMENT_BRANCH=main or DEPLOYMENT_BRANCH=master .
+You can also set the deploymentBranch property in docusaurus.config.js .`);
+    }
+    const deploymentBranch = process.env.DEPLOYMENT_BRANCH ?? siteConfig.deploymentBranch ?? 'gh-pages';
+    logger_1.default.info `deploymentBranch: name=${deploymentBranch}`;
+    const githubHost = process.env.GITHUB_HOST ?? siteConfig.githubHost ?? 'github.com';
+    const githubPort = process.env.GITHUB_PORT ?? siteConfig.githubPort;
+    let deploymentRepoURL;
+    if (useSSH) {
+        deploymentRepoURL = (0, utils_1.buildSshUrl)(githubHost, organizationName, projectName, githubPort);
+    }
+    else {
+        const gitPass = process.env.GIT_PASS;
+        const gitCredentials = gitPass ? `${gitUser}:${gitPass}` : gitUser;
+        deploymentRepoURL = (0, utils_1.buildHttpsUrl)(gitCredentials, githubHost, organizationName, projectName, githubPort);
     }
-    const useSSH = process.env.USE_SSH;
-    const remoteBranch = buildRemoteBranchUrl_1.buildUrl(githubHost, githubPort, gitCredentials, organizationName, projectName, useSSH !== undefined && useSSH.toLowerCase() === 'true');
-    console.log(`${chalk_1.default.cyan('Remote branch:')} ${obfuscateGitPass(remoteBranch)}`);
+    logger_1.default.info `Remote repo URL: name=${obfuscateGitPass(deploymentRepoURL)}`;
     // Check if this is a cross-repo publish.
-    const currentRepoUrl = shelljs_1.default
-        .exec('git config --get remote.origin.url')
-        .stdout.trim();
-    const crossRepoPublish = !currentRepoUrl.endsWith(`${organizationName}/${projectName}.git`);
+    const crossRepoPublish = !sourceRepoUrl.endsWith(`${organizationName}/${projectName}.git`);
     // We don't allow deploying to the same branch unless it's a cross publish.
-    if (currentBranch === deploymentBranch && !crossRepoPublish) {
-        throw new Error(`You cannot deploy from this branch (${currentBranch}).` +
+    if (sourceBranch === deploymentBranch && !crossRepoPublish) {
+        throw new Error(`You cannot deploy from this branch (${sourceBranch}).` +
             '\nYou will need to checkout to a different branch!');
     }
     // Save the commit hash that triggers publish-gh-pages before checking
     // out to deployment branch.
     const currentCommit = shellExecLog('git rev-parse HEAD').stdout.trim();
+    const currentGitRootDir = shellExecLog('git rev-parse --show-toplevel').stdout.trim();
     const runDeploy = async (outputDirectory) => {
         const fromPath = outputDirectory;
         const toPath = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
-        if (shellExecLog(`git clone ${remoteBranch} ${toPath}`).code !== 0) {
-            throw new Error(`Running "git clone" command in "${toPath}" failed.`);
-        }
         shelljs_1.default.cd(toPath);
-        // If the default branch is the one we're deploying to, then we'll fail
-        // to create it. This is the case of a cross-repo publish, where we clone
-        // a github.io repo with a default master branch.
-        const defaultBranch = shelljs_1.default
-            .exec('git rev-parse --abbrev-ref HEAD')
-            .stdout.trim();
-        if (defaultBranch !== deploymentBranch) {
-            if (shellExecLog(`git checkout origin/${deploymentBranch}`).code !== 0) {
-                if (shellExecLog(`git checkout --orphan ${deploymentBranch}`).code !== 0) {
-                    throw new Error(`Running "git checkout ${deploymentBranch}" command failed.`);
-                }
-            }
-            else if (shellExecLog(`git checkout -b ${deploymentBranch}`).code +
-                shellExecLog(`git branch --set-upstream-to=origin/${deploymentBranch}`).code !==
-                0) {
-                throw new Error(`Running "git checkout ${deploymentBranch}" command failed.`);
-            }
+        // Check out deployment branch when cloning repository, and then remove all
+        // the files in the directory. If the 'clone' command fails, assume that
+        // the deployment branch doesn't exist, and initialize git in an empty
+        // directory, check out a clean deployment branch and add remote.
+        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code === 0) {
+            shellExecLog('git rm -rf .');
+        }
+        else {
+            shellExecLog('git init');
+            shellExecLog(`git checkout -b ${deploymentBranch}`);
+            shellExecLog(`git remote add origin ${deploymentRepoURL}`);
         }
-        shellExecLog('git rm -rf .');
         try {
             await fs_extra_1.default.copy(fromPath, toPath);
         }
-        catch (error) {
-            throw new Error(`Copying build assets from "${fromPath}" to "${toPath}" failed with error "${error}".`);
+        catch (err) {
+            logger_1.default.error `Copying build assets from path=${fromPath} to path=${toPath} failed.`;
+            throw err;
+        }
+        const gitConfigFromPath = path_1.default.join(currentGitRootDir, `.git`, `config`);
+        const gitConfigToPath = path_1.default.join(toPath, `.git`, `config`);
+        try {
+            await fs_extra_1.default.copy(gitConfigFromPath, gitConfigToPath);
+        }
+        catch (err) {
+            logger_1.default.error `Copying git config from path=${gitConfigFromPath} to path=${gitConfigToPath} failed.`;
+            throw err;
         }
-        shelljs_1.default.cd(toPath);
         shellExecLog('git add --all');
-        const commitMessage = process.env.CUSTOM_COMMIT_MESSAGE ||
+        const commitMessage = process.env.CUSTOM_COMMIT_MESSAGE ??
             `Deploy website - based on ${currentCommit}`;
         const commitResults = shellExecLog(`git commit -m "${commitMessage}"`);
         if (shellExecLog(`git push --force origin ${deploymentBranch}`).code !== 0) {
-            throw new Error('Running "git push" command failed.');
+            throw new Error('Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?');
         }
         else if (commitResults.code === 0) {
             // The commit might return a non-zero value when site is up to date.
@@ -161,13 +184,13 @@ This behavior can have SEO impacts and create relative link issues.
         }
     };
     if (!cliOptions.skipBuild) {
-        // Build static html files, then push to deploymentBranch branch of specified repo.
+        // Build site, then push to deploymentBranch branch of specified repo.
         try {
-            await runDeploy(await build_1.default(siteDir, cliOptions, false));
+            await (0, build_1.build)(siteDir, cliOptions, false).then(runDeploy);
         }
-        catch (buildError) {
-            console.error(buildError);
-            process.exit(1);
+        catch (err) {
+            logger_1.default.error('Deployment of the build output failed.');
+            throw err;
         }
     }
     else {
@@ -175,4 +198,4 @@ This behavior can have SEO impacts and create relative link issues.
         await runDeploy(outDir);
     }
 }
-exports.default = deploy;
+exports.deploy = deploy;

package/lib/commands/external.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Command } from 'commander';
-export default function externalCommand(cli: Command, siteDir: string): Promise<void>;
+import type { CommanderStatic } from 'commander';
+export declare function externalCommand(cli: CommanderStatic): Promise<void>;

package/lib/commands/external.js

@@ -6,20 +6,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.externalCommand = void 0;
 const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const server_1 = require("../server");
-const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
-async function externalCommand(cli, siteDir) {
-    const context = await server_1.loadContext(siteDir);
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const plugins = init_1.default({ pluginConfigs, context });
+const init_1 = require("../server/plugins/init");
+async function externalCommand(cli) {
+    const siteDir = await fs_extra_1.default.realpath('.');
+    const context = await (0, server_1.loadContext)({ siteDir });
+    const plugins = await (0, init_1.initPlugins)(context);
     // Plugin Lifecycle - extendCli.
     plugins.forEach((plugin) => {
-        const { extendCli } = plugin;
-        if (!extendCli) {
-            return;
-        }
-        extendCli(cli);
+        plugin.extendCli?.(cli);
     });
 }
-exports.default = externalCommand;
+exports.externalCommand = externalCommand;

package/lib/commands/serve.d.ts

@@ -4,5 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { ServeCLIOptions } from '@docusaurus/types';
-export default function serve(siteDir: string, cliOptions: ServeCLIOptions): Promise<void>;
+import { type HostPortOptions } from '../server/getHostPort';
+import type { LoadContextOptions } from '../server';
+export declare type ServeCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'config'> & {
+    dir?: string;
+    build?: boolean;
+    open?: boolean;
+};
+export declare function serve(siteDirParam?: string, cliOptions?: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -6,60 +6,61 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = void 0;
 const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const http_1 = tslib_1.__importDefault(require("http"));
-const serve_handler_1 = tslib_1.__importDefault(require("serve-handler"));
-const boxen_1 = tslib_1.__importDefault(require("boxen"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const server_1 = require("../server");
-const build_1 = tslib_1.__importDefault(require("./build"));
-const commandUtils_1 = require("./commandUtils");
-async function serve(siteDir, cliOptions) {
-    let dir = path_1.default.isAbsolute(cliOptions.dir)
-        ? cliOptions.dir
-        : path_1.default.join(siteDir, cliOptions.dir);
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+const serve_handler_1 = tslib_1.__importDefault(require("serve-handler"));
+const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrowser"));
+const config_1 = require("../server/config");
+const build_1 = require("./build");
+const getHostPort_1 = require("../server/getHostPort");
+async function serve(siteDirParam = '.', cliOptions = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
+    const buildDir = cliOptions.dir ?? utils_1.DEFAULT_BUILD_DIR_NAME;
+    let dir = path_1.default.resolve(siteDir, buildDir);
     if (cliOptions.build) {
-        dir = await build_1.default(siteDir, {
+        dir = await (0, build_1.build)(siteDir, {
             config: cliOptions.config,
             outDir: dir,
         }, false);
     }
-    const host = commandUtils_1.getCLIOptionHost(cliOptions.host);
-    const port = await commandUtils_1.getCLIOptionPort(cliOptions.port, host);
+    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         process.exit();
     }
-    const { siteConfig: { baseUrl, trailingSlash }, } = await server_1.loadSiteConfig({
+    const { siteConfig: { baseUrl, trailingSlash }, } = await (0, config_1.loadSiteConfig)({
         siteDir,
         customConfigFilePath: cliOptions.config,
     });
-    const servingUrl = `http://${cliOptions.host}:${cliOptions.port}`;
+    const servingUrl = `http://${host}:${port}`;
     const server = http_1.default.createServer((req, res) => {
-        var _a, _b;
         // Automatically redirect requests to /baseUrl/
-        if (!((_a = req.url) === null || _a === void 0 ? void 0 : _a.startsWith(baseUrl))) {
+        if (!req.url?.startsWith(baseUrl)) {
             res.writeHead(302, {
                 Location: baseUrl,
             });
             res.end();
             return;
         }
-        // Remove baseUrl before calling serveHandler
-        // Reason: /baseUrl/ should serve /build/index.html, not /build/baseUrl/index.html (does not exist)
-        req.url = (_b = req.url) === null || _b === void 0 ? void 0 : _b.replace(baseUrl, '/');
-        serve_handler_1.default(req, res, {
+        // Remove baseUrl before calling serveHandler, because /baseUrl/ should
+        // serve /build/index.html, not /build/baseUrl/index.html (does not exist)
+        req.url = req.url.replace(baseUrl, '/');
+        (0, serve_handler_1.default)(req, res, {
             cleanUrls: true,
             public: dir,
             trailingSlash,
+            directoryListing: false,
         });
     });
-    console.log(boxen_1.default(chalk_1.default.green(`Serving "${cliOptions.dir}" directory at "${servingUrl + baseUrl}".`), {
-        borderColor: 'green',
-        padding: 1,
-        margin: 1,
-        align: 'center',
-    }));
+    const url = servingUrl + baseUrl;
+    logger_1.default.success `Serving path=${buildDir} directory at: url=${url}`;
     server.listen(port);
+    if (cliOptions.open && !process.env.CI) {
+        (0, openBrowser_1.default)(url);
+    }
 }
-exports.default = serve;
+exports.serve = serve;

package/lib/commands/start.d.ts

@@ -4,5 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { StartCLIOptions } from '@docusaurus/types';
-export default function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;
+import { type LoadContextOptions } from '../server';
+import { type HostPortOptions } from '../server/getHostPort';
+export declare type StartCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'locale' | 'config'> & {
+    hotOnly?: boolean;
+    open?: boolean;
+    poll?: boolean | number;
+    minify?: boolean;
+};
+export declare function start(siteDirParam?: string, cliOptions?: Partial<StartCLIOptions>): Promise<void>;