1.0.0 • Published 2 years ago

vblok-cli v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

vblok-cli

A simple cli to dynamically created Vue, Scss and Storybook files for new components or modules in proejcts based on VueJS. It is still in early development and will have more features coming in the near future.

Installation

Install the cli by running npm install vblok-cli or yarn add vblok-cli

Usage

By default, components and modules created with vblok-cli are stored in the components folder of the project root directory.

Basic Usage

vblok <targetFolder> <name>

Available Options

--storybook or -s to add a storybook file to the created component

Examples

  1. vblok app Footer creates a Footer.vue and Footer.scss file in the directory components/app/Footer
  2. vblok base Button -s creates a Button.vue, Button.scss and Button.stories.js file in the directory components/base/Button
  3. vblok modules CmLanding -s creates CmLanding.vue, CmLanding.scss and CmLanding.stories.js in the directory components/modules/CmLanding
  4. vblok modules/teaser TmHighlight -s creates TmHighlight.vue, TmHighlight.scss and TmHighlight.stories.js in the directory components/modules/teaser

License

MIT