create-docusaurus 0.0.0-4626 → 0.0.0-4629

package/bin/index.js

@@ -36,14 +36,17 @@ program.version(packageJson.version);
 
 program
   .arguments('[siteName] [template] [rootDir]')
-  .option('--use-npm', 'Use NPM as package manage even with Yarn installed')
   .option(
-    '--skip-install',
+    '-p, --package-manager <manager>',
+    'The package manager used to install dependencies. One of yarn, npm, and pnpm.',
+  )
+  .option(
+    '-s, --skip-install',
     'Do not run package manager immediately after scaffolding',
   )
-  .option('--typescript', 'Use the TypeScript template variant')
+  .option('-t, --typescript', 'Use the TypeScript template variant')
   .option(
-    '--git-strategy <strategy>',
+    '-g, --git-strategy <strategy>',
     `Only used if the template is a git repository.
 \`deep\`: preserve full history
 \`shallow\`: clone with --depth=1
@@ -56,10 +59,10 @@ program
       siteName,
       template,
       rootDir = '.',
-      {useNpm, skipInstall, typescript, gitStrategy} = {},
+      {packageManager, skipInstall, typescript, gitStrategy} = {},
     ) => {
       wrapCommand(init)(path.resolve(rootDir), siteName, template, {
-        useNpm,
+        packageManager,
         skipInstall,
         typescript,
         gitStrategy,

package/lib/index.d.ts

@@ -4,9 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+declare const SupportedPackageManagers: {
+    npm: string;
+    yarn: string;
+    pnpm: string;
+};
+declare type SupportedPackageManager = keyof typeof SupportedPackageManagers;
 declare const gitStrategies: readonly ["deep", "shallow", "copy", "custom"];
 export default function init(rootDir: string, siteName?: string, reqTemplate?: string, cliOptions?: Partial<{
-    useNpm: boolean;
+    packageManager: SupportedPackageManager;
     skipInstall: boolean;
     typescript: boolean;
     gitStrategy: typeof gitStrategies[number];

package/lib/index.js

@@ -14,6 +14,8 @@ import supportsColor from 'supports-color';
 import { fileURLToPath } from 'url';
 const RecommendedTemplate = 'classic';
 const TypeScriptTemplateSuffix = '-typescript';
+// 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';
 const SupportedPackageManagers = {
     npm: 'package-lock.json',
@@ -33,13 +35,31 @@ async function findPackageManagerFromLockFile() {
 function findPackageManagerFromUserAgent() {
     return PackageManagersList.find((packageManager) => { var _a; return (_a = process.env.npm_config_user_agent) === null || _a === void 0 ? void 0 : _a.startsWith(packageManager); });
 }
-async function getPackageManager(forceUseNpm) {
-    var _a, _b;
-    // TODO replace --use-npm by --package-manager option
-    if (forceUseNpm) {
+async function askForPackageManagerChoice() {
+    const hasYarn = shell.exec('yarn --version', { silent: true }).code === 0;
+    const hasPNPM = shell.exec('pnpm --version', { silent: true }).code === 0;
+    if (!hasYarn && !hasPNPM) {
         return 'npm';
     }
-    return ((_b = (_a = (await findPackageManagerFromLockFile())) !== null && _a !== void 0 ? _a : findPackageManagerFromUserAgent()) !== null && _b !== void 0 ? _b : DefaultPackageManager);
+    const choices = ['npm', hasYarn && 'yarn', hasPNPM && 'pnpm']
+        .filter((p) => Boolean(p))
+        .map((p) => ({ title: p, value: p }));
+    return (await prompts({
+        type: 'select',
+        name: 'packageManager',
+        message: 'Select a package manager...',
+        choices,
+    })).packageManager;
+}
+async function getPackageManager(packageManagerChoice, skipInstall = false) {
+    var _a, _b;
+    if (packageManagerChoice &&
+        !PackageManagersList.includes(packageManagerChoice)) {
+        throw new Error(`Invalid package manager choice ${packageManagerChoice}. Must be one of ${PackageManagersList.join(', ')}`);
+    }
+    return ((_b = (_a = packageManagerChoice !== null && packageManagerChoice !== void 0 ? packageManagerChoice : (await findPackageManagerFromLockFile())) !== null && _a !== void 0 ? _a : findPackageManagerFromUserAgent()) !== null && _b !== void 0 ? _b : 
+    // This only happens if the user has a global installation in PATH
+    (skipInstall ? DefaultPackageManager : askForPackageManagerChoice()));
 }
 function isValidGitRepoUrl(gitRepoUrl) {
     return ['https://', 'git@'].some((item) => gitRepoUrl.startsWith(item));
@@ -115,7 +135,6 @@ async function getGitCommand(gitStrategy) {
 }
 export default async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
     var _a;
-    const pkgManager = await getPackageManager(cliOptions.useNpm);
     const templatesDir = fileURLToPath(new URL('../templates', import.meta.url));
     const templates = await readTemplates(templatesDir);
     const hasTS = (templateName) => fs.pathExists(path.resolve(templatesDir, `${templateName}${TypeScriptTemplateSuffix}`));
@@ -282,6 +301,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
     }
     // Display the most elegant way to cd.
     const cdpath = path.relative('.', dest);
+    const pkgManager = await getPackageManager(cliOptions.packageManager, cliOptions.skipInstall);
     if (!cliOptions.skipInstall) {
         shell.cd(dest);
         logger.info `Installing dependencies with name=${pkgManager}...`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "0.0.0-4626",
+  "version": "0.0.0-4629",
   "description": "Create Docusaurus apps easily.",
   "type": "module",
   "repository": {
@@ -22,7 +22,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "0.0.0-4626",
+    "@docusaurus/logger": "0.0.0-4629",
     "commander": "^5.1.0",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.21",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1a36de8f473e7e7f79779e64748d47745068c89f"
+  "gitHead": "f8c9d534bda3d79388001f20dfb3a621c65b503a"
 }

package/templates/classic/package.json

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