✨ Add documentation badge

kefranabg · Jun 8, 2019 · dd435ca · dd435ca
1 parent d2ee432
commit dd435ca
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 3 deletions.
diff --git a/src/cli.js b/src/cli.js
@@ -16,7 +16,8 @@ const {
   askContributing,
   askProjectVersion,
   askProjectPrerequisites,
-  askLicenseName
+  askLicenseName,
+  askProjectDocumentationUrl
 } = require('./questions')
 
 /**
@@ -29,6 +30,7 @@ const askQuestions = async () => {
     askProjectName,
     askProjectVersion,
     askProjectDescription,
+    askProjectDocumentationUrl,
     askAuhtorName,
     askAuthorGithub,
     askAuthorTwitter,

diff --git a/src/questions/index.js b/src/questions/index.js
@@ -8,6 +8,7 @@ const askLicenseUrl = require('./license-url')
 const askContributing = require('./contributing')
 const askProjectVersion = require('./project-version')
 const askProjectPrerequisites = require('./project-prerequisites')
+const askProjectDocumentationUrl = require('./project-documentation-url')
 
 module.exports = {
   askProjectName,
@@ -19,5 +20,6 @@ module.exports = {
   askLicenseUrl,
   askContributing,
   askProjectVersion,
-  askProjectPrerequisites
+  askProjectPrerequisites,
+  askProjectDocumentationUrl
 }
diff --git a/src/questions/project-documentation-url.js b/src/questions/project-documentation-url.js
@@ -0,0 +1,6 @@
+module.exports = projectInfos => ({
+  type: 'input',
+  message: '📘  Project documenration url (use empty value to skip)',
+  name: 'projectDocumentationUrl',
+  default: projectInfos.documentationUrl
+})
diff --git a/src/utils/index.js b/src/utils/index.js
@@ -126,6 +126,7 @@ const getProjectInfos = async () => {
   const author = get(packageJson, 'author', undefined)
   const version = get(packageJson, 'version', undefined)
   const licenseName = get(packageJson, 'license', undefined)
+  const documentationUrl = get(packageJson, 'homepage', undefined)
   const repositoryUrl = await getReposUrl(packageJson)
   const contributingUrl = await getReposIssuesUrl(packageJson)
   const githubUsername = isGithubRepository(repositoryUrl)
@@ -145,7 +146,8 @@ const getProjectInfos = async () => {
     githubUsername,
     engines,
     licenseName,
-    licenseUrl
+    licenseUrl,
+    documentationUrl
   }
 }
 

diff --git a/templates/default.md b/templates/default.md
@@ -3,6 +3,11 @@
 <% if (projectVersion) { -%>
   <img src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
 <% } -%>
+<% if (projectDocumentationUrl) { -%>
+  <a href="<%= projectDocumentationUrl %>">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
+  </a>
+<% } -%>
 <% if (licenseName && licenseUrl) { -%>
   <a href="<%= licenseUrl %>">
     <img alt="License: <%= licenseName %>" src="https://img.shields.io/badge/License-<%= licenseName %>-yellow.svg" target="_blank" />