Skip to content

vue-land/create-vue-component

Repository files navigation

create-vue-component

NPM version NPM downloads CircleCI donate chat

Install

yarn global add cvc

Another package create-vue-component on npm does not belong to us.

Usage

create-vue-component vue-xxx
# or type less
cvc vue-xxx

# you can also create component in place
mkdir vue-xxx && cd vue-xxx
cvc

You won't believe how clean the folder struture of generated project is (no config files!):

preview

Documentation

folder structure

  • src/index.js: Your fancy component
  • example/index.js: Entry file of your demo

npm scripts

  • yarn example: Run the demo for your component (with Poi)
  • yarn example:build: Build the demo for your component (with Poi)
  • yarn build: Build your component (with Bili)
  • yarn test: Lint and test your component (with Tyu)
  • yarn lint: Lint only.

badges

The generated README.md in your project contains the badges of npm version, npm downloads and circleci status.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

create-vue-component © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

github.com/egoist · GitHub @EGOIST · Twitter @_egoistlily