feat: add update command

resolve #16

Author: Val-istar-Guo

bin/init

@@ -13,45 +13,50 @@ const genMilirc = require('../src/genMilirc')
 const copy = require('../src/copy')
 const log = require('../src/log')
 const { join, basename } = require('path')
+const git = require('simple-git/promise')
 
 
 module.exports = async (name, repository) => {
   // const miliConfig = await loadMiliConfig()
-  const templateProjectPath = await cloneRepository(repository)
-  const templateConfig = await loadTemplateConfig(templateProjectPath)
-  const templatePath = join(templateProjectPath, templateConfig.path)
-  const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
-
-  // basename(process.cwd())
-  // OPTIMIZE: Check mili version and remind user
-  // if (templateConfig.version > mili.version)
-
-  let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
-
-  const view = checkAndFormatView({
-    name: name || baseInfo.name || basename(process.cwd()),
-    repository: baseInfo.repository,
-    remotes: baseInfo.remotes,
-    template: { repository, version: templateConfig.version },
-  })
-
-
-  const targetPath = process.cwd()
-  files = files
-    .map(file => ({
-      ...file,
-      view,
-      // 初始化仓库需要将所有keep模式更为cover模式
-      encoding: file.encoding || recommendFileEncoding(file.path),
-    }))
-    .map(formatHandlers)
-    .map(genTargetPath(templatePath, targetPath))
-
-
-  log.info('initial folder')
-  await initialFolder(files)
-
-  log.info('copy files')
-  await Promise.all(files.map(copy))
-  await genMilirc(targetPath, view)
+  const { templatePath: templateProjectPath, currentBranch } = await cloneRepository(repository)
+  try {
+    const templateConfig = await loadTemplateConfig(templateProjectPath)
+    const templatePath = join(templateProjectPath, templateConfig.path)
+    const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
+
+    // basename(process.cwd())
+    // OPTIMIZE: Check mili version and remind user
+    // if (templateConfig.version > mili.version)
+
+    let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
+
+    const view = checkAndFormatView({
+      name: name || baseInfo.name || basename(process.cwd()),
+      repository: baseInfo.repository,
+      remotes: baseInfo.remotes,
+      template: { repository, version: templateConfig.version },
+    })
+
+
+    const targetPath = process.cwd()
+    files = files
+      .map(file => ({
+        ...file,
+        view,
+        // 初始化仓库需要将所有keep模式更为cover模式
+        encoding: file.encoding || recommendFileEncoding(file.path),
+      }))
+      .map(formatHandlers)
+      .map(genTargetPath(templatePath, targetPath))
+
+
+    log.info('initial folder')
+    await initialFolder(files)
+
+    log.info('copy files')
+    await Promise.all(files.map(copy))
+    await genMilirc(targetPath, view)
+  } finally {
+    await git(templateProjectPath).checkout(currentBranch )
+  }
 }

bin/mili

@@ -6,6 +6,7 @@ const program = require('commander')
 const log = require('../src/log')
 const init = require('./init')
 const upgrade = require('./upgrade')
+const update = require('./update')
 const { version } = require('../package.json')
 
 
@@ -39,6 +40,16 @@ program
       .catch(err => log.error('program', 'upgrade break', err))
   })
 
