From d8e8416850ab1366f4daf331d29ac86e62a16b49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elan=20Ruusam=C3=A4e?= Date: Sat, 26 Mar 2022 17:10:41 +0200 Subject: [PATCH 1/2] Add yarn/npm install to readme on yarn condition --- generators/readme/index.js | 1 + generators/readme/templates/README.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/generators/readme/index.js b/generators/readme/index.js index 84ee877..52b8a50 100644 --- a/generators/readme/index.js +++ b/generators/readme/index.js @@ -84,6 +84,7 @@ module.exports = class extends Generator { }, license: pkg.license, includeCoveralls: this.options.coveralls, + yarn: this.options.yarn, content: this.options.content } ); diff --git a/generators/readme/templates/README.md b/generators/readme/templates/README.md index 123a37a..cb05b60 100644 --- a/generators/readme/templates/README.md +++ b/generators/readme/templates/README.md @@ -7,7 +7,11 @@ if (includeCoveralls) { %> [![Coverage percentage][coveralls-image]][coveralls-u ## Installation ```sh +<% if (yarn) { -%> +$ yarn add <%= projectName %> +<% } else { -%> $ npm install --save <%= projectName %> +<% } -%> ``` ## Usage From aa80b0840bdd097d9ba32791826e24290554856f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elan=20Ruusam=C3=A4e?= Date: Sat, 26 Mar 2022 17:19:57 +0200 Subject: [PATCH 2/2] Add test for readme subgenerator --yarn option --- __tests__/readme.js | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/__tests__/readme.js b/__tests__/readme.js index 53c4769..4866b87 100644 --- a/__tests__/readme.js +++ b/__tests__/readme.js @@ -182,3 +182,29 @@ describe('node:readme --no-coveralls and --generate-into', () => { assert.noFileContent('other/README.md', 'coveralls'); }); }); + +describe('node:readme --yarn', () => { + beforeEach(() => { + return helpers + .run(require.resolve('../generators/readme')) + .withOptions({ + name: 'my-project', + description: 'a cool project', + githubAccount: 'yeoman', + authorName: 'Yeoman', + authorUrl: 'http://yeoman.io', + yarn: true, + coveralls: false + }) + .on('ready', gen => { + gen.fs.writeJSON(gen.destinationPath('package.json'), { + license: 'MIT' + }); + }); + }); + + it('creates and fills contents in README.md', () => { + assert.file('README.md'); + assert.fileContent('README.md', '$ yarn add my-project'); + }); +});