Skip to content

Allow presets to create README.md #4802

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

Closed
tobyzerner opened this issue Nov 6, 2019 · 1 comment · Fixed by #5472 or javascript-indonesias/vue-cli#114
Closed

Allow presets to create README.md #4802

tobyzerner opened this issue Nov 6, 2019 · 1 comment · Fixed by #5472 or javascript-indonesias/vue-cli#114

Comments

@tobyzerner
Copy link

tobyzerner commented Nov 6, 2019

What problem does this feature solve?

When creating a project, the README.md file is generated after the preset/plugins have been invoked. So even if a preset or a plugin renders a README.md file in its generator, it gets overwritten by the one generated by vue create.

What does the proposed API look like?

The simplest solution would probably be just to check if a README.md file already exists before generating a new one.

@nickbreen
Copy link

As a workaround, onCreateComplete fires after README.md is written to disk. E.g.

api.onCreateComplete(() => fs.unlink('README.md))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants