@gx-design-vue/create-gx-cli 0.1.5 → 0.1.7

package/README.md

@@ -10,6 +10,15 @@ npm init @gx-design-vue/create-gx-cli
 npx @gx-design-vue/create-gx-cli
 # or
 npm install -g @gx-design-vue/create-gx-cli
+
+# create project
 create-gx-cli
+# cli version
+create-gx-cli -v
+# short create(first: project name、--template: template project)
+create-gx-cli app --template gx-design-pro
+create-gx-cli app --template gx-design-thin
+create-gx-cli app --template mobile-vant-cli
+create-gx-cli app --template mobile-vant-html
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gx-design-vue/create-gx-cli",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "license": "MIT",
   "description": "a cli to bootstrap gx project",
   "main": "src/index.js",
@@ -15,14 +15,15 @@
   "author": "gx12358",
   "dependencies": {
     "chalk": "^2.4.2",
+    "child_process": "^1.0.2",
     "esm": "^3.2.18",
+    "execa": "^8.0.1",
     "inquirer": "^6.2.2",
     "kolorist": "^1.6.0",
     "listr": "^0.14.3",
     "minimist": "^1.2.7",
     "nanospinner": "^1.1.0",
     "ncp": "^2.0.0",
-    "obtain-git-repo": "^1.0.2",
     "prompts": "^2.4.1"
   },
   "files": [

package/src/cli.js

@@ -1,9 +1,14 @@
+import chalk from 'chalk'
 import minimist from 'minimist'
 import prompts from 'prompts'
 import { yellow, reset, blue, red, green } from 'kolorist'
 import { createProject } from './main'
 
-const defaultTargetDir = 'gx-cli-project'
+import pag from '../package.json'
+
+const { version } = pag
+
+const defaultTargetDir = 'vue3-project'
 
 const FRAMEWORKS = [
   {
@@ -37,20 +42,24 @@ function parseArgumentsIntoOptions() {
   const argTargetDir = formatTargetDir(argv._[0])
   const argTemplate = argv.template || argv.t
   return {
+    v: argv.v,
     template: argTemplate,
     projectName: argTargetDir
   }
 }
 
 async function promptForMissingOptions(options) {
-  const answers = await prompts([
-    {
+  const projectNamePrompts = []
+  if (!options.projectName) {
+    projectNamePrompts.push({
       type: options.projectName ? null : 'text',
       name: 'projectName',
       message: reset('Project name:'),
       initial: defaultTargetDir
-    },
-    {
+    })
+  }
+  if (typeof options.template !== 'string' || !TEMPLATES.includes(options.template)) {
+    projectNamePrompts.push({
       type: 'select',
       name: 'template',
       message:
@@ -66,20 +75,36 @@ async function promptForMissingOptions(options) {
           value: framework
         }
       })
-    }
-  ])
+    })
+  }
+  let answers = {
+    template: {
+      name: ''
+    },
+    projectName: ''
+  }
+
+  if (projectNamePrompts.length) {
+    answers = await prompts(projectNamePrompts)
+  }
 
   return {
     ...options,
-    template: options.template || answers.template ? answers.template.name : '',
+    template: options.template || (answers.template ? answers.template.name : ''),
     projectName: options.projectName || answers.projectName || ''
   }
 }
 
 export async function cli() {
   let options = parseArgumentsIntoOptions()
+  if (options.v) {
+    console.log(chalk.whiteBright(version))
+    process.exit(1)
+  }
   options = await promptForMissingOptions(options)
   if (options.template && options.projectName) {
     await createProject(options)
+  } else {
+    process.exit(1)
   }
 }

package/src/git.js

@@ -0,0 +1,76 @@
+import { spawn } from 'child_process'
+
+function git(opts) {
+  return opts.git || 'git'
+}
+
+function buildCloneCommand(repo, targetPath, opts) {
+  let args = [ 'clone' ]
+  const userArgs = opts.args || []
+
+  if (opts.shallow) {
+    if (userArgs.indexOf('--depth') >= 0) {
+      throw new Error('\'--depth\' cannot be specified when shallow is set to \'true\'')
+    }
+    args.push('--depth', '1')
+  }
+
+  if (opts.progress) {
+    args.push('--progress')
+  }
+
+  args = args.concat(userArgs)
+  args.push('--', repo, targetPath)
+
+  return [ git(opts), args ]
+}
+
+function buildCheckoutCommand(ref, opts) {
+  return [ git(opts), [ 'checkout', ref ] ]
+}
+
+export function clone(repo, targetPath, opts, onSuccess, onError) {
+  const [ cmd, args ] = buildCloneCommand(repo, targetPath, opts)
+  const proc = spawn(cmd, args)
+
+  if (opts.progress) {
+    proc.stderr.on('data', (evt) => {
+      const line = evt.toString()
+      if (line.match(/Receiving objects:\s+(\d+)%/)) {
+        opts.progress({
+          phase: 'receivingObjects',
+          percent: Number(RegExp.$1)
+        })
+      } else if (line.match(/Resolving deltas:\s+(\d+)%/)) {
+        opts.progress({
+          phase: 'resolvingDeltas',
+          percent: Number(RegExp.$1)
+        })
+      }
+    })
+  }
+
+  proc.on('close', (status) => {
+    if (status == 0) {
+      if (opts.checkout) {
+        _checkout()
+      } else {
+        onSuccess()
+      }
+    } else {
+      onError(new Error('\'git clone\' failed with status ' + status))
+    }
+  })
+
+  function _checkout() {
+    const [ cmd, args ] = buildCheckoutCommand(opts.checkout, opts)
+    const proc = spawn(cmd, args, { cwd: targetPath })
+    proc.on('close', function (status) {
+      if (status == 0) {
+        onSuccess()
+      } else {
+        onError(new Error('\'git checkout\' failed with status ' + status))
+      }
+    })
+  }
+}

package/src/main.js

@@ -1,23 +1,34 @@
 import chalk from 'chalk'
 import fs from 'fs'
+import { reset } from 'kolorist'
+import prompts from 'prompts'
 import { fileURLToPath } from 'url'
 import Listr from 'listr'
 import ncp from 'ncp'
 import path from 'path'
 import { promisify } from 'util'
 import { createSpinner } from 'nanospinner'
-import { download } from 'obtain-git-repo'
+import { clone } from './git'
 
 const copy = promisify(ncp)
 
 const gitRepositoryList = [
   {
     name: 'gx-design-pro',
-    git: 'https://gitee.com/gx12358/vue3-antd-admin.git'
+    children: [
+      {
+        name: 'Gitee',
+        url: 'https://gitee.com/gx12358/vue3-antd-admin.git',
+      },
+      {
+        name: 'Github',
+        url: 'https://github.com/gx12358/vue3-antd-admin.git',
+      }
+    ]
   },
   {
     name: 'gx-design-thin',
-    git: 'https://gitee.com/gx12358/gx-admin-thin.git'
+    url: 'https://gitee.com/gx12358/gx-admin-thin.git'
   }
 ]
 
@@ -64,19 +75,35 @@ function doneLog(cwd, root) {
   if (root !== cwd) {
     console.log(chalk.blueBright(`cd ${path.relative(cwd, root)}`))
   }
-  console.log(chalk.blueBright(`pnpm(yarn、npm) install`))
-  console.log(chalk.blueBright(`pnpm(yarn、npm) run dev`))
+  console.log(chalk.blueBright(`pnpm、yarn、npm install`))
+  console.log(chalk.blueBright(`pnpm、yarn、npm run dev`))
   console.log()
 }
 
+function getProjectName(projectName) {
+  return projectName === '.' ? path.basename(path.resolve()) : projectName
+}
+
+function download(url, root, projectName) {
+  const spinner = createSpinner(`开始下载...${url}`).start()
+  // 下载git代码
+  clone(`${url}`, root, { clone: true }, async () => {
+    await editPackageJson(root, projectName || getProjectName(projectName))
+    spinner.success({
+      text: '项目创建成功，请依次执行以下命令'
+    })
+    doneLog(process.cwd(), root)
+  },async function (err) {
+    console.log(err)
+    spinner.error({ text: '下载失败' })
+  })
+}
+
 export async function createProject(options) {
   const cwd = process.cwd()
 
   const root = path.join(cwd, options.projectName)
 
-  const getProjectName = () =>
-    options.projectName === '.' ? path.basename(path.resolve()) : options.projectName
-
   const downloadGit = gitRepositoryList.find(el => el.name === options.template)
 
   const templateDir = path.resolve(
@@ -103,19 +130,25 @@ export async function createProject(options) {
   }
 
   if (downloadGit) {
-    const spinner = createSpinner(`开始下载...${downloadGit.git}`).start()
-    // 下载git代码
-    download(`direct:${downloadGit.git}`, root, { clone: true }, async function (err) {
-      if (err) {
-        spinner.error({ text: '下载失败' })
-      } else {
-        await editPackageJson(root, options.projectName || getProjectName())
-        spinner.success({
-          text: '项目创建成功，请依次执行以下命令'
-        })
-        fs.doneLog(cwd, root)
-      }
-    })
+    if (downloadGit.children && downloadGit.children.length > 0) {
+      prompts([
+        {
+          type: 'select',
+          name: 'url',
+          message: reset('Select a Url:'),
+          choices: downloadGit.children.map((item) => {
+            return {
+              title: item.name,
+              value: item.url
+            }
+          })
+        }
+      ]).then(answers => {
+        if (answers.url) download(answers.url, root, options.projectName)
+      })
+    } else if (downloadGit.url) {
+      download(downloadGit.url, root, options.projectName)
+    }
   } else {
     const tasks = new Listr(
       [
@@ -125,7 +158,7 @@ export async function createProject(options) {
         },
         options.template !== 'mobile-vant-html' ? {
           title: '初始化项目',
-          task: () => editPackageJson(root, options.projectName || getProjectName())
+          task: () => editPackageJson(root, options.projectName || getProjectName(options.projectName))
         } : {}
       ],
       {

package/template-mobile-vant-cli/package.json

@@ -54,4 +54,4 @@
     "vite-plugin-vue-setup-extend": "^0.4.0",
     "vue-tsc": "^1.8.27"
   }
-}
+}