create-docusaurus 0.0.0-4291 → 0.0.0-4297

package/bin/index.js

@@ -6,7 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const chalk = require('chalk');
+// @ts-check
+
+const logger = require('@docusaurus/logger').default;
 const semver = require('semver');
 const path = require('path');
 const program = require('commander');
@@ -14,19 +16,15 @@ const {default: init} = require('../lib');
 const requiredVersion = require('../package.json').engines.node;
 
 if (!semver.satisfies(process.version, requiredVersion)) {
-  console.log(
-    chalk.red(`\nMinimum Node.js version not met :)`) +
-      chalk.yellow(
-        `\nYou are using Node.js ${process.version}, Requirement: Node.js ${requiredVersion}.\n`,
-      ),
-  );
+  logger.error('Minimum Node.js version not met :(');
+  logger.info`You are using Node.js number=${process.version}, Requirement: Node.js number=${requiredVersion}.`;
   process.exit(1);
 }
 
 function wrapCommand(fn) {
   return (...args) =>
     fn(...args).catch((err) => {
-      console.error(chalk.red(err.stack));
+      logger.error(err.stack);
       process.exitCode = 1;
     });
 }
@@ -58,8 +56,7 @@ program
 
 program.arguments('<command>').action((cmd) => {
   program.outputHelp();
-  console.log(`  ${chalk.red(`\n  Unknown command ${chalk.yellow(cmd)}.`)}`);
-  console.log();
+  logger.error`Unknown command code=${cmd}.`;
 });
 
 program.parse(process.argv);

package/lib/index.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const child_process_1 = require("child_process");
 const prompts_1 = (0, tslib_1.__importDefault)(require("prompts"));
@@ -96,11 +96,13 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
         name = prompt.name;
     }
     if (!name) {
-        throw new Error(chalk_1.default.red('A website name is required.'));
+        logger_1.default.error('A website name is required.');
+        process.exit(1);
     }
     const dest = path_1.default.resolve(rootDir, name);
     if (fs_extra_1.default.existsSync(dest)) {
-        throw new Error(`Directory already exists at "${dest}"!`);
+        logger_1.default.error `Directory already exists at path=${dest}!`;
+        process.exit(1);
     }
     let template = reqTemplate;
     let useTS = cliOptions.typescript;
@@ -132,9 +134,10 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
                 if (url && isValidGitRepoUrl(url)) {
                     return true;
                 }
-                return chalk_1.default.red(`Invalid repository URL`);
+                return logger_1.default.red('Invalid repository URL');
             },
-            message: 'Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.\n(e.g: https://github.com/ownerName/repoName.git)',
+            message: logger_1.default.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
+(e.g: path=${'https://github.com/ownerName/repoName.git'})`,
         });
         template = repoPrompt.gitRepoUrl;
     }
@@ -148,32 +151,33 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
                     if (fs_extra_1.default.existsSync(fullDir)) {
                         return true;
                     }
-                    return chalk_1.default.red(`The path ${chalk_1.default.magenta(fullDir)} does not exist.`);
+                    return logger_1.default.red(logger_1.default.interpolate `path=${fullDir} does not exist.`);
                 }
-                return chalk_1.default.red('Please enter a valid path.');
+                return logger_1.default.red('Please enter a valid path.');
             },
             message: 'Enter a local folder path, relative to the current working directory.',
         });
         template = dirPrompt.templateDir;
     }
     if (!template) {
-        throw new Error('Template should not be empty');
+        logger_1.default.error('Template should not be empty');
+        process.exit(1);
     }
-    console.log(`
-${chalk_1.default.cyan('Creating new Docusaurus project...')}
-`);
+    logger_1.default.info('Creating new Docusaurus project...');
     if (isValidGitRepoUrl(template)) {
-        console.log(`Cloning Git template ${chalk_1.default.cyan(template)}...`);
+        logger_1.default.info `Cloning Git template path=${template}...`;
         if (shelljs_1.default.exec(`git clone --recursive ${template} ${dest}`, { silent: true })
             .code !== 0) {
-            throw new Error(chalk_1.default.red(`Cloning Git template ${template} failed!`));
+            logger_1.default.error `Cloning Git template name=${template} failed!`;
+            process.exit(1);
         }
     }
     else if (templates.includes(template)) {
         // Docusaurus templates.
         if (useTS) {
             if (!hasTS(template)) {
-                throw new Error(`Template ${template} doesn't provide the Typescript variant.`);
+                logger_1.default.error `Template name=${template} doesn't provide the Typescript variant.`;
+                process.exit(1);
             }
             template = `${template}${TypeScriptTemplateSuffix}`;
         }
@@ -181,7 +185,7 @@ ${chalk_1.default.cyan('Creating new Docusaurus project...')}
             await copyTemplate(templatesDir, template, dest);
         }
         catch (err) {
-            console.log(`Copying Docusaurus template ${chalk_1.default.cyan(template)} failed!`);
+            logger_1.default.error `Copying Docusaurus template name=${template} failed!`;
             throw err;
         }
     }
