refactor(*): separate the template from the scaffold

BREAKING CHANGE: The option `-t` of `mili init` command is no long supported. And each template will
become a independent project. If you want to upgrade the template, you need to manually configure
.milirc, then run mili upgrade.

resolve #7

Author: Val-istar-Guo

.gitignore

@@ -22,3 +22,4 @@ package-lock.json
 
 # test
 demo/
+/templates

README.md

@@ -5,48 +5,31 @@
 [![dependencies](https://img.shields.io/david/Val-istar-Guo/mili.svg?style=flat-square)](https://www.npmjs.com/package/mili)
 
 
-## Install
+**Projects that derived from the same scaffolding, have evolved over time and become different.**
+Scaffolding lost control of the subsequent development of the project.
+When we need to improve some of the basic functions of scaffolding(e.g. eslint rules), we need to modify each project, and even have to design a customized solution for some unrecognizable projects.
 
-```bash
-// init an website
-npx mili@latest init
+Therefore, in order to improve the control ability of scaffolding for the subsequent development of the project,
+mili allows scaffolding to cure some files and provide upgrades for this part of the files.
 
-// init an component
-npx mili@latest init -t component
-```
 
 ## Usage
 
-### mili init [option] [app_name]
-
-initial your project.
-if you don't set `app_name`, it will use the name of the current folder.
-by default, mili will init an website project， unless you set the `-t` or `--type`
+```
+npx mili init https://github.com/Val-istar-Guo/mili-template.git
 
+mili upgrade
+```
 
-|   option   |                enum                | default | description |
-|:----------:|------------------------------------|---------|-------------|
-| -t --type  | web, component, pwa, assist-plugin | web     | Which app type to build?
+## Shell
 
+**mili init [option] [repository]**
 
-### mili upgrade
+init project
+options:
+* `-n` or `--app-name` set application name（defaulted: name in package.json || progress.cwd())
 
-upgrade your project
+**mili upgrade**
 
-## Technology Stack
+upgrade you project if then template depended outdated.
 
-- vue
--  - vuex
--  - vue-router
--  - vue-server-renderer
-- koa
--  - koa-router
--  - koa-logger
--  - koa-proxy
--  - koa-static
--  - koa-views
-- superagent
-- chalk
-- webpack
-- babel
-- pm2

bin/init

@@ -1,10 +1,58 @@
 #!/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 { join } = require('path')
-const { copyDir } = require('./utils')
 
+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()))
 
-module.exports = async (type, context) => {
-  const from = join(__dirname, '../template', type)
-  await copyDir({ from, to: process.cwd(), context })
+  // 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模式
+      upgrade: file.upgrade === 'keep' ? 'cover' : file.upgrade,
+      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)
 }

bin/mili

@@ -3,47 +3,50 @@
 const { readdirSync } = require('fs')
 const { join, basename } = require('path')
 const program = require('commander')
-const log = require('./log')
+const log = require('../src/log')
 const init = require('./init')
 const upgrade = require('./upgrade')
-const { version: miliVersion } = require('../package.json')
+const { version } = require('../package.json')
 
 
-const types = readdirSync(join(__dirname, '../template')).reverse()
-
 program
-  .version('0.1.0')
+  .version(version)
 
 program
-  .command('init [app_name]')
+  .command('init [repository]')
+  .usage('[options] <repository>')
   .description('initialize the project')
