✨ Adding some commands

README.md

@@ -25,11 +25,15 @@
 
 `readme-md-generator` is able to read your environment (package.json, git config...) to suggest you default answers during the `README.md` creation process :
 
-<img width="700" src="https://user-images.githubusercontent.com/9840435/59162633-8f291b80-8af4-11e9-9985-b0f768cbc2b1.gif" alt="demo"/>
+<div align="center">
+  <img width="700" align="center" src="https://user-images.githubusercontent.com/9840435/59162633-8f291b80-8af4-11e9-9985-b0f768cbc2b1.gif" alt="demo"/>
+</div>
 
 Generated `README.md` :
 
-<img width="700" src="https://user-images.githubusercontent.com/9840435/59162884-02cd2780-8af9-11e9-9765-e1af31fd8bc2.jpg" alt="cli output"/>
+<div align="center">
+  <img width="700" src="https://user-images.githubusercontent.com/9840435/59162884-02cd2780-8af9-11e9-9765-e1af31fd8bc2.jpg" alt="cli output"/>
+</div>
 
 Example of `package.json` with good meta data :
 

src/project-infos.js

@@ -1,6 +1,7 @@
 const getProjectName = require('project-name')
 const isNil = require('lodash/isNil')
 const get = require('lodash/get')
+const has = require('lodash/has')
 const ora = require('ora')
 const { execSync } = require('child_process')
 
@@ -109,6 +110,10 @@ const getProjectInfos = async () => {
   const version = get(packageJson, 'version', undefined)
   const licenseName = get(packageJson, 'license', undefined)
   const homepage = get(packageJson, 'homepage', undefined)
+  const usage = has(packageJson, 'scripts.start') ? 'npm run start' : undefined
+  const testCommand = has(packageJson, 'scripts.test')
+    ? 'npm run test'
+    : undefined
   const repositoryUrl = await getReposUrl(packageJson)
   const contributingUrl = await getReposIssuesUrl(packageJson)
   const isGithubRepos = isGithubRepository(repositoryUrl)
@@ -137,7 +142,9 @@ const getProjectInfos = async () => {
     licenseName,
     licenseUrl,
     documentationUrl,
-    isGithubRepos
+    isGithubRepos,
+    usage,
+    testCommand
   }
 }
 

src/project-infos.spec.js

@@ -79,7 +79,9 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
         documentationUrl:
           'https://github.com/kefranabg/readme-md-generator#readme',
-        isGithubRepos: true
+        isGithubRepos: true,
+        usage: undefined,
+        testCommand: undefined
       })
     })
 
@@ -127,7 +129,9 @@ describe('projectInfos', () => {
         licenseName: 'MIT',
         licenseUrl: undefined,
         documentationUrl: undefined,
-        isGithubRepos: false
+        isGithubRepos: false,
+        usage: undefined,
+        testCommand: undefined
       })
     })
 
@@ -155,7 +159,9 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
         documentationUrl:
           'https://github.com/kefranabg/readme-md-generator#readme',
-        isGithubRepos: true
+        isGithubRepos: true,
+        usage: undefined,
+        testCommand: undefined
       })
     })
 
@@ -181,7 +187,9 @@ describe('projectInfos', () => {
         licenseName: undefined,
         licenseUrl: undefined,
         documentationUrl: undefined,
-        isGithubRepos: false
+        isGithubRepos: false,
+        usage: undefined,
+        testCommand: undefined
       })
     })
 
@@ -206,7 +214,9 @@ describe('projectInfos', () => {
         licenseName: undefined,
         licenseUrl: undefined,
         documentationUrl: undefined,
-        isGithubRepos: false
+        isGithubRepos: false,
+        usage: undefined,
+        testCommand: undefined
       })
     })
 
@@ -256,7 +266,9 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
         documentationUrl:
           'https://github.com/kefranabg/readme-md-generator#readme',
-        isGithubRepos: true
+        isGithubRepos: true,
+        usage: undefined,
+        testCommand: undefined
       })
     })
   })

src/questions/index.js

