create-docusaurus 0.0.0-4565 → 0.0.0-4569

package/bin/index.js

@@ -11,7 +11,7 @@
 const logger = require('@docusaurus/logger').default;
 const semver = require('semver');
 const path = require('path');
-const program = require('commander');
+const {program} = require('commander');
 const {default: init} = require('../lib');
 const requiredVersion = require('../package.json').engines.node;
 
@@ -29,36 +29,41 @@ function wrapCommand(fn) {
     });
 }
 
-program
-  .version(require('../package.json').version)
-  .usage('<command> [options]');
+program.version(require('../package.json').version);
 
 program
-  .command('init [siteName] [template] [rootDir]', {isDefault: true})
-  .option('--use-npm')
-  .option('--skip-install')
-  .option('--typescript')
+  .arguments('[siteName] [template] [rootDir]')
+  .option('--use-npm', 'Use NPM as package manage even with Yarn installed')
+  .option(
+    '--skip-install',
+    'Do not run package manager immediately after scaffolding',
+  )
+  .option('--typescript', 'Use the TypeScript template variant')
+  .option(
+    '--git-strategy <strategy>',
+    `Only used if the template is a git repository.
+\`deep\`: preserve full history
+\`shallow\`: clone with --depth=1
+\`copy\`: do a shallow clone, but do not create a git repo
+\`custom\`: enter your custom git clone command. We will prompt you for it.`,
+  )
   .description('Initialize website.')
   .action(
     (
       siteName,
       template,
       rootDir = '.',
-      {useNpm, skipInstall, typescript} = {},
+      {useNpm, skipInstall, typescript, gitStrategy} = {},
     ) => {
       wrapCommand(init)(path.resolve(rootDir), siteName, template, {
         useNpm,
         skipInstall,
         typescript,
+        gitStrategy,
       });
     },
   );
 
-program.arguments('<command>').action((cmd) => {
-  program.outputHelp();
-  logger.error`Unknown command code=${cmd}.`;
-});
-
 program.parse(process.argv);
 
 if (!process.argv.slice(1).length) {

package/lib/index.d.ts

@@ -4,8 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+declare const gitStrategies: readonly ["deep", "shallow", "copy", "custom"];
 export default function init(rootDir: string, siteName?: string, reqTemplate?: string, cliOptions?: Partial<{
     useNpm: boolean;
     skipInstall: boolean;
     typescript: boolean;
+    gitStrategy: typeof gitStrategies[number];
 }>): Promise<void>;
+export {};

package/lib/index.js

@@ -81,7 +81,27 @@ async function copyTemplate(templatesDir, template, dest) {
         filter: (filePath) => !fs_extra_1.default.lstatSync(filePath).isSymbolicLink(),
     });
 }
+const gitStrategies = ['deep', 'shallow', 'copy', 'custom'];
+async function getGitCommand(gitStrategy) {
+    switch (gitStrategy) {
+        case 'shallow':
+        case 'copy':
+            return 'git clone --recursive --depth 1';
+        case 'custom': {
+            const { command } = await (0, prompts_1.default)({
+                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"',
+            });
+            return command;
+        }
+        case 'deep':
+        default:
+            return 'git clone';
+    }
+}
 async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
+    var _a;
     const useYarn = cliOptions.useNpm ? false : hasYarn();
     const templatesDir = path_1.default.resolve(__dirname, '../templates');
     const templates = readTemplates(templatesDir);
@@ -127,6 +147,7 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
             useTS = tsPrompt.useTS;
         }
     }
+    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)({
@@ -141,6 +162,20 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
             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'})`,
         });
+        ({ gitStrategy } = await (0, prompts_1.default)({
+            type: 'select',
+            name: 'gitStrategy',
+            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' },
+            ],
+        }));
         template = repoPrompt.gitRepoUrl;
     }
     else if (template === 'Local template') {
@@ -168,11 +203,18 @@ async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
     logger_1.default.info('Creating new Docusaurus project...');
     if (isValidGitRepoUrl(template)) {
         logger_1.default.info `Cloning Git template path=${template}...`;
-        if (shelljs_1.default.exec(`git clone --recursive ${template} ${dest}`, { silent: true })
-            .code !== 0) {
+        if (!gitStrategies.includes(gitStrategy)) {
+            logger_1.default.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!`;
             process.exit(1);
         }
+        if (gitStrategy === 'copy') {
+            await fs_extra_1.default.remove(path_1.default.join(dest, '.git'));
+        }
     }
     else if (templates.includes(template)) {
         // Docusaurus templates.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "0.0.0-4565",
+  "version": "0.0.0-4569",
   "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
@@ -21,7 +21,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "0.0.0-4565",
+    "@docusaurus/logger": "0.0.0-4569",
     "commander": "^5.1.0",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.20",
@@ -37,5 +37,5 @@
   "devDependencies": {
     "@types/supports-color": "^8.1.1"
   },
-  "gitHead": "58480c4de1725cbcc30a12b6b73bd30ba6655b05"
+  "gitHead": "a7df81db396427f7bab23237363f041d793e3c93"
 }

package/templates/classic/package.json

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