@docusaurus/core 3.7.0-canary-6244 → 3.7.0-canary-6245

package/bin/beforeCli.mjs

@@ -10,7 +10,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import {createRequire} from 'module';
-import shell from 'shelljs';
+import execa from 'execa';
 import {logger} from '@docusaurus/logger';
 import semver from 'semver';
 import updateNotifier from 'update-notifier';
@@ -111,8 +111,8 @@ export default async function beforeCli() {
         return undefined;
       }
 
-      const yarnVersionResult = shell.exec('yarn --version', {silent: true});
-      if (yarnVersionResult?.code === 0) {
+      const yarnVersionResult = await execa.command('yarn --version');
+      if (yarnVersionResult.exitCode === 0) {
         const majorVersion = parseInt(
           yarnVersionResult.stdout?.trim().split('.')[0] ?? '',
           10,

package/lib/commands/deploy.js

@@ -12,7 +12,7 @@ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const os_1 = tslib_1.__importDefault(require("os"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
+const execa_1 = tslib_1.__importDefault(require("execa"));
 const utils_1 = require("@docusaurus/utils");
 const site_1 = require("../server/site");
 const build_1 = require("./build/build");
@@ -21,19 +21,41 @@ function obfuscateGitPass(str) {
     const gitPass = process.env.GIT_PASS;
     return gitPass ? str.replace(gitPass, 'GIT_PASS') : str;
 }
+const debugMode = !!process.env.DOCUSAURUS_DEPLOY_DEBUG;
 // Log executed commands so that user can figure out mistakes on his own
 // for example: https://github.com/facebook/docusaurus/issues/3875
-function shellExecLog(cmd) {
+function exec(cmd, options) {
+    const log = options?.log ?? true;
+    const failfast = options?.failfast ?? false;
     try {
-        const result = shelljs_1.default.exec(cmd);
-        logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.code}`}`;
+        // TODO migrate to execa(file,[...args]) instead
+        //  Use async/await everything
+        //  Avoid execa.command: the args need to be escaped manually
+        const result = execa_1.default.commandSync(cmd);
+        if (log || debugMode) {
+            logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.exitCode}`}`;
+        }
+        if (debugMode) {
+            console.log(result);
+        }
+        if (failfast && result.exitCode !== 0) {
+            throw new Error(`Command returned unexpected exitCode ${result.exitCode}`);
+        }
         return result;
     }
     catch (err) {
-        logger_1.default.error `code=${obfuscateGitPass(cmd)}`;
-        throw err;
+        throw new Error(logger_1.default.interpolate `Error while executing command code=${obfuscateGitPass(cmd)}
+In CWD code=${process.cwd()}`, { cause: err });
     }
 }
+// Execa escape args and add necessary quotes automatically
+// When using Execa.command, the args containing spaces must be escaped manually
+function escapeArg(arg) {
+    return arg.replaceAll(' ', '\\ ');
+}
+function hasGit() {
+    return exec('git --version').exitCode === 0;
+}
 async function deploy(siteDirParam = '.', cliOptions = {}) {
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const { outDir, siteConfig, siteConfigPath } = await (0, site_1.loadContext)({
@@ -48,16 +70,23 @@ This behavior can have SEO impacts and create relative link issues.
 `);
     }
     logger_1.default.info('Deploy command invoked...');
-    if (!shelljs_1.default.which('git')) {
-        throw new Error('Git not installed or on the PATH!');
+    if (!hasGit()) {
+        throw new Error('Git not installed or not added to PATH!');
     }
     // Source repo is the repo from where the command is invoked
-    const sourceRepoUrl = shelljs_1.default
-        .exec('git remote get-url origin', { silent: true })
-        .stdout.trim();
+    const { stdout } = exec('git remote get-url origin', {
+        log: false,
+        failfast: true,
+    });
+    const sourceRepoUrl = 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();
+        exec('git rev-parse --abbrev-ref HEAD', {
+            log: false,
+            failfast: true,
+        })
+            ?.stdout?.toString()
+            .trim();
     const gitUser = process.env.GIT_USER;
     let useSSH = process.env.USE_SSH !== undefined &&
         process.env.USE_SSH.toLowerCase() === 'true';
@@ -87,8 +116,11 @@ This behavior can have SEO impacts and create relative link issues.
     // We never deploy on 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);
+        exec('echo "Skipping deploy on a pull request."', {
+            log: false,
+            failfast: true,
+        });
+        process.exit(0);
     }
     // github.io indicates organization repos that deploy via default branch. All
     // others use gh-pages (either case can be configured actually, but we can
@@ -126,21 +158,24 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
     }
     // 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 currentCommit = exec('git rev-parse HEAD')?.stdout?.toString().trim();
     const runDeploy = async (outputDirectory) => {
         const targetDirectory = cliOptions.targetDir ?? '.';
         const fromPath = outputDirectory;
         const toPath = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
-        shelljs_1.default.cd(toPath);
+        process.chdir(toPath);
         // Clones the repo into the temp folder and checks out the target branch.
         // If the branch doesn't exist, it creates a new one based on the
         // repository default branch.
-        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code !== 0) {
-            shellExecLog(`git clone --depth 1 ${deploymentRepoURL} "${toPath}"`);
-            shellExecLog(`git checkout -b ${deploymentBranch}`);
+        if (exec(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} ${escapeArg(toPath)}`).exitCode !== 0) {
+            exec(`git clone --depth 1 ${deploymentRepoURL} ${escapeArg(toPath)}`);
+            exec(`git checkout -b ${deploymentBranch}`);
         }
         // Clear out any existing contents in the target directory
-        shellExecLog(`git rm -rf ${targetDirectory}`);
+        exec(`git rm -rf ${escapeArg(targetDirectory)}`, {
+            log: false,
+            failfast: true,
+        });
         const targetPath = path_1.default.join(toPath, targetDirectory);
         try {
             await fs_extra_1.default.copy(fromPath, targetPath);
@@ -149,22 +184,24 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
             logger_1.default.error `Copying build assets from path=${fromPath} to path=${targetPath} failed.`;
             throw err;
         }
-        shellExecLog('git add --all');
+        exec('git add --all', { failfast: true });
         const gitUserName = process.env.GIT_USER_NAME;
         if (gitUserName) {
-            shellExecLog(`git config user.name "${gitUserName}"`);
+            exec(`git config user.name ${escapeArg(gitUserName)}`, { failfast: true });
         }
         const gitUserEmail = process.env.GIT_USER_EMAIL;
         if (gitUserEmail) {
-            shellExecLog(`git config user.email "${gitUserEmail}"`);
+            exec(`git config user.email ${escapeArg(gitUserEmail)}`, {
+                failfast: true,
+            });
         }
         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) {
+        const commitResults = exec(`git commit -m ${escapeArg(commitMessage)} --allow-empty`);
+        if (exec(`git push --force origin ${deploymentBranch}`).exitCode !== 0) {
             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) {
+        else if (commitResults.exitCode === 0) {
             // The commit might return a non-zero value when site is up to date.
             let websiteURL = '';
             if (githubHost === 'github.com') {
@@ -176,8 +213,13 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
                 // GitHub enterprise hosting.
                 websiteURL = `https://${githubHost}/pages/${organizationName}/${projectName}/`;
             }
-            shelljs_1.default.echo(`Website is live at "${websiteURL}".`);
-            shelljs_1.default.exit(0);
+            try {
+                exec(`echo "Website is live at ${websiteURL}."`, { failfast: true });
+                process.exit(0);
+            }
+            catch (err) {
+                throw new Error(`Failed to execute command: ${err}`);
+            }
         }
     };
     if (!cliOptions.skipBuild) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.7.0-canary-6244",
+  "version": "3.7.0-canary-6245",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.7.0-canary-6244",
-    "@docusaurus/bundler": "3.7.0-canary-6244",
-    "@docusaurus/logger": "3.7.0-canary-6244",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6244",
-    "@docusaurus/utils": "3.7.0-canary-6244",
-    "@docusaurus/utils-common": "3.7.0-canary-6244",
-    "@docusaurus/utils-validation": "3.7.0-canary-6244",
+    "@docusaurus/babel": "3.7.0-canary-6245",
+    "@docusaurus/bundler": "3.7.0-canary-6245",
+    "@docusaurus/logger": "3.7.0-canary-6245",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6245",
+    "@docusaurus/utils": "3.7.0-canary-6245",
+    "@docusaurus/utils-common": "3.7.0-canary-6245",
+    "@docusaurus/utils-validation": "3.7.0-canary-6245",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -52,6 +52,7 @@
     "escape-html": "^1.0.3",
     "eta": "^2.2.0",
     "eval": "^0.1.8",
+    "execa": "5.1.1",
     "fs-extra": "^11.1.1",
     "html-tags": "^3.3.1",
     "html-webpack-plugin": "^5.6.0",
@@ -68,7 +69,6 @@
     "react-router-dom": "^5.3.4",
     "semver": "^7.5.4",
     "serve-handler": "^6.1.6",
-    "shelljs": "^0.8.5",
     "tinypool": "^1.0.2",
     "tslib": "^2.6.0",
     "update-notifier": "^6.0.2",
@@ -78,8 +78,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6244",
-    "@docusaurus/types": "3.7.0-canary-6244",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6245",
+    "@docusaurus/types": "3.7.0-canary-6245",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -99,5 +99,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "07a2717f32b6bafc0c89156355b1f58e877ea3b2"
+  "gitHead": "65621de892b3c3b011c9888712803039301672c9"
 }