Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(creator): do not override the README.md generated by plugins #5472

Merged
merged 1 commit into from May 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -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