@varlet/cli 1.24.4 → 1.24.5-alpha.1640957663784
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -24
- package/generators/base/.prettierignore +1 -0
- package/lib/commands/release.js +3 -10
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
# @varlet/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
开箱即用的 `Vue3组件库` 快速成型工具，提供了一系列命令和工具去解决组件库开发上的问题
|
|
4
4
|
|
|
5
5
|
### 特性
|
|
6
6
|
|
|
7
7
|
- 1.开箱即用的组件库开发环境
|
|
8
|
-
- 2
|
|
8
|
+
- 2.开箱即用的组件库编译工具，支持导出 `esm` 和 `umd` 两种模块代码
|
|
9
9
|
- 3.基于配置文件的组件库文档站点,支持百度统计和主题定制
|
|
10
|
-
- 4
|
|
10
|
+
- 4.支持 `单文件组件(sfc)` 和 `tsx,jsx` 两种风格的组件库编写风格
|
|
11
11
|
- 5.开箱即用的代码检查工具
|
|
12
12
|
- 6.开箱即用的单元测试工具
|
|
13
|
-
- 7.开箱即用的代码发布工具,发布到npm和github
|
|
14
|
-
- 8
|
|
15
|
-
- 9
|
|
16
|
-
- 10
|
|
13
|
+
- 7.开箱即用的代码发布工具,发布到 npm 和 github, 并自动生成更新日志
|
|
14
|
+
- 8.支持 `Typescript`
|
|
15
|
+
- 9.支持 `暗黑模式`
|
|
16
|
+
- 10.基于 `pnpm`
|
|
17
17
|
|
|
18
18
|
### 快速开始
|
|
19
19
|
|
|
20
|
-
`@varlet/cli
|
|
21
|
-
|
|
20
|
+
`@varlet/cli` 内置了 `单文件组件(sfc)` 和 `tsx, jsx` 两种风格的组件库项目模板，可以通过 `gen` 命令直接生成。
|
|
21
|
+
帮助用户直接进入组件本身的开发，推荐使用 `pnpm` 作为包管理工具。
|
|
22
22
|
|
|
23
23
|
```shell
|
|
24
24
|
# 安装命令行工具
|
|
25
25
|
pnpm add @varlet/cli -g
|
|
26
|
-
# 使用gen命令生成项目
|
|
26
|
+
# 使用 gen 命令生成项目
|
|
27
27
|
varlet-cli gen 项目名
|
|
28
28
|
cd 项目名
|
|
29
29
|
pnpm install
|
|
@@ -36,7 +36,7 @@ pnpm dev
|
|
|
36
36
|
|
|
37
37
|
### 配置文件
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
项目根目录下的 `varlet.config.js` 用来管理整个组件库项目的具体细节
|
|
40
40
|
|
|
41
41
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
42
42
|
| ----- | -------------- | -------- | ---------- |
|
|
@@ -58,19 +58,19 @@ pnpm dev
|
|
|
58
58
|
|
|
59
59
|
#### 模块适配对象
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
一些外部依赖可能需要进行模块语法的适配，以达到可以正确编译到 `commonjs` 和 `esmodule` 的目的，例如 `dayjs` 的 `esmodule` 写法是
|
|
62
62
|
|
|
63
63
|
```js
|
|
64
64
|
import dayjs from 'dayjs/esm'
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
而为了构建 `commonjs` 时的写法是
|
|
68
68
|
|
|
69
69
|
```js
|
|
70
70
|
import * as dayjs from 'dayjs'
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
在项目中我们拥抱 `esmodule` 模块使用第一种写法，并做如下配置进行适配
|
|
74
74
|
|
|
75
75
|
```js
|
|
76
76
|
// varlet.config.js
|
|
@@ -83,7 +83,7 @@ module.exports = {
|
|
|
83
83
|
|
|
84
84
|
#### SiteThemes
|
|
85
85
|
|
|
86
|
-
|
|
86
|
+
主题变量相关，由于默认的主题变量可能时常修改，以 `varlet` 官方文档的主题为准
|
|
87
87
|
|
|
88
88
|
| 参数 |
|
|
89
89
|
| ----- |
|
|
@@ -220,7 +220,7 @@ varlet-cli compile
|
|
|
220
220
|
varlet-cli test
|
|
221
221
|
```
|
|
222
222
|
|
|
223
|
-
#### 以watch模式执行单元测试
|
|
223
|
+
#### 以 watch 模式执行单元测试
|
|
224
224
|
|
|
225
225
|
```shell
|
|
226
226
|
varlet-cli test -w
|
|
@@ -265,7 +265,7 @@ varlet-cli gen <projectName>
|
|
|
265
265
|
|
|
266
266
|
### babel
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
对 `babel` 进行配置，首先在 `package.json` 中指定目标浏览器
|
|
269
269
|
|
|
270
270
|
```json
|
|
271
271
|
{
|
|
@@ -276,7 +276,7 @@ varlet-cli gen <projectName>
|
|
|
276
276
|
}
|
|
277
277
|
```
|
|
278
278
|
|
|
279
|
-
|
|
279
|
+
创建 `babel.config,js`
|
|
280
280
|
|
|
281
281
|
```js
|
|
282
282
|
// babel.config.js
|
|
@@ -292,11 +292,11 @@ module.exports = {
|
|
|
292
292
|
}
|
|
293
293
|
```
|
|
294
294
|
|
|
295
|
-
### git和npm
|
|
295
|
+
### git 和 npm
|
|
296
296
|
|
|
297
297
|
#### git-hook
|
|
298
298
|
|
|
299
|
-
`husky`，`lint-staged
|
|
299
|
+
`husky`，`lint-staged` 配合 `eslint`，`stylelint`，`varlet-cli commit-lint` 做commit前的检查，`package.json` 配置如下
|
|
300
300
|
|
|
301
301
|
```json
|
|
302
302
|
{
|
|
@@ -338,7 +338,7 @@ module.exports = {
|
|
|
338
338
|
}
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
|
|
341
|
+
创建 `.prettierignore`
|
|
342
342
|
|
|
343
343
|
```text
|
|
344
344
|
// .prettierignore
|
|
@@ -353,7 +353,7 @@ src/*/__tests__/**
|
|
|
353
353
|
|
|
354
354
|
### typescript
|
|
355
355
|
|
|
356
|
-
|
|
356
|
+
创建 `tsconfig.json`
|
|
357
357
|
|
|
358
358
|
```json
|
|
359
359
|
{
|
|
@@ -373,8 +373,8 @@ src/*/__tests__/**
|
|
|
373
373
|
|
|
374
374
|
#### 发布前注意
|
|
375
375
|
|
|
376
|
-
|
|
377
|
-
|
|
376
|
+
1. `npm` 的仓库源必须指向 `npm` 官方镜像
|
|
377
|
+
2. 执行 `npm login` 进行登录
|
|
378
378
|
|
|
379
379
|
### Contributors
|
|
380
380
|
|
package/lib/commands/release.js
CHANGED
|
@@ -120,19 +120,16 @@ function pushGit(version) {
|
|
|
120
120
|
function updateVersion(version) {
|
|
121
121
|
var packageJsons = glob_1.default.sync('packages/*/package.json');
|
|
122
122
|
packageJsons.push('package.json');
|
|
123
|
-
|
|
123
|
+
packageJsons.forEach(function (path) {
|
|
124
124
|
var file = (0, path_1.resolve)(constant_1.CWD, path);
|
|
125
125
|
var config = require(file);
|
|
126
|
-
var currentVersion = config.version;
|
|
127
126
|
config.version = version;
|
|
128
127
|
(0, fs_extra_1.writeFileSync)(file, JSON.stringify(config, null, 2));
|
|
129
|
-
config.version = currentVersion;
|
|
130
|
-
return { file: file, content: JSON.stringify(config, null, 2) };
|
|
131
128
|
});
|
|
132
129
|
}
|
|
133
130
|
function release() {
|
|
134
131
|
return __awaiter(this, void 0, void 0, function () {
|
|
135
|
-
var currentVersion, name_1, ret, type, isPreRelease, expectVersion, confirm_1,
|
|
132
|
+
var currentVersion, name_1, ret, type, isPreRelease, expectVersion, confirm_1, e_1, error_1;
|
|
136
133
|
return __generator(this, function (_a) {
|
|
137
134
|
switch (_a.label) {
|
|
138
135
|
case 0:
|
|
@@ -175,7 +172,7 @@ function release() {
|
|
|
175
172
|
if (!confirm_1[name_1]) {
|
|
176
173
|
return [2 /*return*/];
|
|
177
174
|
}
|
|
178
|
-
|
|
175
|
+
updateVersion(expectVersion);
|
|
179
176
|
if (!!isPreRelease) return [3 /*break*/, 6];
|
|
180
177
|
return [4 /*yield*/, (0, changelog_1.changelog)()];
|
|
181
178
|
case 4:
|
|
@@ -188,10 +185,6 @@ function release() {
|
|
|
188
185
|
case 7:
|
|
189
186
|
_a.sent();
|
|
190
187
|
if (!isPreRelease) return [3 /*break*/, 11];
|
|
191
|
-
packageJsonMaps.forEach(function (_a) {
|
|
192
|
-
var file = _a.file, content = _a.content;
|
|
193
|
-
return (0, fs_extra_1.writeFileSync)(file, content);
|
|
194
|
-
});
|
|
195
188
|
_a.label = 8;
|
|
196
189
|
case 8:
|
|
197
190
|
_a.trys.push([8, 10, , 11]);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@varlet/cli",
|
|
3
|
-
"version": "1.24.
|
|
3
|
+
"version": "1.24.5-alpha.1640957663784",
|
|
4
4
|
"description": "cli of varlet",
|
|
5
5
|
"bin": {
|
|
6
6
|
"varlet-cli": "./lib/index.js"
|
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
},
|
|
30
30
|
"gitHead": "ee9c3866bedad96c86365b0f9888a3a6bb781b1f",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@varlet/icons": "1.24.
|
|
33
|
-
"@varlet/markdown-vite-plugin": "1.24.
|
|
34
|
-
"@varlet/touch-emulator": "1.24.
|
|
32
|
+
"@varlet/icons": "1.24.5-alpha.1640957663784",
|
|
33
|
+
"@varlet/markdown-vite-plugin": "1.24.5-alpha.1640957663784",
|
|
34
|
+
"@varlet/touch-emulator": "1.24.5-alpha.1640957663784",
|
|
35
35
|
"@babel/core": "^7.14.8",
|
|
36
36
|
"@babel/preset-env": "^7.14.8",
|
|
37
37
|
"@babel/preset-typescript": "^7.14.5",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"@types/lodash-es": "^4.17.5"
|
|
74
74
|
},
|
|
75
75
|
"peerDependencies": {
|
|
76
|
-
"@varlet/touch-emulator": "1.24.
|
|
76
|
+
"@varlet/touch-emulator": "1.24.5-alpha.1640957663784",
|
|
77
77
|
"@vue/test-utils": "^2.0.0-rc.6",
|
|
78
78
|
"vue": "3.2.16",
|
|
79
79
|
"vue-router": "4.0.12",
|
|
@@ -85,5 +85,5 @@
|
|
|
85
85
|
"dev": "tsc --watch",
|
|
86
86
|
"build": "tsc"
|
|
87
87
|
},
|
|
88
|
-
"readme": "# @varlet/cli\n\n
|
|
88
|
+
"readme": "# @varlet/cli\n\n开箱即用的 `Vue3组件库` 快速成型工具，提供了一系列命令和工具去解决组件库开发上的问题\n\n### 特性\n\n- 1.开箱即用的组件库开发环境\n- 2.开箱即用的组件库编译工具，支持导出 `esm` 和 `umd` 两种模块代码\n- 3.基于配置文件的组件库文档站点,支持百度统计和主题定制\n- 4.支持 `单文件组件(sfc)` 和 `tsx,jsx` 两种风格的组件库编写风格\n- 5.开箱即用的代码检查工具\n- 6.开箱即用的单元测试工具\n- 7.开箱即用的代码发布工具,发布到 npm 和 github, 并自动生成更新日志\n- 8.支持 `Typescript`\n- 9.支持 `暗黑模式`\n- 10.基于 `pnpm`\n\n### 快速开始\n\n`@varlet/cli` 内置了 `单文件组件(sfc)` 和 `tsx, jsx` 两种风格的组件库项目模板，可以通过 `gen` 命令直接生成。\n帮助用户直接进入组件本身的开发，推荐使用 `pnpm` 作为包管理工具。\n\n```shell\n# 安装命令行工具\npnpm add @varlet/cli -g\n# 使用 gen 命令生成项目\nvarlet-cli gen 项目名\ncd 项目名\npnpm install\npnpm dev\n```\n\n然后通过简单修改一些组件库模板的基础信息，就可以开始组件库的开发了\n\n## 高级定制\n\n### 配置文件\n\n项目根目录下的 `varlet.config.js` 用来管理整个组件库项目的具体细节\n\n| 参数 | 说明 | 类型 | 默认值 |\n| ----- | -------------- | -------- | ---------- |\n| `host` | 开发服务器主机 | _number_ | `localhost` |\n| `port` | 开发服务器端口 | _number_ | `8080` |\n| `name` | 组件库全名\t| _string_ | `Varlet` |\n| `namespace` | 组件库命名空间, 会作为组件前缀 | _string_ | `var` |\n| `title` | 文档中组件库的标题 | _string_ | `VARLET` |\n| `logo` | 文档中组件库的logo | _string_ | `-` |\n| `defaultLanguage` | 文档默认语言 | _string_ | `zh-CN` |\n| `useMobile` | 是否显示右侧手机预览 | _boolean_ | `false` |\n| `themes` | 文档主题 | _SiteThemes_ | `-` |\n| `darkThemes` | 暗黑模式文档主题 | _SiteThemes_ | `-` |\n| `highlight` | 文档代码片段样式相关 | _SiteHighlight_ | `-` |\n| `analysis` | 文档统计相关 | _SiteAnalysis_ | `-` |\n| `pc` | pc端文档结构配置 | _SitePC_ | `-` |\n| `mobile` | mobile端文档结构配置 | _SiteMobile_ | `-` |\n| `moduleCompatible` | 模块兼容配置 | _Record<string, string>_ | `-` |\n\n#### 模块适配对象\n\n一些外部依赖可能需要进行模块语法的适配，以达到可以正确编译到 `commonjs` 和 `esmodule` 的目的，例如 `dayjs` 的 `esmodule` 写法是\n\n```js\nimport dayjs from 'dayjs/esm'\n```\n\n而为了构建 `commonjs` 时的写法是\n\n```js\nimport * as dayjs from 'dayjs'\n```\n\n在项目中我们拥抱 `esmodule` 模块使用第一种写法，并做如下配置进行适配\n\n```js\n// varlet.config.js\nmodule.exports = {\n moduleCompatible: {\n \"import dayjs from 'dayjs/esm'\\n\": \"import * as dayjs from 'dayjs'\\n\"\n }\n}\n```\n\n#### SiteThemes\n\n主题变量相关，由于默认的主题变量可能时常修改，以 `varlet` 官方文档的主题为准\n\n| 参数 |\n| ----- |\n| `color-body` |\n| `color-bar` |\n| `color-sub-bar` |\n| `color-text` |\n| `color-sub-text` |\n| `color-border` |\n| `color-shadow` |\n| `color-introduce-border` |\n| `color-primary` |\n| `color-link` |\n| `color-type` |\n| `color-progress` |\n| `color-progress-track` |\n| `color-side-bar` |\n| `color-side-bar-active-background` |\n| `color-app-bar` |\n| `color-nav-button-hover-background` |\n| `color-pc-language-active` |\n| `color-pc-language-active-background` |\n| `color-mobile-cell-hover` |\n| `color-mobile-language-active` |\n| `color-mobile-language-active-background` |\n\n#### SiteHighlight\n\n代码片段高亮，基于[highlight.js](https://highlightjs.org/)\n\n| 参数 | 说明 | 类型 | 默认值 |\n| ----- | -------------- | -------- | ---------- |\n| `style` | highlight的css地址 | _string_ | `-` |\n\n#### SiteAnalysis\n\n统计埋点相关\n\n| 参数 | 说明 | 类型 | 默认值 |\n| ----- | -------------- | -------- | ---------- |\n| `baidu` | 百度统计脚本地址 | _string_ | `-` |\n\n#### SitePC, SiteMobile\n\n文档结构部分相关，示例配置如下\n\n```js\nmodule.exports = {\n pc: {\n redirect: '/home',\n title: {\n 'zh-CN': '一个组件库',\n },\n header: {\n darkMode: null,\n i18n: null,\n github: 'https://github.com/haoziqaq/varlet',\n },\n menu: [\n {\n text: {\n 'zh-CN': '开发指南',\n },\n // 侧边栏菜单目录\n type: 1,\n },\n {\n text: {\n 'zh-CN': '基本介绍',\n },\n doc: 'home',\n // 索引项目根目录下的md文档\n type: 3,\n },\n {\n text: {\n 'zh-CN': '基础组件',\n },\n type: 1,\n },\n {\n text: {\n 'zh-CN': 'Button 按钮',\n },\n doc: 'button',\n // 索引组件根目录下的md文档\n type: 2,\n },\n ],\n },\n mobile: {\n redirect: '/home',\n title: {\n 'zh-CN': '一个组件库',\n },\n header: {\n darkMode: null,\n i18n: null,\n github: 'https://github.com/haoziqaq/varlet',\n },\n },\n}\n```\n\n### 命令相关\n\n#### 启动开发服务器\n\n```shell\nvarlet-cli dev\n```\n\n#### 构建文档站点\n\n```shell\nvarlet-cli build\n```\n\n#### 预览文档站点\n\n```shell\nvarlet-cli preview\n```\n\n#### 构建组件库代码\n\n```shell\nvarlet-cli compile\n```\n\n#### 执行所有的单元测试\n\n```shell\nvarlet-cli test\n```\n\n#### 以 watch 模式执行单元测试\n\n```shell\nvarlet-cli test -w\nor\nvarlet-cli test -wa\n```\n\n#### 检查代码\n\n```shell\nvarlet-cli lint\n```\n\n#### 校验提交信息\n\n```shell\nvarlet-cli commit-lint\n```\n\n#### 生成更新日志\n\n```shell\nvarlet-cli changelog\n```\n\n#### 发布组件库\n\n```shell\nvarlet-cli release\n```\n\n#### 快速创建一个组件文件夹\n\n```shell\nvarlet-cli create <componentName>\n```\n\n#### 生成一个项目模板\n```shell\nvarlet-cli gen <projectName>\n```\n\n### babel\n\n对 `babel` 进行配置，首先在 `package.json` 中指定目标浏览器\n\n```json\n{\n \"browserslist\": [\n \"Chrome >= 51\",\n \"iOS >= 10\"\n ]\n}\n```\n\n创建 `babel.config,js`\n\n```js\n// babel.config.js\nmodule.exports = {\n presets: [\n [\n '@varlet/cli/preset',\n {\n loose: process.env.NODE_ENV === 'compile',\n },\n ],\n ],\n}\n```\n\n### git 和 npm\n\n#### git-hook\n\n`husky`，`lint-staged` 配合 `eslint`，`stylelint`，`varlet-cli commit-lint` 做commit前的检查，`package.json` 配置如下\n\n```json\n{\n \"scripts\": {\n \"prepare\": \"husky install\"\n },\n \"lint-staged\": {\n \"*.{ts,tsx,js,vue,less}\": \"prettier --write\",\n \"*.{ts,tsx,js,vue}\": \"eslint --fix\",\n \"*.{vue,css,less}\": \"stylelint --fix\"\n },\n \"eslintConfig\": {\n \"root\": true,\n \"ignorePatterns\": [\n \"es/**\",\n \"umd/**\",\n \"site/**\",\n \"public/**\",\n \"src/*/__tests__/**\",\n \".varlet/**\"\n ],\n \"extends\": [\n \"@varlet\"\n ]\n },\n \"stylelint\": {\n \"extends\": [\n \"@varlet/stylelint-config\"\n ],\n \"ignoreFiles\": [\n \"es/**\",\n \"umd/**\",\n \"site/**\",\n \"coverage/**\",\n \"public/**\",\n \"highlight/**\"\n ]\n }\n}\n```\n\n创建 `.prettierignore`\n\n```text\n// .prettierignore\ncoverage/**\nes/**\numd/**\nsite/**\npublic/**\nsrc/*/__tests__/**\n*.md\n```\n\n### typescript\n\n创建 `tsconfig.json`\n\n```json\n{\n \"compilerOptions\": {\n \"strict\": true,\n \"downlevelIteration\": true,\n \"declaration\": true,\n \"skipLibCheck\": true,\n \"esModuleInterop\": true,\n \"allowJs\": true,\n \"lib\": [\"esnext\", \"dom\"],\n \"allowSyntheticDefaultImports\": true,\n \"jsx\": \"preserve\"\n }\n}\n```\n\n#### 发布前注意\n\n1. `npm` 的仓库源必须指向 `npm` 官方镜像\n2. 执行 `npm login` 进行登录\n\n### Contributors\n\n<a href=\"https://github.com/haoziqaq/varlet/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=haoziqaq/varlet\" />\n</a>"
|
|
89
89
|
}
|