create-docusaurus 3.1.0 → 3.2.0

package/README.md

@@ -25,7 +25,7 @@ For Docusaurus maintainers, templates can be tested with:
 ```bash
 cd `git rev-parse --show-toplevel` # Back to repo root
 rm -rf test-website
-yarn create-docusaurus test-website classic
+yarn create-docusaurus test-website classic --javascript
 cd test-website
 yarn start
 ```
@@ -37,7 +37,7 @@ Use the following to test the templates against local packages:
 ```bash
 cd `git rev-parse --show-toplevel` # Back to repo root
 rm -rf test-website-in-workspace
-yarn create-docusaurus test-website-in-workspace classic
+yarn create-docusaurus test-website-in-workspace classic --javascript
 cd test-website-in-workspace
 yarn build
 yarn start

package/bin/index.js

@@ -38,6 +38,7 @@ program
     'Do not run package manager immediately after scaffolding',
   )
   .option('-t, --typescript', 'Use the TypeScript template variant')
+  .option('-j, --javascript', 'Use the JavaScript template variant')
   .option(
     '-g, --git-strategy <strategy>',
     `Only used if the template is a git repository.

package/lib/index.d.ts

@@ -4,10 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-type CLIOptions = {
+type LanguagesOptions = {
+    javascript?: boolean;
+    typescript?: boolean;
+};
+type CLIOptions = LanguagesOptions & {
     packageManager?: PackageManager;
     skipInstall?: boolean;
-    typescript?: boolean;
     gitStrategy?: GitStrategy;
 };
 declare const lockfileNames: {

package/lib/index.js

@@ -12,7 +12,16 @@ import logger from '@docusaurus/logger';
 import shell from 'shelljs';
 import prompts from 'prompts';
 import supportsColor from 'supports-color';
-import { escapeShellArg } from '@docusaurus/utils';
+import { escapeShellArg, askPreferredLanguage } from '@docusaurus/utils';
+async function getLanguage(options) {
+    if (options.typescript) {
+        return 'typescript';
+    }
+    if (options.javascript) {
+        return 'javascript';
+    }
+    return askPreferredLanguage();
+}
 // Only used in the rare, rare case of running globally installed create +
 // using --skip-install. We need a default name to show the tip text
 const defaultPackageManager = 'npm';
@@ -93,9 +102,10 @@ async function readTemplates() {
     // Classic should be first in list!
     return _.sortBy(templates, (t) => t.name !== recommendedTemplate);
 }
-async function copyTemplate(template, dest, typescript) {
+async function copyTemplate(template, dest, language) {
     await fs.copy(path.join(templatesDir, 'shared'), dest);
-    await fs.copy(typescript ? template.tsVariantPath : template.path, dest, {
+    const sourcePath = language === 'typescript' ? template.tsVariantPath : template.path;
+    await fs.copy(sourcePath, dest, {
         // Symlinks don't exist in published npm packages anymore, so this is only
         // to prevent errors during local testing
         filter: async (filePath) => !(await fs.lstat(filePath)).isSymbolicLink(),
@@ -117,6 +127,21 @@ function createTemplateChoices(templates) {
         makeNameAndValueChoice('Local template'),
     ];
 }
+async function askTemplateChoice({ templates, cliOptions, }) {
+    return cliOptions.gitStrategy
+        ? 'Git repository'
+        : (await prompts({
+            type: 'select',
+            name: 'template',
+            message: 'Select a template below...',
+            choices: createTemplateChoices(templates),
+        }, {
+            onCancel() {
+                logger.error('A choice is required.');
+                process.exit(1);
+            },
+        })).template;
+}
 function isValidGitRepoUrl(gitRepoUrl) {
     return ['https://', 'git@'].some((item) => gitRepoUrl.startsWith(item));
 }
@@ -175,143 +200,142 @@ async function getSiteName(reqName, rootDir) {
     }));
     return siteName;
 }
-async function getSource(reqTemplate, templates, cliOptions) {
-    if (reqTemplate) {
-        if (isValidGitRepoUrl(reqTemplate)) {
-            if (cliOptions.gitStrategy &&
-                !gitStrategies.includes(cliOptions.gitStrategy)) {
-                logger.error `Invalid git strategy: name=${cliOptions.gitStrategy}. Value must be one of ${gitStrategies.join(', ')}.`;
-                process.exit(1);
-            }
-            return {
-                type: 'git',
-                url: reqTemplate,
-                strategy: cliOptions.gitStrategy ?? 'deep',
-            };
-        }
-        else if (await fs.pathExists(path.resolve(reqTemplate))) {
-            return {
-                type: 'local',
-                path: path.resolve(reqTemplate),
-            };
-        }
-        const template = templates.find((t) => t.name === reqTemplate);
-        if (!template) {
-            logger.error('Invalid template.');
-            process.exit(1);
-        }
-        if (cliOptions.typescript && !template.tsVariantPath) {
-            logger.error `Template name=${reqTemplate} doesn't provide the TypeScript variant.`;
+async function createTemplateSource({ template, cliOptions, }) {
+    const language = await getLanguage(cliOptions);
+    if (language === 'typescript' && !template.tsVariantPath) {
+        logger.error `Template name=${template.name} doesn't provide a TypeScript variant.`;
+        process.exit(1);
+    }
+    return {
+        type: 'template',
+        template,
+        language,
+    };
+}
+async function getTemplateSource({ templateName, templates, cliOptions, }) {
+    const template = templates.find((t) => t.name === templateName);
+    if (!template) {
+        logger.error('Invalid template.');
+        process.exit(1);
+    }
+    return createTemplateSource({ template, cliOptions });
+}
+// Get the template source explicitly requested by the user provided cli option
+async function getUserProvidedSource({ reqTemplate, templates, cliOptions, }) {
+    if (isValidGitRepoUrl(reqTemplate)) {
+        if (cliOptions.gitStrategy &&
+            !gitStrategies.includes(cliOptions.gitStrategy)) {
+            logger.error `Invalid git strategy: name=${cliOptions.gitStrategy}. Value must be one of ${gitStrategies.join(', ')}.`;
             process.exit(1);
         }
         return {
-            type: 'template',
-            template,
-            typescript: cliOptions.typescript ?? false,
+            type: 'git',
+            url: reqTemplate,
+            strategy: cliOptions.gitStrategy ?? 'deep',
         };
     }
-    const template = cliOptions.gitStrategy
-        ? 'Git repository'
-        : (await prompts({
-            type: 'select',
-            name: 'template',
-            message: 'Select a template below...',
-            choices: createTemplateChoices(templates),
-        }, {
-            onCancel() {
-                logger.error('A choice is required.');
-                process.exit(1);
-            },
-        })).template;
-    if (template === 'Git repository') {
-        const { gitRepoUrl } = (await prompts({
-            type: 'text',
-            name: 'gitRepoUrl',
-            validate: (url) => {
-                if (url && isValidGitRepoUrl(url)) {
-                    return true;
-                }
-                return logger.red('Invalid repository URL');
-            },
-            message: logger.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
-(e.g: url=${'https://github.com/ownerName/repoName.git'})`,
-        }, {
-            onCancel() {
-                logger.error('A git repo URL is required.');
-                process.exit(1);
-            },
-        }));
-        let strategy = cliOptions.gitStrategy;
-        if (!strategy) {
-            ({ strategy } = (await prompts({
-                type: 'select',
-                name: 'strategy',
-                message: 'How should we clone this repo?',
-                choices: [
-                    { title: 'Deep clone: preserve full history', value: 'deep' },
-                    { title: 'Shallow clone: clone with --depth=1', value: 'shallow' },
-                    {
-                        title: 'Copy: do a shallow clone, but do not create a git repo',
-                        value: 'copy',
-                    },
-                    {
-                        title: 'Custom: enter your custom git clone command',
-                        value: 'custom',
-                    },
-                ],
-            }, {
-                onCancel() {
-                    logger.info `Falling back to name=${'deep'}`;
-                },
-            })));
-        }
+    if (await fs.pathExists(path.resolve(reqTemplate))) {
         return {
-            type: 'git',
-            url: gitRepoUrl,
-            strategy: strategy ?? 'deep',
+            type: 'local',
+            path: path.resolve(reqTemplate),
         };
     }
-    else if (template === 'Local template') {
-        const { templateDir } = (await prompts({
-            type: 'text',
-            name: 'templateDir',
-            validate: async (dir) => {
-                if (dir) {
-                    const fullDir = path.resolve(dir);
-                    if (await fs.pathExists(fullDir)) {
-                        return true;
-                    }
-                    return logger.red(logger.interpolate `path=${fullDir} does not exist.`);
-                }
-                return logger.red('Please enter a valid path.');
-            },
-            message: 'Enter a local folder path, relative to the current working directory.',
+    return getTemplateSource({
+        templateName: reqTemplate,
+        templates,
+        cliOptions,
+    });
+}
+async function askGitRepositorySource({ cliOptions, }) {
+    const { gitRepoUrl } = (await prompts({
+        type: 'text',
+        name: 'gitRepoUrl',
+        validate: (url) => {
+            if (url && isValidGitRepoUrl(url)) {
+                return true;
+            }
+            return logger.red('Invalid repository URL');
+        },
+        message: logger.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
+(e.g: url=${'https://github.com/ownerName/repoName.git'})`,
+    }, {
+        onCancel() {
+            logger.error('A git repo URL is required.');
+            process.exit(1);
+        },
+    }));
+    let strategy = cliOptions.gitStrategy;
+    if (!strategy) {
+        ({ strategy } = (await prompts({
+            type: 'select',
+            name: 'strategy',
+            message: 'How should we clone this repo?',
+            choices: [
+                { title: 'Deep clone: preserve full history', value: 'deep' },
+                { title: 'Shallow clone: clone with --depth=1', value: 'shallow' },
+                {
+                    title: 'Copy: do a shallow clone, but do not create a git repo',
+                    value: 'copy',
+                },
+                {
+                    title: 'Custom: enter your custom git clone command',
+                    value: 'custom',
+                },
+            ],
         }, {
             onCancel() {
-                logger.error('A file path is required.');
-                process.exit(1);
+                logger.info `Falling back to name=${'deep'}`;
             },
-        }));
-        return {
-            type: 'local',
-            path: templateDir,
-        };
-    }
-    let useTS = cliOptions.typescript;
-    if (!useTS && template.tsVariantPath) {
-        ({ useTS } = (await prompts({
-            type: 'confirm',
-            name: 'useTS',
-            message: 'This template is available in TypeScript. Do you want to use the TS variant?',
-            initial: false,
         })));
     }
     return {
-        type: 'template',
-        template,
-        typescript: useTS ?? false,
+        type: 'git',
+        url: gitRepoUrl,
+        strategy: strategy ?? 'deep',
+    };
+}
+async function askLocalSource() {
+    const { templateDir } = (await prompts({
+        type: 'text',
+        name: 'templateDir',
+        validate: async (dir) => {
+            if (dir) {
+                const fullDir = path.resolve(dir);
+                if (await fs.pathExists(fullDir)) {
+                    return true;
+                }
+                return logger.red(logger.interpolate `path=${fullDir} does not exist.`);
+            }
+            return logger.red('Please enter a valid path.');
+        },
+        message: 'Enter a local folder path, relative to the current working directory.',
+    }, {
+        onCancel() {
+            logger.error('A file path is required.');
+            process.exit(1);
+        },
+    }));
+    return {
+        type: 'local',
+        path: templateDir,
     };
 }
+async function getSource(reqTemplate, templates, cliOptions) {
+    if (reqTemplate) {
+        return getUserProvidedSource({ reqTemplate, templates, cliOptions });
+    }
+    const template = await askTemplateChoice({ templates, cliOptions });
+    if (template === 'Git repository') {
+        return askGitRepositorySource({ cliOptions });
+    }
+    if (template === 'Local template') {
+        return askLocalSource();
+    }
+    return createTemplateSource({
+        template,
+        cliOptions,
+    });
+}
 async function updatePkg(pkgPath, obj) {
     const pkg = (await fs.readJSON(pkgPath));
     const newPkg = Object.assign(pkg, obj);
@@ -338,7 +362,7 @@ export default async function init(rootDir, reqName, reqTemplate, cliOptions = {
     }
     else if (source.type === 'template') {
         try {
-            await copyTemplate(source.template, dest, source.typescript);
+            await copyTemplate(source.template, dest, source.language);
         }
         catch (err) {
             logger.error `Copying Docusaurus template name=${source.template.name} failed!`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Create Docusaurus apps easily.",
   "type": "module",
   "repository": {
@@ -22,8 +22,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "3.1.0",
-    "@docusaurus/utils": "3.1.0",
+    "@docusaurus/logger": "3.2.0",
+    "@docusaurus/utils": "3.2.0",
     "commander": "^5.1.0",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
@@ -39,5 +39,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "a5e675821f0e8b70b591fcebf19fd60a70d55548"
+  "gitHead": "5af143651b26b39761361acd96e9c5be7ba0cb25"
 }

package/templates/classic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-template",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.0",
-    "@docusaurus/preset-classic": "3.1.0",
+    "@docusaurus/core": "3.2.0",
+    "@docusaurus/preset-classic": "3.2.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
@@ -23,8 +23,8 @@
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.1.0",
-    "@docusaurus/types": "3.1.0"
+    "@docusaurus/module-type-aliases": "3.2.0",
+    "@docusaurus/types": "3.2.0"
   },
   "browserslist": {
     "production": [

package/templates/classic-typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-typescript-template",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,8 +15,8 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.0",
-    "@docusaurus/preset-classic": "3.1.0",
+    "@docusaurus/core": "3.2.0",
+    "@docusaurus/preset-classic": "3.2.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
@@ -24,9 +24,9 @@
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.1.0",
-    "@docusaurus/tsconfig": "3.1.0",
-    "@docusaurus/types": "3.1.0",
+    "@docusaurus/module-type-aliases": "3.2.0",
+    "@docusaurus/tsconfig": "3.2.0",
+    "@docusaurus/types": "3.2.0",
     "typescript": "~5.2.2"
   },
   "browserslist": {

package/templates/shared/docs/tutorial-basics/create-a-blog-post.md

@@ -28,7 +28,7 @@ tags: [greetings]
 
 Congratulations, you have made your first post!
 
-Feel free to play around and edit this post as much you like.
+Feel free to play around and edit this post as much as you like.
 ```
 
 A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).