create-docusaurus 0.0.0-4593 → 0.0.0-4597

package/bin/index.js

@@ -8,12 +8,15 @@
 
 // @ts-check
 
-const logger = require('@docusaurus/logger').default;
-const semver = require('semver');
-const path = require('path');
-const {program} = require('commander');
-const {default: init} = require('../lib');
-const requiredVersion = require('../package.json').engines.node;
+import logger from '@docusaurus/logger';
+import semver from 'semver';
+import path from 'path';
+import {program} from 'commander';
+import {createRequire} from 'module';
+import init from '../lib/index.js';
+
+const packageJson = createRequire(import.meta.url)('../package.json');
+const requiredVersion = packageJson.engines.node;
 
 if (!semver.satisfies(process.version, requiredVersion)) {
   logger.error('Minimum Node.js version not met :(');
@@ -29,7 +32,7 @@ function wrapCommand(fn) {
     });
 }
 
-program.version(require('../package.json').version);
+program.version(packageJson.version);
 
 program
   .arguments('[siteName] [template] [rootDir]')

package/lib/index.js

@@ -1,26 +1,22 @@
-"use strict";
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-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"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const shelljs_1 = (0, tslib_1.__importDefault)(require("shelljs"));
-const lodash_1 = require("lodash");
-const supports_color_1 = (0, tslib_1.__importDefault)(require("supports-color"));
+import logger from '@docusaurus/logger';
+import fs from 'fs-extra';
+import prompts from 'prompts';
+import path from 'path';
+import shell from 'shelljs';
+import _ from 'lodash';
+import supportsColor from 'supports-color';
+import { fileURLToPath } from 'url';
 const RecommendedTemplate = 'classic';
 const TypeScriptTemplateSuffix = '-typescript';
 function hasYarn() {
     try {
-        (0, child_process_1.execSync)('yarnpkg --version', { stdio: 'ignore' });
-        return true;
+        return shell.exec('yarnpkg --version', { silent: true }).code === 0;
     }
     catch (e) {
         return false;
@@ -30,20 +26,20 @@ function isValidGitRepoUrl(gitRepoUrl) {
     return ['https://', 'git@'].some((item) => gitRepoUrl.startsWith(item));
 }
 async function updatePkg(pkgPath, obj) {
-    const content = await fs_extra_1.default.readFile(pkgPath, 'utf-8');
+    const content = await fs.readFile(pkgPath, 'utf-8');
     const pkg = JSON.parse(content);
     const newPkg = Object.assign(pkg, obj);
-    await fs_extra_1.default.outputFile(pkgPath, `${JSON.stringify(newPkg, null, 2)}\n`);
+    await fs.outputFile(pkgPath, `${JSON.stringify(newPkg, null, 2)}\n`);
 }
 function readTemplates(templatesDir) {
-    const templates = fs_extra_1.default
+    const templates = fs
         .readdirSync(templatesDir)
         .filter((d) => !d.startsWith('.') &&
         !d.startsWith('README') &&
         !d.endsWith(TypeScriptTemplateSuffix) &&
         d !== 'shared');
     // Classic should be first in list!
-    return (0, lodash_1.sortBy)(templates, (t) => t !== RecommendedTemplate);
+    return _.sortBy(templates, (t) => t !== RecommendedTemplate);
 }
 function createTemplateChoices(templates) {
     function makeNameAndValueChoice(value) {
@@ -63,22 +59,22 @@ function getTypeScriptBaseTemplate(template) {
     return undefined;
 }
 async function copyTemplate(templatesDir, template, dest) {
-    await fs_extra_1.default.copy(path_1.default.resolve(templatesDir, 'shared'), dest);
+    await fs.copy(path.resolve(templatesDir, 'shared'), dest);
     // TypeScript variants will copy duplicate resources like CSS & config from
     // base template
     const tsBaseTemplate = getTypeScriptBaseTemplate(template);
     if (tsBaseTemplate) {
-        const tsBaseTemplatePath = path_1.default.resolve(templatesDir, tsBaseTemplate);
-        await fs_extra_1.default.copy(tsBaseTemplatePath, dest, {
-            filter: (filePath) => fs_extra_1.default.statSync(filePath).isDirectory() ||
-                path_1.default.extname(filePath) === '.css' ||
-                path_1.default.basename(filePath) === 'docusaurus.config.js',
+        const tsBaseTemplatePath = path.resolve(templatesDir, tsBaseTemplate);
+        await fs.copy(tsBaseTemplatePath, dest, {
+            filter: (filePath) => fs.statSync(filePath).isDirectory() ||
+                path.extname(filePath) === '.css' ||
+                path.basename(filePath) === 'docusaurus.config.js',
         });
     }
-    await fs_extra_1.default.copy(path_1.default.resolve(templatesDir, template), dest, {
+    await fs.copy(path.resolve(templatesDir, template), dest, {
         // Symlinks don't exist in published NPM packages anymore, so this is only
         // to prevent errors during local testing
-        filter: (filePath) => !fs_extra_1.default.lstatSync(filePath).isSymbolicLink(),
+        filter: (filePath) => !fs.lstatSync(filePath).isSymbolicLink(),
     });
 }
 const gitStrategies = ['deep', 'shallow', 'copy', 'custom'];
@@ -88,7 +84,7 @@ async function getGitCommand(gitStrategy) {
         case 'copy':
             return 'git clone --recursive --depth 1';
         case 'custom': {
-            const { command } = await (0, prompts_1.default)({
+            const { command } = await prompts({
                 type: 'text',
                 name: 'command',
                 message: 'Write your own git clone command. The repository URL and destination directory will be supplied. E.g. "git clone --depth 10"',
@@ -100,16 +96,16 @@ async function getGitCommand(gitStrategy) {
             return 'git clone';
     }
 }
-async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
+export default async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
     var _a;
     const useYarn = cliOptions.useNpm ? false : hasYarn();
-    const templatesDir = path_1.default.resolve(__dirname, '../templates');
+    const templatesDir = fileURLToPath(new URL('../templates', import.meta.url));
     const templates = readTemplates(templatesDir);
-    const hasTS = (templateName) => fs_extra_1.default.pathExistsSync(path_1.default.resolve(templatesDir, `${templateName}${TypeScriptTemplateSuffix}`));
+    const hasTS = (templateName) => fs.pathExistsSync(path.resolve(templatesDir, `${templateName}${TypeScriptTemplateSuffix}`));
     let name = siteName;
     // Prompt if siteName is not passed from CLI.
     if (!name) {
-        const prompt = await (0, prompts_1.default)({
+        const prompt = await prompts({
             type: 'text',
             name: 'name',
             message: 'What should we name this site?',
@@ -118,19 +114,19 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
         name = prompt.name;
     }
     if (!name) {
-        logger_1.default.error('A website name is required.');
+        logger.error('A website name is required.');
         process.exit(1);
     }
-    const dest = path_1.default.resolve(rootDir, name);
-    if (fs_extra_1.default.existsSync(dest)) {
-        logger_1.default.error `Directory already exists at path=${dest}!`;
+    const dest = path.resolve(rootDir, name);
+    if (fs.existsSync(dest)) {
+        logger.error `Directory already exists at path=${dest}!`;
         process.exit(1);
     }
     let template = reqTemplate;
     let useTS = cliOptions.typescript;
     // Prompt if template is not provided from CLI.
     if (!template) {
-        const templatePrompt = await (0, prompts_1.default)({
+        const templatePrompt = await prompts({
             type: 'select',
             name: 'template',
             message: 'Select a template below...',
@@ -138,7 +134,7 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
         });
         template = templatePrompt.template;
         if (template && !useTS && hasTS(template)) {
-            const tsPrompt = await (0, prompts_1.default)({
+            const tsPrompt = await prompts({
                 type: 'confirm',
                 name: 'useTS',
                 message: 'This template is available in TypeScript. Do you want to use the TS variant?',
@@ -150,19 +146,19 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
     let gitStrategy = (_a = cliOptions.gitStrategy) !== null && _a !== void 0 ? _a : 'deep';
     // If user choose Git repository, we'll prompt for the url.
     if (template === 'Git repository') {
-        const repoPrompt = await (0, prompts_1.default)({
+        const repoPrompt = await prompts({
             type: 'text',
             name: 'gitRepoUrl',
             validate: (url) => {
                 if (url && isValidGitRepoUrl(url)) {
                     return true;
                 }
-                return logger_1.default.red('Invalid repository URL');
+                return logger.red('Invalid repository URL');
             },
-            message: logger_1.default.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
+            message: logger.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
 (e.g: path=${'https://github.com/ownerName/repoName.git'})`,
         });
-        ({ gitStrategy } = await (0, prompts_1.default)({
+        ({ gitStrategy } = await prompts({
             type: 'select',
             name: 'gitStrategy',
             message: 'How should we clone this repo?',
@@ -179,48 +175,48 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
         template = repoPrompt.gitRepoUrl;
     }
     else if (template === 'Local template') {
-        const dirPrompt = await (0, prompts_1.default)({
+        const dirPrompt = await prompts({
             type: 'text',
             name: 'templateDir',
             validate: (dir) => {
                 if (dir) {
-                    const fullDir = path_1.default.resolve(process.cwd(), dir);
-                    if (fs_extra_1.default.existsSync(fullDir)) {
+                    const fullDir = path.resolve(process.cwd(), dir);
+                    if (fs.existsSync(fullDir)) {
                         return true;
                     }
-                    return logger_1.default.red(logger_1.default.interpolate `path=${fullDir} does not exist.`);
+                    return logger.red(logger.interpolate `path=${fullDir} does not exist.`);
                 }
-                return logger_1.default.red('Please enter a valid path.');
+                return logger.red('Please enter a valid path.');
             },
             message: 'Enter a local folder path, relative to the current working directory.',
         });
         template = dirPrompt.templateDir;
     }
     if (!template) {
-        logger_1.default.error('Template should not be empty');
+        logger.error('Template should not be empty');
         process.exit(1);
     }
-    logger_1.default.info('Creating new Docusaurus project...');
+    logger.info('Creating new Docusaurus project...');
     if (isValidGitRepoUrl(template)) {
-        logger_1.default.info `Cloning Git template path=${template}...`;
+        logger.info `Cloning Git template path=${template}...`;
         if (!gitStrategies.includes(gitStrategy)) {
-            logger_1.default.error `Invalid git strategy: name=${gitStrategy}. Value must be one of ${gitStrategies.join(', ')}.`;
+            logger.error `Invalid git strategy: name=${gitStrategy}. Value must be one of ${gitStrategies.join(', ')}.`;
             process.exit(1);
         }
         const command = await getGitCommand(gitStrategy);
-        if (shelljs_1.default.exec(`${command} ${template} ${dest}`).code !== 0) {
-            logger_1.default.error `Cloning Git template name=${template} failed!`;
+        if (shell.exec(`${command} ${template} ${dest}`).code !== 0) {
+            logger.error `Cloning Git template name=${template} failed!`;
             process.exit(1);
         }
         if (gitStrategy === 'copy') {
-            await fs_extra_1.default.remove(path_1.default.join(dest, '.git'));
+            await fs.remove(path.join(dest, '.git'));
         }
     }
     else if (templates.includes(template)) {
         // Docusaurus templates.
         if (useTS) {
             if (!hasTS(template)) {
-                logger_1.default.error `Template name=${template} doesn't provide the Typescript variant.`;
+                logger.error `Template name=${template} doesn't provide the Typescript variant.`;
                 process.exit(1);
             }
             template = `${template}${TypeScriptTemplateSuffix}`;
@@ -229,68 +225,68 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
             await copyTemplate(templatesDir, template, dest);
         }
         catch (err) {
-            logger_1.default.error `Copying Docusaurus template name=${template} failed!`;
+            logger.error `Copying Docusaurus template name=${template} failed!`;
             throw err;
         }
     }
-    else if (fs_extra_1.default.existsSync(path_1.default.resolve(process.cwd(), template))) {
-        const templateDir = path_1.default.resolve(process.cwd(), template);
+    else if (fs.existsSync(path.resolve(process.cwd(), template))) {
+        const templateDir = path.resolve(process.cwd(), template);
         try {
-            await fs_extra_1.default.copy(templateDir, dest);
+            await fs.copy(templateDir, dest);
         }
         catch (err) {
-            logger_1.default.error `Copying local template path=${templateDir} failed!`;
+            logger.error `Copying local template path=${templateDir} failed!`;
             throw err;
         }
     }
     else {
-        logger_1.default.error('Invalid template.');
+        logger.error('Invalid template.');
         process.exit(1);
     }
     // Update package.json info.
     try {
-        await updatePkg(path_1.default.join(dest, 'package.json'), {
-            name: (0, lodash_1.kebabCase)(name),
+        await updatePkg(path.join(dest, 'package.json'), {
+            name: _.kebabCase(name),
             version: '0.0.0',
             private: true,
         });
     }
     catch (err) {
-        logger_1.default.error('Failed to update package.json.');
+        logger.error('Failed to update package.json.');
         throw err;
     }
     // We need to rename the gitignore file to .gitignore
-    if (!fs_extra_1.default.pathExistsSync(path_1.default.join(dest, '.gitignore')) &&
-        fs_extra_1.default.pathExistsSync(path_1.default.join(dest, 'gitignore'))) {
-        await fs_extra_1.default.move(path_1.default.join(dest, 'gitignore'), path_1.default.join(dest, '.gitignore'));
+    if (!fs.pathExistsSync(path.join(dest, '.gitignore')) &&
+        fs.pathExistsSync(path.join(dest, 'gitignore'))) {
+        await fs.move(path.join(dest, 'gitignore'), path.join(dest, '.gitignore'));
     }
-    if (fs_extra_1.default.pathExistsSync(path_1.default.join(dest, 'gitignore'))) {
-        fs_extra_1.default.removeSync(path_1.default.join(dest, 'gitignore'));
+    if (fs.pathExistsSync(path.join(dest, 'gitignore'))) {
+        fs.removeSync(path.join(dest, 'gitignore'));
     }
     const pkgManager = useYarn ? 'yarn' : 'npm';
     // Display the most elegant way to cd.
-    const cdpath = path_1.default.relative('.', dest);
+    const cdpath = path.relative('.', dest);
     if (!cliOptions.skipInstall) {
-        shelljs_1.default.cd(dest);
-        logger_1.default.info `Installing dependencies with name=${pkgManager}...`;
-        if (shelljs_1.default.exec(useYarn ? 'yarn' : 'npm install --color always', {
+        shell.cd(dest);
+        logger.info `Installing dependencies with name=${pkgManager}...`;
+        if (shell.exec(useYarn ? 'yarn' : 'npm install --color always', {
             env: {
                 ...process.env,
                 // Force coloring the output, since the command is invoked by shelljs,
                 // which is not the interactive shell
-                ...(supports_color_1.default.stdout ? { FORCE_COLOR: '1' } : {}),
+                ...(supportsColor.stdout ? { FORCE_COLOR: '1' } : {}),
             },
         }).code !== 0) {
-            logger_1.default.error('Dependency installation failed.');
-            logger_1.default.info `The site directory has already been created, and you can retry by typing:
+            logger.error('Dependency installation failed.');
+            logger.info `The site directory has already been created, and you can retry by typing:
 
   code=${`cd ${cdpath}`}
   code=${`${pkgManager} install`}`;
             process.exit(0);
         }
     }
-    logger_1.default.success `Created path=${cdpath}.`;
-    logger_1.default.info `Inside that directory, you can run several commands:
+    logger.success `Created path=${cdpath}.`;
+    logger.info `Inside that directory, you can run several commands:
 
   code=${`${pkgManager} start`}
     Starts the development server.
@@ -312,4 +308,3 @@ We recommend that you begin by typing:
 Happy building awesome websites!
 `;
 }
-exports.default = init;

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "create-docusaurus",
-  "version": "0.0.0-4593",
+  "version": "0.0.0-4597",
   "description": "Create Docusaurus apps easily.",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/docusaurus.git",
@@ -21,14 +22,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "0.0.0-4593",
+    "@docusaurus/logger": "0.0.0-4597",
     "commander": "^5.1.0",
     "fs-extra": "^10.0.0",
-    "lodash": "^4.17.20",
+    "lodash": "^4.17.21",
     "prompts": "^2.4.2",
     "semver": "^7.3.5",
     "shelljs": "^0.8.5",
-    "supports-color": "^8.1.1",
+    "supports-color": "^9.2.1",
     "tslib": "^2.3.1"
   },
   "engines": {
@@ -37,5 +38,5 @@
   "devDependencies": {
     "@types/supports-color": "^8.1.1"
   },
-  "gitHead": "fc32eabcb5fb2b1f75d1582d2ea5aa7a0679f241"
+  "gitHead": "635ab60e7cf821111d46dee45baf932c5bf8220f"
 }

package/templates/classic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-template",
-  "version": "0.0.0-4593",
+  "version": "0.0.0-4597",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4593",
-    "@docusaurus/preset-classic": "0.0.0-4593",
+    "@docusaurus/core": "0.0.0-4597",
+    "@docusaurus/preset-classic": "0.0.0-4597",
     "@mdx-js/react": "^1.6.22",
     "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-4593",
+  "version": "0.0.0-4597",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,8 +15,8 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4593",
-    "@docusaurus/preset-classic": "0.0.0-4593",
+    "@docusaurus/core": "0.0.0-4597",
+    "@docusaurus/preset-classic": "0.0.0-4597",
     "@mdx-js/react": "^1.6.22",
     "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-4593",
+    "@docusaurus/module-type-aliases": "0.0.0-4597",
     "@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-4593",
+  "version": "0.0.0-4597",
   "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-4593",
-    "@docusaurus/preset-classic": "0.0.0-4593",
+    "@docusaurus/core": "0.0.0-4597",
+    "@docusaurus/preset-classic": "0.0.0-4597",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "react": "^17.0.1",