fix: template.path error when reload npm template config

Author: Val-istar-Guo

.lintstagedrc.yml

@@ -1,3 +1,3 @@
-'**/*.{js,jsx}':
+'**/*.{ts}':
   - 'eslint --fix'
   - 'git add'

src/class/repository/npm-repository.ts

@@ -10,9 +10,9 @@ import { Effect } from '@/internal'
 const genIndexFile = (name: string): string => `
 const { join } = require('path')
 const config = require('${name}')
-config.path = join('./node_modules/${name}', config.path)
+const path = join('./node_modules/${name}', config.path)
 
-module.exports = config
+module.exports = { ...config, path }
 `
 
 const exec = promisify(childProcess.exec)

src/class/template.ts

@@ -2,7 +2,7 @@ import Ajv from 'ajv'
 import ajvKeywords from 'ajv-keywords'
 import { join, dirname } from 'path'
 import cosmiconfig from 'cosmiconfig'
-import { unnest } from 'ramda'
+import { unnest, clone } from 'ramda'
 import { loadNpmConfig } from '@/loader'
 import { TemplateSchema, RuleSchema, QuestionSchema } from '@/schema'
 import { isDirectory, logger } from '@/utils'
@@ -119,7 +119,6 @@ export class Template {
 
   public static async load(repo: Repository): Promise<Template> {
     const cwd = repo.storage
-
     let entry = join(cwd, 'index.js')
 
     try {
@@ -128,6 +127,10 @@ export class Template {
     } catch (e) {
     }
 
+    /**
+     * NOTE: don't change the object that return by cosmiconfig.
+     *       It was cache by cosmiconfig
+     */
     const result = await cosmiconfig('template').load(entry)
     if (!result) {
       throw new Error([
@@ -136,7 +139,7 @@ export class Template {
       ].join('\n'))
     }
 
-    const config = result.config
+    const config = clone(result.config)
 
     const valid = validateTemplateConfig(config)
 
@@ -148,15 +151,15 @@ export class Template {
     }
 
     /** absoult template path */
-    config.path = join(cwd, config.path)
+    const path = join(cwd, config.path)
 
     /** generate files */
     const rules = config.rules
-      .map(item => ({ ...item, path: join(config.path, item.path) }))
+      .map(item => ({ ...item, path: join(path, item.path) }))
       .map(item => Rule.format(item))
-    const rootRule = new Rule(config.path, UpgradeType.Cover, true)
+    const rootRule = new Rule(path, UpgradeType.Cover, true)
 
-    const files = await this.searchDirFile(config.path, rootRule, rules)
+    const files = await this.searchDirFile(path, rootRule, rules)
 
     /** generate questions */
     let questions: Questions = []
@@ -170,7 +173,7 @@ export class Template {
     }
 
 
-    return new Template(repo, config.path, config.engines, files, questions, hooks)
+    return new Template(repo, path, config.engines, files, questions, hooks)
   }
 
 

src/loader/load-milirc.ts

@@ -5,6 +5,7 @@ import Ajv from 'ajv'
 import { relativePath, isRelativePath } from '@/utils'
 import { MilircSchema } from '@/schema'
 import { Milirc, Effect } from '@/internal'
+import { clone } from 'ramda'
 
 
 const ajv = new Ajv({ useDefaults: true, nullable: true })
@@ -13,28 +14,29 @@ const validate = ajv.compile(MilircSchema)
 const explorer = cosmiconfig('mili')
 
 export default async(cwd: string): Promise<Milirc | null> => {
-  let config: Milirc | null = null
-
   const filepath = join(cwd, '.milirc.yml')
-  if (!await Effect.fs.pathExists(filepath)) return config
+  if (!await Effect.fs.pathExists(filepath)) return null
 
+  /**
+   * NOTE: don't change the object that return by cosmiconfig.
+   *       It was cache by cosmiconfig
+   */
   const result = await explorer.load(filepath)
-  if (!result || !result.config) return config
-
-  config = JSON.parse(JSON.stringify(result.config))
+  if (!result || !result.config) return null
 
+  const config = clone(result.config)
   if (!config) throw new Error('Cannot load .milirc.yml')
 
-  if (config.mili && semver.lt(config.mili.version, '2.0.0')) throw new Error('Never support auto upgrade from mili@1')
-
   const valid = validate(config)
-
   if (!valid) throw new Error(ajv.errorsText(validate.errors, { dataVar: 'milirc' }))
+  const milirc: Milirc = config as Milirc
+
+  if (semver.lt(milirc.mili.version, '2.0.0')) throw new Error('Never support auto upgrade from mili@1')
 
   /** The relative template path saved in .milirc is relative to the dir of .milirc */
   if (isRelativePath(config.template.repository)) {
     config.template.repository = relativePath(process.cwd(), join(cwd, config.template.repository))
   }
 
-  return config
+  return milirc
 }