πŸ› οΈ vue-cli 3 plugin to create component
Clone or download

README.md

vue-cli-plugin-component

Npm version npm MIT License

component plugin for vue-cli

demo

project
β”‚   README.md
β”‚   LICENSE (optional)
└───src
β”‚   β”œβ”€β”€ index.js
β”‚   └───components
β”‚       └───Mycomponent.vue
β”‚
└───example
    β”œβ”€β”€ App.vue
    β”œβ”€β”€ main.js

Features

  • 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

Scripts

Use build to build the component

npm run build

Use serve to serve the application example in the example folder

npm run serve

When using vue.doc

Use doc:build to update the API section of README.md with generated documentation

npm run doc:build

When using vueStyleguide

Use styleguide to run style guide dev server

npm run styleguide

Use styleguide:build to generate a static HTML style guide

npm run styleguide:build

Configuration

configuration

  • componentName: the name of the component.

  • useVueStyleguidist: true to install vue-styleguidist, default: true

  • useVueDoc: true to install vuedoc.md, default: true

  • addLicense true to add a License file to the project, default: false

  • licenseName type of the license file to create, default: MIT

  • copyrightHolders Project copy holders, used when creating the license file.

Injected Commands

No command will be injected.

Installing in an Already Created Project

vue add component

Injected webpack-chain Rules

No Changes are performed