Add badge generation

Author: David-Desmaisons

generator/index.js

@@ -13,11 +13,10 @@ function buildPrePublishOnly({ useVueStyleguidist, useVueDoc, useLint }) {
   return script.trim()
 }
 
-
-module.exports = (api, { componentName, useVueStyleguidist, useVueDoc }) => {
+module.exports = (api, { componentName, useVueStyleguidist, useVueDoc, addBadges }) => {
 
   const useLint = api.hasPlugin('eslint')
-  const context = { componentName, useVueStyleguidist, useVueDoc, useLint }
+  const context = { componentName, useVueStyleguidist, useVueDoc, addBadges, useLint }
 
   api.extendPackage({
     name: componentName,

generator/readmeUpdater.js

@@ -1,4 +1,4 @@
-const { hasProjectYarn } = require('@vue/cli-shared-utils')
+const { hasProjectYarn, hasProjectGit  } = require('@vue/cli-shared-utils')
 
 const descriptions = {
     useVueStyleguidist: {
@@ -33,10 +33,27 @@ function updateScriptDescription(options) {
     return scriptDescription
 }
 
-module.exports = (content, { componentName, useVueDoc, useVueStyleguidist }) => {
+module.exports = (content, { componentName, useVueDoc, useVueStyleguidist, addBadges }) => {
+    const hasGit = hasProjectGit (process.cwd())
+
     const updateInReadMe = [
         '',
-        '# $1',
+        '# $1'
+    ]
+
+    if (addBadges) {
+        if (hasGit){
+            var userName = require('git-user-name')();
+            updateInReadMe.push(
+                `[![GitHub open issues](https://img.shields.io/github/issues/${userName}/$1.svg?maxAge=2592000)](https://github.com/${userName}/$1/issues)`
+            )    
+        }
+        updateInReadMe.push(
+            `[![Npm version](https://img.shields.io/npm/v/$1.svg?maxAge=2592000)](https://www.npmjs.com/package/$1)`,
+        );
+    }
+
+    updateInReadMe.push(
         '',
         '## Usage',
         '```HTML',
@@ -51,10 +68,13 @@ module.exports = (content, { componentName, useVueDoc, useVueStyleguidist }) =>
         '  }',
         '}',
         '```'
-    ];
+    );
 
     if (useVueDoc) {
-        updateInReadMe.push('## API','');
+        updateInReadMe.push(
+            '## API',
+            ''
+        );
     }
 
     updateInReadMe.push(

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-cli-plugin-component",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "vue-cli 3 plugin to create shareable component",
   "main": "index.js",
   "repository": {
@@ -24,7 +24,8 @@
   },
   "dependencies": {
     "@types/node": "^10.5.2",
-    "@vue/cli-shared-utils": "^3.0.0-rc.5"
+    "@vue/cli-shared-utils": "^3.0.0-rc.5",
+    "git-user-name": "^2.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.1.0",

package.json

@@ -15,5 +15,11 @@ module.exports = [
         name: 'useVueDoc',
         message: 'Use vuedoc.md to automatically generate README API section?',
         default: true
+    },
+    {
+        type: 'confirm',
+        name: 'addBadges',
+        message: 'Add project badges to README.md?',
+        default: true
     }
 ]