create-docusaurus 3.7.0 → 3.8.0-canary-6327

package/lib/index.js

@@ -9,10 +9,12 @@ import { fileURLToPath } from 'url';
 import path from 'path';
 import _ from 'lodash';
 import { logger } from '@docusaurus/logger';
-import shell from 'shelljs';
+import execa from 'execa';
 import prompts from 'prompts';
 import supportsColor from 'supports-color';
-import { escapeShellArg, askPreferredLanguage } from '@docusaurus/utils';
+// TODO remove dependency on large @docusaurus/utils
+//  would be better to have a new smaller @docusaurus/utils-cli package
+import { askPreferredLanguage } from '@docusaurus/utils';
 async function getLanguage(options) {
     if (options.typescript) {
         return 'typescript';
@@ -45,9 +47,9 @@ function findPackageManagerFromUserAgent() {
     return packageManagers.find((packageManager) => process.env.npm_config_user_agent?.startsWith(packageManager));
 }
 async function askForPackageManagerChoice() {
-    const hasYarn = shell.exec('yarn --version', { silent: true }).code === 0;
-    const hasPnpm = shell.exec('pnpm --version', { silent: true }).code === 0;
-    const hasBun = shell.exec('bun --version', { silent: true }).code === 0;
+    const hasYarn = (await execa.command('yarn --version')).exitCode === 0;
+    const hasPnpm = (await execa.command('pnpm --version')).exitCode === 0;
+    const hasBun = (await execa.command('bun --version')).exitCode === 0;
     if (!hasYarn && !hasPnpm && !hasBun) {
         return 'npm';
     }
@@ -351,8 +353,7 @@ export default async function init(rootDir, reqName, reqTemplate, cliOptions = {
     logger.info('Creating new Docusaurus project...');
     if (source.type === 'git') {
         const gitCommand = await getGitCommand(source.strategy);
-        const gitCloneCommand = `${gitCommand} ${escapeShellArg(source.url)} ${escapeShellArg(dest)}`;
-        if (shell.exec(gitCloneCommand).code !== 0) {
+        if ((await execa(gitCommand, [source.url, dest])).exitCode !== 0) {
             logger.error `Cloning Git template failed!`;
             process.exit(1);
         }
@@ -402,20 +403,20 @@ export default async function init(rootDir, reqName, reqTemplate, cliOptions = {
     const cdpath = path.relative('.', dest);
     const pkgManager = await getPackageManager(dest, cliOptions);
     if (!cliOptions.skipInstall) {
-        shell.cd(dest);
+        process.chdir(dest);
         logger.info `Installing dependencies with name=${pkgManager}...`;
-        if (shell.exec(pkgManager === 'yarn'
+        // ...
+        if ((await execa.command(pkgManager === 'yarn'
             ? 'yarn'
             : pkgManager === 'bun'
                 ? 'bun install'
                 : `${pkgManager} install --color always`, {
             env: {
                 ...process.env,
-                // Force coloring the output, since the command is invoked by
-                // shelljs, which is not an interactive shell
+                // Force coloring the output
                 ...(supportsColor.stdout ? { FORCE_COLOR: '1' } : {}),
             },
-        }).code !== 0) {
+        })).exitCode !== 0) {
             logger.error('Dependency installation failed.');
             logger.info `The site directory has already been created, and you can retry by typing:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "3.7.0",
+  "version": "3.8.0-canary-6327",
   "description": "Create Docusaurus apps easily.",
   "type": "module",
   "repository": {
@@ -22,14 +22,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "3.7.0",
-    "@docusaurus/utils": "3.7.0",
+    "@docusaurus/logger": "3.8.0-canary-6327",
+    "@docusaurus/utils": "3.8.0-canary-6327",
     "commander": "^5.1.0",
+    "execa": "5.1.1",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "prompts": "^2.4.2",
     "semver": "^7.5.4",
-    "shelljs": "^0.8.5",
     "supports-color": "^9.4.0",
     "tslib": "^2.6.0"
   },
@@ -39,5 +39,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
+  "gitHead": "d50539dea74625c994ac3f78926ed7b37d704c84"
 }

package/templates/classic/docusaurus.config.js

@@ -14,6 +14,11 @@ const config = {
   tagline: 'Dinosaurs are cool',
   favicon: 'img/favicon.ico',
 
+  // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
+  future: {
+    v4: true, // Improve compatibility with the upcoming Docusaurus v4
+  },
+
   // Set the production url of your site here
   url: 'https://your-docusaurus-site.example.com',
   // Set the /<baseUrl>/ pathname under which your site is served

package/templates/classic/package.json

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

package/templates/classic-typescript/docusaurus.config.ts

@@ -9,6 +9,11 @@ const config: Config = {
   tagline: 'Dinosaurs are cool',
   favicon: 'img/favicon.ico',
 
+  // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
+  future: {
+    v4: true, // Improve compatibility with the upcoming Docusaurus v4
+  },
+
   // Set the production url of your site here
   url: 'https://your-docusaurus-site.example.com',
   // Set the /<baseUrl>/ pathname under which your site is served

package/templates/classic-typescript/package.json

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

package/templates/shared/README.md

@@ -2,40 +2,40 @@
 
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
-### Installation
+## Installation
 
-```
-$ yarn
+```bash
+yarn
 ```
 
-### Local Development
+## Local Development
 
-```
-$ yarn start
+```bash
+yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-### Build
+## Build
 
-```
-$ yarn build
+```bash
+yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-### Deployment
+## Deployment
 
 Using SSH:
 
-```
-$ USE_SSH=true yarn deploy
+```bash
+USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/templates/shared/blog/authors.yml

@@ -1,12 +1,14 @@
 yangshun:
   name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
+  title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
+  url: https://linkedin.com/in/yangshun
   image_url: https://github.com/yangshun.png
   page: true
   socials:
     x: yangshunz
+    linkedin: yangshun
     github: yangshun
+    newsletter: https://www.greatfrontend.com
 
 slorber:
   name: Sébastien Lorber