✨ Add license url and name auto detection

README.md

@@ -2,6 +2,9 @@
 <p>
   <img src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
   <img src="https://badges.greenkeeper.io/kefranabg/readme-cli.svg" />
+  <a href="https://github.com/kefranabg/readme-cli/blob/master/LICENSE">
+    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" />
+  </a>
 </p>
 > Generates beautiful README files from git config & package.json infos
 
@@ -29,7 +32,7 @@ readme-cli
 
 ## Contributing
 
-Contributions, issues and feature requests are welcome. Feel free to check [issues page](test) if you want to contribute.
+Contributions, issues and feature requests are welcome. Feel free to check [issues page](https://github.com/kefranabg/readme-cli/issues) if you want to contribute.
 
 ## Author
 
@@ -46,7 +49,7 @@ Please ⭐️ this repository if you like it.
 
 Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).
 
-📜 This project is under [license](https://github.com/kefranabg/readme-cli/blob/master/LICENSE).
+📜 This project is [MIT](https://github.com/kefranabg/readme-cli/blob/master/LICENSE) licensed.
 
 ---
 

src/cli.js

@@ -15,28 +15,42 @@ const {
   askLicenseUrl,
   askContributing,
   askProjectVersion,
-  askProjectPrerequisites
+  askProjectPrerequisites,
+  askLicenseName
 } = require('./questions')
 
 /**
  * Ask user questions and return context to generate a README
  */
 const askQuestions = async () => {
   const projectInfos = await getProjectInfos()
+  let answersContext = {}
+  const questionFns = [
+    askProjectName,
+    askProjectVersion,
+    askProjectDescription,
+    askAuhtorName,
+    askAuthorGithub,
+    askAuthorTwitter,
+    askProjectPrerequisites,
+    askLicenseName,
+    askLicenseUrl,
+    askContributing
+  ]
 
-  const questions = [
-    askProjectName(projectInfos),
-    askProjectVersion(projectInfos),
-    askProjectDescription(projectInfos),
-    askAuhtorName(projectInfos),
-    askAuthorGithub(projectInfos),
-    askAuthorTwitter(),
-    askProjectPrerequisites(projectInfos),
-    askLicenseUrl(projectInfos),
-    askContributing(projectInfos)
-  ].filter(negate(isNil)) // Remove undefined items from array
-
-  return inquirer.prompt(questions)
+  for (const questionFn of questionFns) {
+    const question = questionFn(projectInfos, answersContext)
+
+    if (!isNil(question)) {
+      const currentAnswerContext = await inquirer.prompt([question])
+      answersContext = {
+        ...answersContext,
+        ...currentAnswerContext
+      }
+    }
+  }
+
+  return answersContext
 }
 
 module.exports = async args => {

src/questions/index.js

@@ -3,6 +3,7 @@ const askProjectDescription = require('./project-description')
 const askAuhtorName = require('./author-name')
 const askAuthorGithub = require('./author-github')
 const askAuthorTwitter = require('./author-twitter')
+const askLicenseName = require('./license-name')
 const askLicenseUrl = require('./license-url')
 const askContributing = require('./contributing')
 const askProjectVersion = require('./project-version')
@@ -14,6 +15,7 @@ module.exports = {
   askAuhtorName,
   askAuthorGithub,
   askAuthorTwitter,
+  askLicenseName,
   askLicenseUrl,
   askContributing,
   askProjectVersion,

src/questions/license-name.js

@@ -0,0 +1,6 @@
+module.exports = packageJson => ({
+  type: 'input',
+  message: '🔒  License name (use empty value to skip)',
+  name: 'licenseName',
+  default: packageJson.licenseName
+})

src/questions/license-url.js

@@ -1,5 +1,11 @@
-module.exports = () => ({
-  type: 'input',
-  message: '🔒  License url (use empty value to skip)',
-  name: 'licenseUrl'
-})
+const isEmpty = require('lodash/isEmpty')
+
+module.exports = (projectInfos, answersContext) =>
+  isEmpty(answersContext.licenseName)
+    ? undefined
+    : {
+        type: 'input',
+        message: '🔒  License url (use empty value to skip)',
+        name: 'licenseUrl',
+        default: projectInfos.licenseUrl
+      }

src/utils/index.js

@@ -101,16 +101,20 @@ const getReposIssuesUrl = async packageJson => {
  *
  * @param {string} repositoryUrl
  */
-const isGithubRepository = repositoryUrl => repositoryUrl.includes(GITHUB_URL)
+const isGithubRepository = repositoryUrl =>
+  !isNil(repositoryUrl) && repositoryUrl.includes(GITHUB_URL)
 
 /**
  * Get github username from repository url
  *
  * @param {string} repositoryUrl
  */
-const getGithubUsernameFromRepositoryUrl = async repositoryUrl =>
+const getGithubUsernameFromRepositoryUrl = repositoryUrl =>
   repositoryUrl.replace(GITHUB_URL, '').split('/')[0]
 
+const getLicenseUrlFromGithubRepositoryUrl = repositoryUrl =>
+  `${repositoryUrl}/blob/master/LICENSE`
+
 /**
  * Get project informations from git and package.json
  */
@@ -121,12 +125,15 @@ const getProjectInfos = async () => {
   const engines = get(packageJson, 'engines', undefined)
   const author = get(packageJson, 'author', undefined)
   const version = get(packageJson, 'version', undefined)
+  const licenseName = get(packageJson, 'license', undefined)
   const repositoryUrl = await getReposUrl(packageJson)
   const contributingUrl = await getReposIssuesUrl(packageJson)
-  const githubUsername =
-    !isNil(repositoryUrl) && isGithubRepository(repositoryUrl)
-      ? await getGithubUsernameFromRepositoryUrl(repositoryUrl)
-      : undefined
+  const githubUsername = isGithubRepository(repositoryUrl)
+    ? getGithubUsernameFromRepositoryUrl(repositoryUrl)
+    : undefined
+  const licenseUrl = isGithubRepository(repositoryUrl)
+    ? getLicenseUrlFromGithubRepositoryUrl(repositoryUrl)
+    : undefined
 
   return {
     name,
@@ -136,7 +143,9 @@ const getProjectInfos = async () => {
     repositoryUrl,
     contributingUrl,
     githubUsername,
-    engines
+    engines,
+    licenseName,
+    licenseUrl
   }
 }
 

templates/default.md

@@ -3,6 +3,11 @@
 <% if (projectVersion) { -%>
   <img src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
 <% } -%>
+<% if (licenseName && licenseUrl) { -%>
+  <a href="<%= licenseUrl %>">
+    <img alt="License: <%= licenseName %>" src="https://img.shields.io/badge/License-<%= licenseName %>-yellow.svg" target="_blank" />
+  </a>
+<% } -%>
 </p>
 <% if (projectDescription) { -%>
 
@@ -32,11 +37,11 @@ npm run start
 ```sh
 npm run test
 ```
-<% if (licenseUrl) { -%>
+<% if (contributingUrl) { -%>
 
 ## Contributing
 
-Contributions, issues and feature requests are welcome. Feel free to check [issues page](<%= licenseUrl %>) if you want to contribute.
+Contributions, issues and feature requests are welcome. Feel free to check [issues page](<%= contributingUrl %>) if you want to contribute.
 <% } -%>
 <% if (authorName || authorTwitterUsername || authorGithubUsername) { -%>
 
@@ -55,14 +60,14 @@ Contributions, issues and feature requests are welcome. Feel free to check [issu
 ## Show your support
 
 Please ⭐️ this repository if you like it.
-<% if (licenseUrl) { -%>
+<% if (licenseName && licenseUrl) { -%>
 
 ## License
 
 <% if (authorName && authorGithubUsername) { -%>
 Copyright © <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>).
 <% } %>
-📜 This project is under [license](<%= licenseUrl %>).
+📜 This project is [<%= licenseName %>](<%= licenseUrl %>) licensed.
 <% } -%>
 
 ***