@@ -10,5 +10,8 @@ module.exports = {
   askProjectPrerequisites: require('./project-prerequisites'),
   askLicenseName: require('./license-name'),
   askLicenseUrl: require('./license-url'),
-  askContributing: require('./contributing')
+  askContributing: require('./contributing'),
+  askInstallCommand: require('./install-command'),
+  askUsage: require('./usage'),
+  askTestCommand: require('./test-command')
 }

src/questions/index.spec.js

@@ -16,7 +16,10 @@ describe('questions', () => {
       'askProjectPrerequisites',
       'askLicenseName',
       'askLicenseUrl',
-      'askContributing'
+      'askContributing',
+      'askInstallCommand',
+      'askUsage',
+      'askTestCommand'
     ])
   })
 })

src/questions/install-command.js

@@ -0,0 +1,6 @@
+module.exports = () => ({
+  type: 'input',
+  message: '📦  Install command (use empty value to skip)',
+  name: 'installCommand',
+  default: 'npm install'
+})

src/questions/install-command.spec.js

@@ -0,0 +1,14 @@
+const askInstallCommand = require('./install-command')
+
+describe('askInstallCommand', () => {
+  it('should return correct question format', () => {
+    const result = askInstallCommand()
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '📦  Install command (use empty value to skip)',
+      name: 'installCommand',
+      default: 'npm install'
+    })
+  })
+})

src/questions/test-command.js

@@ -0,0 +1,6 @@
+module.exports = projectInfos => ({
+  type: 'input',
+  message: '✅  Test command (use empty value to skip)',
+  name: 'testCommand',
+  default: projectInfos.testCommand
+})

src/questions/test-command.spec.js

@@ -0,0 +1,17 @@
+const askTestCommand = require('./test-command')
+
+describe('askTestCommand', () => {
+  it('should return correct question format', () => {
+    const testCommand = 'npm run test'
+    const projectInfos = { testCommand }
+
+    const result = askTestCommand(projectInfos)
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '✅  Test command (use empty value to skip)',
+      name: 'testCommand',
+      default: testCommand
+    })
+  })
+})

src/questions/usage.js

@@ -0,0 +1,6 @@
+module.exports = projectInfos => ({
+  type: 'input',
+  message: '🚀  Usage command or instruction (use empty value to skip)',
+  name: 'usage',
+  default: projectInfos.usage
+})

src/questions/usage.spec.js

@@ -0,0 +1,17 @@
+const askUsage = require('./usage')
+
+describe('askUsage', () => {
+  it('should return correct question format', () => {
+    const usage = 'npm start'
+    const projectInfos = { usage }
+
+    const result = askUsage(projectInfos)
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '🚀  Usage command or instruction (use empty value to skip)',
+      name: 'usage',
+      default: usage
+    })
+  })
+})

src/readme.spec.js

@@ -82,7 +82,11 @@ describe('readme', () => {
       licenseName: 'MIT',
       licenseUrl:
         'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
-      contributingUrl: 'https://github.com/kefranabg/readme-md-generator/issues'
+      contributingUrl:
+        'https://github.com/kefranabg/readme-md-generator/issues',
+      installCommand: 'npm install',
+      usage: 'npm start',
+      testCommand: 'npm run test'
     }
 
     afterEach(() => {
@@ -130,13 +134,13 @@ describe('readme', () => {
 ## 📦 Install
 
 \`\`\`sh
-npm i
+npm install
 \`\`\`
 
 ## 🚀 Usage
 
 \`\`\`sh
-npm run start
+npm start
 \`\`\`
 
 ## ✅ Run tests

templates/default.md

@@ -35,24 +35,30 @@
 
 - <%= projectPrerequisites.join("\n- "); %>
 <% } -%>
+<% if (installCommand) { -%>
 
 ## 📦 Install
 
 ```sh
-npm i
+<%= installCommand %>
 ```
+<% } -%>
+<% if (usage) { -%>
 
 ## 🚀 Usage
 
 ```sh
-npm run start
+<%= usage %>
 ```
+<% } -%>
+<% if (testCommand) { -%>
 
 ## ✅ Run tests
 
 ```sh
-npm run test
+<%= testCommand %>
 ```
+<% } -%>
 <% if (contributingUrl) { -%>
 
 ## 🤝 Contributing