feat: handler can remove file

Give the ability to handler that control whether copy file to project

resolve #61

Author: Val-istar-Guo

src/apply-template/copy-files.js

@@ -57,6 +57,9 @@ const copy = async file => {
     { ...file, content, targetPath: file.targetPath }
   )
 
+  // NOTE: Handler may remove file
+  if (!file.render) return
+
   file = appendFileHeader(file)
 
   await fs.writeFile(file.targetPath, file.content, file.encoding)
@@ -65,6 +68,6 @@ const copy = async file => {
 
 module.exports = async config => {
   for (const file of config.template.files) {
-    await copy({ ...file, view: { ...config, custom: {} } })
+    await copy({ ...file, view: { ...config, custom: {}, answers: config.project.answers } })
   }
 }

src/apply-template/init-folder.js

@@ -5,6 +5,6 @@ const { dirname } = require('path')
 // OPTIMIZE: Analyze first, then synchronize the files that can be created synchronously.
 module.exports = async files => {
   for (const file of files) {
-    await fs.ensureDir(dirname(file.targetPath))
+    if (file.render) await fs.ensureDir(dirname(file.targetPath))
   }
 }

src/commands/init.js

@@ -20,6 +20,7 @@ module.exports = async(options = {}) => {
   if (version) checkParams.version(version)
 
   let config = await loadConfig({
+    operation: 'init',
     cwd,
     projectName: name,
     templateRepository: repository,

src/commands/update.js

@@ -24,9 +24,7 @@ module.exports = async options => {
   if (!force) await securityCheck(process.cwd())
   if (version) checkParams.version(version)
 
-
-  let config = await loadConfig({ cwd })
-
+  let config = await loadConfig({ cwd, operation: 'update' })
 
   if (version && semver.lt(version, config.template.version.number)) {
     const message = [
@@ -86,7 +84,6 @@ module.exports = async options => {
   checkParams.engine(config)
 
   await prompt(config)
-  config.template.files = config.template.files.filter(file => file.upgrade !== 'keep')
   await applyTemplate(config)
   await config.template.hooks('afterUpdate')
 }

src/commands/upgrade/upgrade.js

@@ -18,7 +18,7 @@ module.exports = async(options = {}) => {
   } = options
 
   if (!force) await securityCheck(process.cwd())
-  let config = await loadConfig({ cwd })
+  let config = await loadConfig({ cwd, operation: 'upgrade' })
 
 
   const versions = await getTemplateVersions(config.template.repository)
@@ -38,7 +38,6 @@ module.exports = async(options = {}) => {
   checkParams.engine(config)
 
   await prompt(config)
-  config.template.files = config.template.files.filter(file => file.upgrade !== 'keep')
   await applyTemplate(config)
   await config.template.hooks('afterUpgrade')
 

src/handlers/index.js

@@ -3,6 +3,7 @@ const exist = require('./exist')
 const mustache = require('./mustache')
 const extractArea = require('./extract-area')
 const ejs = require('./ejs')
+const removeWhen = require('./remove-when')
 
 
-module.exports = { merge, mustache, ejs, extractArea, exist }
+module.exports = { merge, mustache, ejs, extractArea, exist, removeWhen }

src/handlers/remove-when.js

@@ -0,0 +1,3 @@
+const createHandler = require('./create-handler')
+
+module.exports = func => createHandler(file => ({ ...file, render: func(file.view, file) }))

src/load-config/index.js

@@ -5,7 +5,10 @@ const loadProjectConfig = require('./load-project-config')
 const loadMilirc = require('./load-milirc')
 
 
-const loadConfig = async({ cwd, projectName, templateRepository, templateVersion, loadTemplate }) => {
+const loadConfig = async arg => {
+  const { operation, cwd, projectName, loadTemplate } = arg
+  let { templateRepository, templateVersion } = arg
+
   const milirc = await loadMilirc(cwd)
 
   if (!templateRepository) {
@@ -33,10 +36,11 @@ const loadConfig = async({ cwd, projectName, templateRepository, templateVersion
   }))
 
   return {
+    operation,
     mili,
     template,
     project,
-    reload: (parms = {}) => loadConfig({ cwd, projectName, templateRepository, templateVersion, ...parms }),
+    reload: (parms = {}) => loadConfig({ ...arg, ...parms }),
   }
 }
 

src/load-config/load-template-config/format-rule.js

@@ -28,6 +28,7 @@ module.exports = rule => {
 
   if (rule.upgrade === 'merge') effectiveHandlers.push(handlers.merge)
   if (rule.upgrade === 'exist') effectiveHandlers.push(handlers.exist)
+  if (rule.upgrade === 'keep') effectiveHandlers.push(handlers.removeWhen(config => config.operation === 'init'))
 
   return { ...rule, handlers: effectiveHandlers }
 }

src/load-config/load-template-config/search-files.js

@@ -39,5 +39,6 @@ module.exports = async config => {
       (p, handler) => handler.genPath(p),
       relative(config.path, file.path)
     ),
+    render: true,
   }))
 }