12345678910111213141516171819202122232425262728293031323334 |
- const descriptions = {
- build: 'Compiles and minifies for production',
- serve: 'Compiles and hot-reloads for development',
- lint: 'Lints and fixes files',
- 'test:e2e': 'Run your end-to-end tests',
- 'test:unit': 'Run your unit tests'
- }
- function printScripts (pkg, packageManager) {
- return Object.keys(pkg.scripts || {}).map(key => {
- if (!descriptions[key]) return ''
- return [
- `\n### ${descriptions[key]}`,
- '```',
- `${packageManager} ${packageManager !== 'yarn' ? 'run ' : ''}${key}`,
- '```',
- ''
- ].join('\n')
- }).join('')
- }
- module.exports = function generateReadme (pkg, packageManager) {
- return [
- `# ${pkg.name}\n`,
- '## Project setup',
- '```',
- `${packageManager} install`,
- '```',
- printScripts(pkg, packageManager),
- '### Customize configuration',
- 'See [Configuration Reference](https://cli.vuejs.org/config/).',
- ''
- ].join('\n')
- }
|