@@ -191,12 +195,13 @@ ${chalk_1.default.cyan('Creating new Docusaurus project...')}
             await fs_extra_1.default.copy(templateDir, dest);
         }
         catch (err) {
-            console.log(`Copying local template ${templateDir} failed!`);
+            logger_1.default.error `Copying local template path=${templateDir} failed!`;
             throw err;
         }
     }
     else {
-        throw new Error('Invalid template.');
+        logger_1.default.error('Invalid template.');
+        process.exit(1);
     }
     // Update package.json info.
     try {
@@ -207,7 +212,7 @@ ${chalk_1.default.cyan('Creating new Docusaurus project...')}
         });
     }
     catch (err) {
-        console.log(chalk_1.default.red('Failed to update package.json.'));
+        logger_1.default.error('Failed to update package.json.');
         throw err;
     }
     // We need to rename the gitignore file to .gitignore
@@ -224,7 +229,7 @@ ${chalk_1.default.cyan('Creating new Docusaurus project...')}
         ? name
         : path_1.default.relative(process.cwd(), name);
     if (!cliOptions.skipInstall) {
-        console.log(`Installing dependencies with ${chalk_1.default.cyan(pkgManager)}...`);
+        logger_1.default.info `Installing dependencies with name=${pkgManager}...`;
         if (shelljs_1.default.exec(`cd "${name}" && ${useYarn ? 'yarn' : 'npm install --color always'}`, {
             env: {
                 ...process.env,
@@ -232,36 +237,35 @@ ${chalk_1.default.cyan('Creating new Docusaurus project...')}
                 ...(supports_color_1.default.stdout ? { FORCE_COLOR: '1' } : {}),
             },
         }).code !== 0) {
-            console.error(chalk_1.default.red('Dependency installation failed.'));
-            console.log(`The site directory has already been created, and you can retry by typing:
+            logger_1.default.error('Dependency installation failed.');
+            logger_1.default.info `The site directory has already been created, and you can retry by typing:
 
-  ${chalk_1.default.cyan('cd')} ${cdpath}
-  ${chalk_1.default.cyan(`${pkgManager} install`)}`);
+  code=${`cd ${cdpath}`}
+  code=${`${pkgManager} install`}`;
             process.exit(0);
         }
     }
-    console.log(`
-Successfully created "${chalk_1.default.cyan(cdpath)}".
-Inside that directory, you can run several commands:
+    logger_1.default.success `Created path=${cdpath}.`;
+    logger_1.default.info `Inside that directory, you can run several commands:
 
-  ${chalk_1.default.cyan(`${pkgManager} start`)}
+  code=${`${pkgManager} start`}
     Starts the development server.
 
-  ${chalk_1.default.cyan(`${pkgManager} ${useYarn ? '' : 'run '}build`)}
+  code=${`${pkgManager} ${useYarn ? '' : 'run '}build`}
     Bundles your website into static files for production.
 
-  ${chalk_1.default.cyan(`${pkgManager} ${useYarn ? '' : 'run '}serve`)}
+  code=${`${pkgManager} ${useYarn ? '' : 'run '}serve`}
     Serves the built website locally.
 
-  ${chalk_1.default.cyan(`${pkgManager} deploy`)}
+  code=${`${pkgManager} deploy`}
     Publishes the website to GitHub pages.
 
 We recommend that you begin by typing:
 
-  ${chalk_1.default.cyan('cd')} ${cdpath}
-  ${chalk_1.default.cyan(`${pkgManager} start`)}
+  code=${`cd ${cdpath}`}
+  code=${`${pkgManager} start`}
 
 Happy building awesome websites!
-`);
+`;
 }
 exports.default = init;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "0.0.0-4291",
+  "version": "0.0.0-4297",
   "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
@@ -23,7 +23,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "chalk": "^4.1.2",
+    "@docusaurus/logger": "0.0.0-4297",
     "commander": "^5.1.0",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.20",
@@ -39,5 +39,5 @@
   "devDependencies": {
     "@types/supports-color": "^8.1.1"
   },
-  "gitHead": "7097980fb8a57b1950c0714707966eea27f69975"
+  "gitHead": "84ae34c33c664bf856f3a92047919a074e087d77"
 }

package/templates/classic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-template",
-  "version": "0.0.0-4291",
+  "version": "0.0.0-4297",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4291",
-    "@docusaurus/preset-classic": "0.0.0-4291",
+    "@docusaurus/core": "0.0.0-4297",
+    "@docusaurus/preset-classic": "0.0.0-4297",
     "@mdx-js/react": "^1.6.21",
     "clsx": "^1.1.1",
     "prism-react-renderer": "^1.2.1",

package/templates/classic-typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-typescript-template",
-  "version": "0.0.0-4291",
+  "version": "0.0.0-4297",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,8 +15,8 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4291",
-    "@docusaurus/preset-classic": "0.0.0-4291",
+    "@docusaurus/core": "0.0.0-4297",
+    "@docusaurus/preset-classic": "0.0.0-4297",
     "@mdx-js/react": "^1.6.21",
     "clsx": "^1.1.1",
     "prism-react-renderer": "^1.2.1",
@@ -24,7 +24,7 @@
     "react-dom": "^17.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4291",
+    "@docusaurus/module-type-aliases": "0.0.0-4297",
     "@tsconfig/docusaurus": "^1.0.4",
     "typescript": "^4.5.2"
   },

package/templates/facebook/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-facebook-template",
-  "version": "0.0.0-4291",
+  "version": "0.0.0-4297",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -18,8 +18,8 @@
     "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\""
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4291",
-    "@docusaurus/preset-classic": "0.0.0-4291",
+    "@docusaurus/core": "0.0.0-4297",
+    "@docusaurus/preset-classic": "0.0.0-4297",
     "@mdx-js/react": "^1.6.21",
     "clsx": "^1.1.1",
     "react": "^17.0.1",