feat: add a comment indicating the upgrade type of file

resolve #15

Author: Val-istar-Guo

bin/init

@@ -42,7 +42,6 @@ module.exports = async (name, repository) => {
       ...file,
       view,
       // 初始化仓库需要将所有keep模式更为cover模式
-      upgrade: file.upgrade === 'keep' ? 'cover' : file.upgrade,
       encoding: file.encoding || recommendFileEncoding(file.path),
     }))
     .map(formatHandlers)

package.json

@@ -46,9 +46,9 @@
     "commander": "^2.19.0",
     "cosmiconfig": "^5.0.6",
     "merge-deep": "^3.0.2",
+    "mustache": "^3.0.0",
     "sanitization": "^0.3.0",
     "semver": "^5.6.0",
-    "simple-git": "^1.104.0",
-    "mustache": "^3.0.0"
+    "simple-git": "^1.104.0"
   }
 }

src/copy.js

@@ -1,24 +1,65 @@
 const fs = require('fs')
+const { extname, basename } = require('path')
 const { promisify } = require('util')
-const { join, dirname } = require('path')
 
 
 const readFile = promisify(fs.readFile)
 const writeFile = promisify(fs.writeFile)
-const access = promisify(fs.access)
-const mkdir = promisify(fs.mkdir)
 
+const commentator = [
+  {
+    filenames: [],
+    extnames: ['.js', '.ts'],
+    create: (upgrade) => ([
+      `// mili upgrade type: ${upgrade}`,
+    ].join('\n')),
+  },
+  {
+    filenames: [],
+    extnames: ['.md'],
+    create: (upgrade) => ([
+      `<!-- mili upgrade type: ${upgrade} -->`,
+    ].join('\n')),
+  },
+  {
+    filenames: ['.gitignore', '.npmrc'],
+    extnames: ['.yml', '.yaml'],
+    create: (upgrade) => ([
+      `# mili upgrade type: ${upgrade}`,
+    ].join('\n')),
+  },
+]
 
 
-module.exports = async ({ path, view , handlers, encoding, targetPath }, root) => {
+const appendFileHeader = file => {
+  const ext = extname(file.targetPath)
+  const filename = basename(file.targetPath)
+  const cm = commentator.find(handler => (
+    handler.extnames.includes(ext) || handler.filenames.includes(filename)
+  ))
 
-  // 提前做
-  // await ensureDirectoryExistence(targetPath)
+  if (!cm) return file
+
+  if (file.upgrade === 'cover') {
+    const comment = cm.create(file.upgrade, 'This file will be cover when upgrade template')
+    return { ...file, content: `${comment}\n${file.content}` }
+  } else if (file.upgrade === 'merge') {
+    const comment = cm.create(file.upgrade, 'This file will be merge when upgrade template')
+    return { ...file, content: `${comment}\n${file.content}` }
+  }
+
+  return file
+}
+
+
+module.exports = async ({ upgrade, path, view , handlers, encoding, targetPath }, root) => {
   const content = await readFile(path, encoding)
-  file = handlers.reduce(
+  let file = handlers.reduce(
     (file, handler) => handler.genFile(file),
-    { path, view, content, encoding, targetPath }
+    { path, view, content, upgrade, encoding, targetPath }
   )
 
+  file = appendFileHeader(file)
+
   await writeFile(targetPath, file.content, encoding)
 }