Skip to content

Commit

Permalink
fix(creator): do not override the README.md generated by plugins (#5472)
Browse files Browse the repository at this point in the history
closes #4802
closes #4942
  • Loading branch information
sodatea committed May 16, 2020
1 parent 96dfd58 commit 75c398f
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 7 deletions.
@@ -0,0 +1,5 @@
module.exports = (api, options) => {
api.render(files => {
files['README.md'] = 'hello'
})
}
@@ -0,0 +1,5 @@
{
"plugins": {
"@vue/cli-plugin-babel": {}
}
}
20 changes: 20 additions & 0 deletions packages/@vue/cli/__tests__/preset.spec.js
Expand Up @@ -85,3 +85,23 @@ test('should recognize generator/index.js in a local preset directory by async g
expect(pkg.scripts).toHaveProperty('testasync')
})

test('should not override the README.md generated by plugins', async () => {
const cwd = path.resolve(__dirname, '../../../test')
const name = 'test-preset-readme'

await create(
name,
{
force: true,
git: false,
cwd,
preset: path.resolve(__dirname, './mock-preset-with-readme')
}
)

const readme = await fs.readFile(path.resolve(cwd, name, 'README.md'), 'utf-8')
expect(readme).toBe('hello')

const pkg = require(path.resolve(cwd, name, 'package.json'))
expect(pkg.devDependencies).toHaveProperty('@vue/cli-plugin-babel')
})
16 changes: 9 additions & 7 deletions packages/@vue/cli/lib/Creator.js
Expand Up @@ -214,13 +214,15 @@ module.exports = class Creator extends EventEmitter {
await cb()
}

// generate README.md
stopSpinner()
log()
logWithSpinner('📄', 'Generating README.md...')
await writeFileTree(context, {
'README.md': generateReadme(generator.pkg, packageManager)
})
if (!generator.files['README.md']) {
// generate README.md
stopSpinner()
log()
logWithSpinner('📄', 'Generating README.md...')
await writeFileTree(context, {
'README.md': generateReadme(generator.pkg, packageManager)
})
}

// generate a .npmrc file for pnpm, to persist the `shamefully-flatten` flag
if (packageManager === 'pnpm') {
Expand Down

0 comments on commit 75c398f

Please sign in to comment.