feat(merge-handler): support merge gitignore file

Author: Val-istar-Guo

src/apply-template/copy-files.js

@@ -20,7 +20,7 @@ const commentator = [
     ].join('\n')),
   },
   {
-    filenames: ['.gitignore', '.npmrc'],
+    filenames: ['.npmrc'],
     extnames: ['.yml', '.yaml'],
     create: (upgrade) => ([
       `# mili upgrade type: ${upgrade}`,

src/handlers/merge/index.js

@@ -0,0 +1,27 @@
+const log = require('../../utils/log')
+const { extname, basename } = require('path')
+const createHandler = require('../create-handler')
+const readTargetFile = require('../read-target-file')
+const mergeJson = require('./merge-json')
+const mergeGitignore = require('./merge-gitignore')
+
+
+module.exports = createHandler(file => {
+  file = readTargetFile(file)
+
+  if (file.targetFile.exist) {
+    if (extname(file.targetPath) === '.json') return mergeJson(file)
+    else if (basename(file.targetPath) === '.gitignore') return mergeGitignore(file)
+    else {
+      log.error('merge', [
+        `Merge files of this type(${extname(file.targetPath)}) are not supported by mili`,
+        'please confirm if the loaded template supports the current mili version,',
+        'and feedback this question to the template developer.',
+        'The current file will be overwritten directly by the template file.',
+        `path: ${file.targetPath}`
+      ].join('\n'))
+    }
+  }
+
+  return file
+})

src/handlers/merge/merge-gitignore.js

@@ -0,0 +1,47 @@
+module.exports = file => {
+  const ignoreList = file.content.split('\n')
+  const projectIgnoreList = file.targetFile.content.split('\n')
+
+
+  let mergedList = []
+  let lastIgnoreListIndex = 0
+  let lastProjectIgnoreListIndex = 0
+
+  ignoreList.forEach((item, index) => {
+
+    let i = projectIgnoreList
+      .slice(lastProjectIgnoreListIndex)
+      .findIndex(value => value === item)
+    i = i === -1 ? -1 : i + lastProjectIgnoreListIndex
+
+    if (i !== -1 && lastProjectIgnoreListIndex < i) {
+      mergedList.push(...ignoreList.slice(lastIgnoreListIndex, index))
+
+      const lastProjectListFragment = projectIgnoreList
+        .slice(lastProjectIgnoreListIndex, i)
+        .filter(item => !ignoreList.includes(item) && item.length)
+      mergedList.push(...lastProjectListFragment)
+
+      lastIgnoreListIndex = index
+      lastProjectIgnoreListIndex = i
+    } else if (index === ignoreList.length - 1) {
+      mergedList.push(...ignoreList.slice(lastIgnoreListIndex))
+      const lastProjectListFragment = projectIgnoreList
+        .slice(lastProjectIgnoreListIndex)
+        .filter(item => !ignoreList.includes(item) && item.length)
+      mergedList.push(...lastProjectListFragment)
+    }
+  })
+
+
+  mergedList = mergedList.reduce((list, item) => {
+    if (!item.length || !list.includes(item)) list.push(item)
+    return list
+  }, [])
+
+
+  return {
+    ...file,
+    content: mergedList.join('\n'),
+  }
+}

src/handlers/merge.js renamed to src/handlers/merge/merge-json.js

@@ -1,11 +1,7 @@
-const log = require('../utils/log')
-const { extname } = require('path')
-const createHandler = require('./create-handler')
-const readTargetFile = require('./read-target-file')
-const merge = require('merge-deep');
+const merge = require('merge-deep')
 
 
-const mergeJson = file => {
+module.exports = file => {
   let content = ''
   let targetFileContent = ''
 
@@ -36,22 +32,3 @@ const mergeJson = file => {
     content: JSON.stringify(merge(targetFileContent, content), null, '  ')
   }
 }
-
-module.exports = createHandler(file => {
-  file = readTargetFile(file)
-
-  if (file.targetFile.exist) {
-    if (extname(file.targetPath) === '.json') return mergeJson(file)
-    else {
-      log.error('merge', [
-        `Merge files of this type(${extname(file.targetPath)}) are not supported by mili`,
-        'please confirm if the loaded template supports the current mili version,',
-        'and feedback this question to the template developer.',
-        'The current file will be overwritten directly by the template file.',
-        `path: ${file.targetPath}`
-      ].join('\n'))
-    }
-  }
-
-  return file
-})

test/handlers/merge-gitignore.js

@@ -0,0 +1,11 @@
+const mergeGitignore = require('../../src/handlers/merge/merge-gitignore')
+
+
+const file = {
+  content: 'x\na\nb\nd\ne\nt',
+  targetFile: {
+    content: 'b\na\nc\ne\nf',
+  },
+}
+
+console.log(mergeGitignore(file))