+program
+  .command('update')
+  .description('Update the project with the current version of the template')
+  .action(() => {
+    log.info('prepare update')
+    update()
+      .then(() => log.info('update complete'))
+      .catch(err => log.error('program', 'update break', err))
+  })
+
 
 // error on unknown commands
 program.on('command:*', function () {

bin/update

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+const loadMiliConfig = require('../src/loadMiliConfig')
+const cloneRepository = require('../src/cloneRepository')
+const loadTemplateConfig = require('../src/loadTemplateConfig')
+const extractProgectBaseInfo = require('../src/extractProgectBaseInfo')
+const recommendFileEncoding = require('../src/recommendFileEncoding')
+const genFileList = require('../src/genFileList')
+const formatHandlers = require('../src/formatHandlers')
+const genTargetPath = require('../src/genTargetPath')
+const initialFolder = require('../src/initialFolder')
+const checkAndFormatView = require('../src/checkAndFormatView')
+const genMilirc = require('../src/genMilirc')
+const copy = require('../src/copy')
+const log = require('../src/log')
+const { join, basename } = require('path')
+const git = require('simple-git/promise')
+
+
+module.exports = async () => {
+  const miliConfig = await loadMiliConfig()
+  const repository = miliConfig.repository
+
+  const { templatePath: templateProjectPath, currentBranch  } = await cloneRepository(repository, miliConfig.version)
+  try {
+    const templateConfig = await loadTemplateConfig(templateProjectPath)
+
+    const templatePath = join(templateProjectPath, templateConfig.path)
+    const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
+
+    // basename(process.cwd())
+    // OPTIMIZE: Check mili version and remind user
+    // if (templateConfig.version > mili.version)
+
+    let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
+
+    const view = checkAndFormatView({
+      name: baseInfo.name || basename(process.cwd()),
+      repository: baseInfo.repository,
+      remotes: baseInfo.remotes,
+      template: { repository, version: templateConfig.version },
+    })
+
+
+    const targetPath = process.cwd()
+    files = files
+      .filter(file => file.upgrade !== 'keep')
+      .map(file => ({
+        ...file,
+        view,
+        encoding: file.encoding || recommendFileEncoding(file.path),
+      }))
+      .map(formatHandlers)
+      .map(genTargetPath(templatePath, targetPath))
+
+
+    log.info('check folder')
+    await initialFolder(files)
+
+    log.info('upgrading...')
+    await Promise.all(files.map(copy))
+    await genMilirc(targetPath, view)
+
+  } finally {
+    await git(templateProjectPath).checkout(currentBranch )
+  }
+}

bin/upgrade

@@ -14,55 +14,59 @@ const copy = require('../src/copy')
 const log = require('../src/log')
 const semver = require('semver')
 const { join, basename } = require('path')
+const git = require('simple-git/promise')
 
 
 module.exports = async () => {
   const miliConfig = await loadMiliConfig()
   const repository = miliConfig.repository
 
-  console.log(miliConfig)
-  const templateProjectPath = await cloneRepository(repository)
-  const templateConfig = await loadTemplateConfig(templateProjectPath)
+  const { templatePath: templateProjectPath, currentBranch  } = await cloneRepository(repository)
+  try {
+    const templateConfig = await loadTemplateConfig(templateProjectPath)
 
-  // miliConfig
-  if (semver.gte(miliConfig.version, templateConfig.version)) {
-    log.info('The template is already the latest version')
-    return
-  }
+    // miliConfig
+    if (semver.gte(miliConfig.version, templateConfig.version)) {
+      log.info('The template is already the latest version')
+      return
+    }
 
-  const templatePath = join(templateProjectPath, templateConfig.path)
-  const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
+    const templatePath = join(templateProjectPath, templateConfig.path)
+    const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
 
-  // basename(process.cwd())
-  // OPTIMIZE: Check mili version and remind user
-  // if (templateConfig.version > mili.version)
+    // basename(process.cwd())
+    // OPTIMIZE: Check mili version and remind user
+    // if (templateConfig.version > mili.version)
 
-  let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
+    let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
 
-  const view = checkAndFormatView({
-    name: baseInfo.name || basename(process.cwd()),
-    repository: baseInfo.repository,
-    remotes: baseInfo.remotes,
-    template: { repository, version: templateConfig.version },
-  })
+    const view = checkAndFormatView({
+      name: baseInfo.name || basename(process.cwd()),
+      repository: baseInfo.repository,
+      remotes: baseInfo.remotes,
+      template: { repository, version: templateConfig.version },
+    })
 
 
-  const targetPath = process.cwd()
-  files = files
-    .filter(file => file.upgrade !== 'keep')
-    .map(file => ({
-      ...file,
-      view,
-      encoding: file.encoding || recommendFileEncoding(file.path),
-    }))
-    .map(formatHandlers)
-    .map(genTargetPath(templatePath, targetPath))
+    const targetPath = process.cwd()
+    files = files
+      .filter(file => file.upgrade !== 'keep')
+      .map(file => ({
+        ...file,
+        view,
+        encoding: file.encoding || recommendFileEncoding(file.path),
+      }))
+      .map(formatHandlers)
+      .map(genTargetPath(templatePath, targetPath))
 
 
-  log.info('check folder')
-  await initialFolder(files)
+    log.info('check folder')
+    await initialFolder(files)
 
-  log.info('upgrading...')
-  await Promise.all(files.map(copy))
-  await genMilirc(targetPath, view)
+    log.info('upgrading...')
+    await Promise.all(files.map(copy))
+    await genMilirc(targetPath, view)
+  } finally {
+    await git(templateProjectPath).checkout(currentBranch )
+  }
 }

src/cloneRepository.js

@@ -3,21 +3,44 @@ const git = require('simple-git/promise')
 const { join } = require('path')
 const paths = require('./paths')
 const { promisify } = require('util')
+const throwError = require('./throwError')
 
 
 const access = promisify(fs.access)
 
 
-module.exports = async repository => {
+module.exports = async (repository, version) => {
   const templatePath = join(paths.templates, repository)
 
   try {
     await access(templatePath, fs.constants.F_OK)
     await git(templatePath).pull()
-    // pull new commit
   } catch(err) {
+    // BUG: need delete folder
     await git().clone(repository, templatePath)
   }
 
-  return templatePath
+  const gitT = git(templatePath)
+  const tags = await gitT.tags()
+
+  const branchSummary = await gitT.branch()
+  const currentBranch = branchSummary.current
+
+
+  if (version) {
+    version = `v${version}`
+    if (!tags.all.includes(version)) {
+      throwError([
+        'No corresponding template version was found',
+        'Please confirm that the version number exists in the tags of the template repository.',
+        `Expected template version: ${version}`
+      ].join('\n'))
+    }
+
+    gitT.checkout(version)
+  } else if (tags.latest) {
+    await gitT.checkout(tags.latest)
+  }
+
+  return { templatePath, currentBranch }
 }

src/loadMiliConfig.js

@@ -10,7 +10,12 @@ module.exports = async () => {
   if (result) config = result.config || {}
 
 
-  if (!config.version || !semver.valid(config.version)) throwError([
+  if (!config.version) throwError([
+    'Unable to get template version from .milirc',
+    'Please check if the .milirc file is configured correctly.',
+  ].join('\n'))
+
+  if (!semver.valid(config.version)) throwError([
     'The version number of the template finded in .milirc does not conform to the semver specification',
     'Please check if the .milirc file is configured correctly.',
   ].join('\n'))