Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/David-Desmaisons/vue-cli-plugin-component

🛠️ vue-cli 3 plugin to create component
https://github.com/David-Desmaisons/vue-cli-plugin-component

component vue vue-cli-plugin

Last synced: 3 months ago
JSON representation

🛠️ vue-cli 3 plugin to create component

Host: GitHub
URL: https://github.com/David-Desmaisons/vue-cli-plugin-component
Owner: David-Desmaisons
License: mit
Created: 2018-07-23T00:21:16.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-12-07T21:51:45.000Z (about 2 years ago)
Last Synced: 2024-11-01T20:47:43.134Z (4 months ago)
Topics: component, vue, vue-cli-plugin
Language: JavaScript
Homepage:
Size: 181 KB
Stars: 88
Watchers: 6
Forks: 6
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# vue-cli-plugin-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
│ 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
* Use [ComponentFixture](https://github.com/David-Desmaisons/ComponentFixture) to develop and test the component

* 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

* Add projects badges

## Scripts

Use build to build the component
``` sh
npm run build
```

Use serve to serve the application example in the example folder
``` sh
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](./__doc__/configuration.png)

* **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

* **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

``` sh
vue add component
```

## Injected webpack-chain Rules
No Changes are performed