简介
generator-vue-component-bundle
是一个能够生成 Vue 组件的 npm 包生成器。通过该工具,开发者可快速创建 Vue 组件,包含了单文件组件、测试脚本、文档和样式等。
安装
首先,你需要安装 Yeoman 和 generator-vue-component-bundle:
--- ------- -- -- --- ------- -- ------------------------------
使用说明
在终端中运行以下命令,以启动 generator-vue-component-bundle:
-- --------------------
该命令会引导您完成以下选项:
- Component Name: 组件的名称.
- Component Description: 组件的描述.
- Component Keywords: 组件的关键词,用逗号隔开.
- Do you need a CSS preprocessor?: 是否需要使用 CSS 预处理器,例如:Sass、Less、Stylus?.
- Do you need testing?: 是否需要测试设置.
- Do you need a demo?: 是否需要示例文件.
- Do you need a readme file?: 是否需要文档说明.
完成后,generator-vue-component-bundle
将生成与您选择的选项相对应的项目框架。
示例代码
以下是该生成器生成的示例文件:
index.js
------ --- ---- ----- ------ --------- ---- ----------------- ----- ------ - - ------- ----- ------- - --- - ----------------------------- ---------- - - ----------------- - -------------- ------ ------- ---------
Component.vue
---------- ----- ------ ----- ------- ------ ----------- -------- ------ ------- - ----- -------------- ------ - ------ ------- -- - --------- ------ ------------------ --------
Component.spec.js
------ - ------------ - ---- ----------------- ------ --------- ---- ----------------- ------------------------- -- -- - ---------- ------ ----- ------ -- -- - ----- ----- - ------ ------- ----- ------- - ----------------------- - ---------- - ----- - -- ------------------------------------- -- --
README.md
-- ----------- - ----------- ------------ --- ------------ ------- --- ------- ------------
Usage
------ ----------- ---- -------------- --------------------
---------- ------------- ------------ ------- -- -----------
Props
Name | Type | Default | Description |
---|---|---|---|
title |
String | '' |
-- -- -- -------------------------------- -------- --- ---------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------