generator-vue-component

Yeoman generator to build custom Vue.js components

:warning: This generator is built for Vue.js v.1, support for v.2 is under development and will be available soon.

Installation

First, install Yeoman and generator-vue-component using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-vue-component

Then generate your new project:

yo vue-component

Scaffolding

└───build/
    ├───utils.js
    ├───webpack.build.js
    ├───webpack.build.min.js
    ├───webpack.config.js
└───docs/
    ├───App.vue
    ├───main.js
└───src/
    ├───HelloWorld.vue
    ├───index.js
└───test/
    ├───index.js
    ├───spec/
    │   └───index.spec.js
├───.babelrc
├───.editorconfig
├───.eslintignore
├───.eslintrc.js
├───.gitignore
├───.npmignore
├───.npmrc
├───circle.yml
├───karma.conf.js
├───LICENSE
├───package.json
├───README.md

Development Setup

# install dependencies
$ npm install

# build docs
$ npm run docs

# dev mode
$ npm run dev

# test
$ npm run test

# build component and get production release
$ npm run build

# build component and docs
$ npm run build-all

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Ignacio Anaya