Add license generation

Author: David-Desmaisons

README.md

@@ -1,13 +1,15 @@
 # vue-cli-component
 [![Npm version](https://img.shields.io/npm/v/vue-cli-plugin-component.svg?maxAge=2592000)](https://www.npmjs.com/package/vue-cli-plugin-component)
+[![npm](https://img.shields.io/npm/dt/vue-cli-plugin-component.svg)](https://npmjs.com/package/vue-cli-plugin-component)
 [![MIT License](https://img.shields.io/github/license/David-Desmaisons/vue-cli-plugin-component.svg)](https://github.com/David-Desmaisons/vue-cli-plugin-component/blob/master/LICENSE)
 > component plugin for vue-cli
 
 ![demo](./__doc__/vue-ui.png)
 
 ```
 project
-│   README.md  
+│   README.md
+│   LICENSE (optional)
 └───src
 │   ├── index.js
 │   └───components
@@ -20,14 +22,18 @@ project
 
 ## Features
 
-* Ajust build script to only build the component. Use serve script to serve a demo page.
-
-* Automatically document the component with [vue-styleguidist](https://github.com/vue-styleguidist/vue-styleguidist) and [vuedoc.md](https://gitlab.com/vuedoc/md) .
+* Adjust build script to only build the component. Use serve script to serve a demo page.
 
 * Create a prepublishOnly script to run the build(s) before publishing the component
 
 * Update README.md with component information
 
+* Optional
+
+    * Automatically document the component with [vue-styleguidist](https://github.com/vue-styleguidist/vue-styleguidist) and [vuedoc.md](https://gitlab.com/vuedoc/md) .
+
+    * Create a license file for the project
+
 ## Scripts
 
 Use build to build the component
@@ -60,18 +66,22 @@ npm run styleguide:build
 ```
 
 
-
 ## Configuration
 
 ![configuration](./__doc__/configuration.png)
 
 
-**componentName:** the name of the component.
+* **componentName:** the name of the component.
+
+* **useVueStyleguidist:** true to install [vue-styleguidist](https://github.com/vue-styleguidist/vue-styleguidist), default: true
+
+* **useVueDoc:** true to install [vuedoc.md](https://gitlab.com/vuedoc/md), default: true
 
-**useVueStyleguidist:** true to install [vue-styleguidist](https://github.com/vue-styleguidist/vue-styleguidist) 
+* **addLicense** true to add a License file to the project, default: false
 
-**useVueDoc:** true to install [vuedoc.md](https://gitlab.com/vuedoc/md) 
+* **licenseName** type of the license file to create, default: MIT
 
+* **copyrightHolders** Project copy holders, used when creating the license file.
 
 ## Injected Commands
 

__doc__/configuration.png

@@ -1,5 +1,6 @@
 const { renameFiles, updateFile } = require('./fileHelper')
 const readmeUpdater = require('./readmeUpdater');
+const licenseList = require('spdx-license-list/full');
 
 function buildPrePublishOnly({ useVueStyleguidist, useVueDoc, useLint }) {
   let script = useLint ? 'npm run lint && ' : ''
@@ -12,11 +13,16 @@ function buildPrePublishOnly({ useVueStyleguidist, useVueDoc, useLint }) {
   }
   return script.trim()
 }
+
+function replaceInLicense(licenseTextTemplate, sourceText, newText){
+  return licenseTextTemplate.replace(new RegExp(`<${sourceText}>`), newText)
+                            .replace(new RegExp(`\\[${sourceText}\\]`), newText)
+}
 
-module.exports = (api, { componentName, useVueStyleguidist, useVueDoc, addBadges }) => {
+module.exports = (api, { addBadges, addLicense, componentName, copyrightHolders, licenseName, useVueDoc, useVueStyleguidist }) => {
 
   const useLint = api.hasPlugin('eslint')
-  const context = { componentName, useVueStyleguidist, useVueDoc, addBadges, useLint }
+  const context = { addBadges, addLicense, componentName, licenseName, useLint, useVueDoc, useVueStyleguidist }
 
   api.extendPackage({
     name: componentName,
@@ -76,5 +82,14 @@ module.exports = (api, { componentName, useVueStyleguidist, useVueDoc, addBadges
     const immutableFiles = ['src/components/HelloWorld.vue', 'src/index.js']
     renameFiles(files, /^src\//, 'example/', (file) => immutableFiles.indexOf(file) !== -1)
     renameFiles(files, /\/HelloWorld\./, `/${componentName}.`)
+
+    if (!addLicense) {
+      return
+    }
+
+    const licenseTextTemplate = licenseList[licenseName].licenseText;
+    const year = new Date().getFullYear()
+    const licenseText = replaceInLicense(licenseTextTemplate, 'year', year)
+    files['LICENSE'] = replaceInLicense(licenseText, 'copyright holders', copyrightHolders)
   })
 }

generator/index.js

@@ -33,7 +33,7 @@ function updateScriptDescription(options) {
     return scriptDescription
 }
 
-module.exports = (content, { componentName, useVueDoc, useVueStyleguidist, addBadges }) => {
+module.exports = (content, { addBadges, addLicense, componentName, licenseName, useVueDoc, useVueStyleguidist }) => {
     const hasGit = hasProjectGit (process.cwd())
 
     const updateInReadMe = [
@@ -49,8 +49,13 @@ module.exports = (content, { componentName, useVueDoc, useVueStyleguidist, addBa
             )    
         }
         updateInReadMe.push(
-            `[![Npm version](https://img.shields.io/npm/v/$1.svg?maxAge=2592000)](https://www.npmjs.com/package/$1)`,
+            '[![Npm version](https://img.shields.io/npm/v/$1.svg?maxAge=2592000)](https://www.npmjs.com/package/$1)',
         );
+        if (hasGit && addLicense){
+            updateInReadMe.push(
+                `[![${licenseName} License](https://img.shields.io/github/license/${userName}/$1.svg)](https://github.com/${userName}/$1/blob/master/LICENSE)`,
+            );
+        }
     }
 
     updateInReadMe.push(

generator/readmeUpdater.js

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

package-lock.json

@@ -1,3 +1,10 @@
+
+const licensesInformation = require('spdx-license-list/spdx-simple.json')
+const licenses = licensesInformation.map(name => ({
+    name,
+    value: name
+}));
+
 module.exports = [
     {
         type: 'input',
@@ -8,18 +15,44 @@ module.exports = [
         type: 'confirm',
         name: 'useVueStyleguidist',
         message: 'Use vue-styleguidist to generate documentation?',
-        default: true
+        default: true,
+        group: 'Documentation',
     },
     {
         type: 'confirm',
         name: 'useVueDoc',
         message: 'Use vuedoc.md to automatically generate README API section?',
-        default: true
+        default: true,
+        group: 'Documentation'
     },
     {
         type: 'confirm',
         name: 'addBadges',
         message: 'Add project badges to README.md?',
-        default: true
-    }
+        default: true,
+        group: 'Documentation'
+    },
+    {
+        type: 'confirm',
+        name: 'addLicense',
+        message: 'Add license?',
+        group: 'License',
+        default: false
+    },
+    {
+        type: 'list',
+        name: 'licenseName',
+        when: answer => answer.addLicense,
+        message: 'Choose a license:',
+        group: 'License',
+        choices: licenses,
+        default: 'MIT'
+    },
+    {
+        type: 'input',
+        name: 'copyrightHolders',
+        when: answer => answer.addLicense,
+        message: 'Enter copyright holders:',
+        group: 'License',
+    },
 ]