-  .option('-t --type [type]', `Which app type to build.(${types.join(' | ')})`)
-  .action((appName, option) => {
-    if (!appName) appName = basename(process.cwd())
-
-    const { type = 'web' } = option
-    if (!types.includes(type)) {
-      log.error(
-        'option',
-        `-t --type [type] should be one of ${types.map(t => `'${t}'`).join(', ')}, but get '${type}'.`
-      )
-      return
-    }
+  .option('-n --app-name [app_name]', `Set your app name.`)
+  .action((repository, option) => {
+    if (!repository) program.help()
+
+    const { appName } = option
 
     log.info('initialize project ...')
-    init(type, { appName, miliVersion, encoding: 'utf8' })
+
+    return init(appName, repository)
       .then(() => log.info('initialize complete'))
       .catch(err => log.error('program', 'initialize break', err))
   })
 
 program
   .command('upgrade')
-  .description('upgrade the mili framework')
+  .description('upgrade the template')
   .action(() => {
-    log.info('upgrade project ...')
-    upgrade({ miliVersion, encoding: 'utf8' })
+    log.info('prepare upgrade')
+    upgrade()
       .then(() => log.info('upgrade complete'))
-      .catch(err => log.error('program', 'initialize break', err))
+      .catch(err => log.error('program', 'upgrade break', err))
   })
 
+
+// error on unknown commands
+program.on('command:*', function () {
+  log.error('command', 'Invalid command: %s\nSee --help for a list of available commands.', program.args.join(' '));
+  process.exit(1);
+});
+
+
 program.parse(process.argv)
+
+if (!process.argv.slice(2).length) program.help();

bin/upgrade

@@ -1,113 +1,68 @@
 #!/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 semver = require('semver')
+const { join, basename } = require('path')
 
-const { join, dirname } = require('path')
-const log = require('./log')
-const { copyFile, copyDir, mergePackageJson, readPackageJson } = require('./utils')
 
+module.exports = async () => {
+  const miliConfig = await loadMiliConfig()
+  const repository = miliConfig.repository
 
-const covered = {
-  web: {
-    folders: [
-      'framework',
-      'build',
-      '.github',
-    ],
-    files: [
-      '.babelrc',
-      '.editorconfig',
-      '.gitignore.mustache',
-      '.npmrc.mustache',
-      'webpack.config.babel.js',
-      'package.json.mustache',
-      'ecosystem.config.js',
-      '.huskyrc.yml',
-      '.czrc',
-      '.commitlintrc.yml',
+  console.log(miliConfig)
+  const templateProjectPath = await cloneRepository(repository)
+  const templateConfig = await loadTemplateConfig(templateProjectPath)
 
-      'client/app.vue',
-      'client/entry-ssr.js',
-      'client/entry-client.js',
-      'client/createApp.js',
-      'client/createStore.js',
-      'client/createRouter.js',
-      'client/template.html',
-    ],
-  },
-  component: {
-    folders: [
-      '.github',
-    ],
-    files: [
-      '.babelrc',
-      '.editorconfig',
-      '.gitignore.mustache',
-      '.npmignore.mustache',
-      '.npmrc.mustache',
-      '.huskyrc.yml',
-      '.czrc',
-      '.commitlintrc.yml',
-      'package.json.mustache',
-      'build.config.js',
-      '.travis.yml',
-    ],
-  },
-  pwa: {
-    folders: [
-      'framework',
-      'build',
-      '.github',
-    ],
-    files: [
-      '.babelrc',
-      '.editorconfig',
-      '.gitignore.mustache',
-      '.npmrc.mustache',
-      'webpack.config.babel.js',
-      'package.json.mustache',
-      'ecosystem.config.js',
-      '.huskyrc.yml',
-      '.czrc',
-      '.commitlintrc.yml',
+  // miliConfig
+  if (semver.gte(miliConfig.version, templateConfig.version)) {
+    log.info('The template is already the latest version')
+    return
+  }
 
-      'client/app.vue',
-      'client/entry-ssr.js',
-      'client/entry-client.js',
-      'client/createApp.js',
-      'client/createStore.js',
-      'client/createRouter.js',
-      'client/template.html',
-    ],
-  },
-}
+  const templatePath = join(templateProjectPath, templateConfig.path)
+  const baseInfo = await extractProgectBaseInfo(join(process.cwd()))
 
-const upgrade = async ({ from, to, context, folders, files }) => {
-  const copyDirPromise = folders.map(folder => (
-    copyDir({ from: join(from, folder), to: join(to, folder), context })
-  ))
+  // basename(process.cwd())
+  // OPTIMIZE: Check mili version and remind user
+  // if (templateConfig.version > mili.version)
 
-  const copyFilePromise = files.map(file => (
-    copyFile({ from: join(from, file), to: join(to, file), context })
-  ))
+  let files = await genFileList({ path: templatePath, upgrade: 'cover', handlers: [] }, templateConfig.rules)
 
-  return Promise.all([
-    ...copyDirPromise,
-    ...copyFilePromise,
-  ])
-}
+  const view = checkAndFormatView({
+    name: baseInfo.name || basename(process.cwd()),
+    repository: baseInfo.repository,
+    remotes: baseInfo.remotes,
+    template: { repository, version: templateConfig.version },
+  })
 
-const uninitError = () => {
-  throw new Error('please init project use mili init [app_name]')
-}
 
-module.exports = async (context) => {
-  const config = await readPackageJson(process.cwd(), context)
-  if (!('type' in config.mili)) uninitError()
+  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 { type } = config.mili
-  log.info(`${type} project`)
 
-  const { folders, files } = covered[type]
-  const from = join(__dirname, `../template`, type)
+  log.info('check folder')
+  await initialFolder(files)
 
-  await upgrade({ from, to: process.cwd(), folders, files, context })
+  log.info('upgrading...')
+  await Promise.all(files.map(copy))
+  await genMilirc(targetPath, view)
 }