@varlet/cli 1.24.2-alpha.1640872052259 → 1.24.3-alpha.1640877804572

package/README.en-US.md

@@ -13,21 +13,21 @@ The out-of-the-box `Vue3 component library` rapid prototyping tool provides a se
 - 7.Out-of-the-box code publishing tool, publish to npm and github, and automatically generate a change log
 - 8.Support `Typescript`
 - 9.Support `Dark Mode`
+- 10.Based on `pnpm`
 
 ### Quickstart
 
 `@varlet/cli` has built-in `single file component (sfc)` and `tsx, jsx` two styles of component library project templates, which can be directly generated by the `gen` command.
-To help users directly enter the development of the component itself, it is recommended to use `yarn` as a package management tool. First, make sure that `yarn` is installed and added to the system environment variables. 
-The installation and configuration methods of `yarn` are not introduced here.
+To help users directly enter the development of the component itself, it is recommended to use `pnpm` as a package management tool. 
 
 ```shell
 # Install command line tools
-yarn global add @varlet/cli
+pnpm add @varlet/cli -g
 # Use the gen command to generate the project
 varlet-cli gen projectName
 cd projectName
-yarn
-yarn dev
+pnpm install
+pnpm dev
 ```
 
 Then by simply modifying some basic information of the component library template,
@@ -238,6 +238,24 @@ varlet-cli test -wa
 varlet-cli lint
 ```
 
+#### Lint commit message
+
+```shell
+varlet-cli commit-lint
+```
+
+#### Generate changelog
+
+```shell
+varlet-cli changelog
+```
+
+#### Release component library
+
+```shell
+varlet-cli release
+```
+
 #### Quickly create a component folder
 
 ```shell
@@ -282,19 +300,13 @@ module.exports = {
 
 #### git-hook
 
-`husky`, `lint-staged` cooperate with `eslint`, `stylelint`, `commitlint` to check before commit, 
+`husky`, `lint-staged` cooperate with `eslint`, `stylelint`, `varlet-cli commit-lint` to check before commit, 
 `package.json` configuration is as follows
 
 ```json
 {
   "scripts": {
-    "prepare": "husky install",
-    "commit": "git-cz"
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
+    "prepare": "husky install"
   },
   "lint-staged": {
     "*.{ts,tsx,js,vue,less}": "prettier --write",
@@ -331,15 +343,6 @@ module.exports = {
 }
 ```
 
-create `commitlint.config.js`
-
-```js
-// commitlint.config.js
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-}
-```
-
 create `.prettierignore`
 
 ```text
@@ -373,36 +376,13 @@ create `tsconfig.json`
 }
 ```
 
-### Release code
+#### Note before release
 
-Use `release-it` and `conventional-changelog` for code release and update log generation. 
-The configuration of `package.json` is as follows
+- 1.The registry of npm must set to the official npm mirror
+- 2.The npm must execute the login command for user login
 
-```json
-{
-  "scripts": {
-    "genlog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "genAllLog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
-    "release": "yarn compile && release-it"
-  },
-  "release-it": {
-    "git": {
-      "changelog": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}",
-      "tagName": "v${version}",
-      "commitMessage": "chore: release ${version}",
-      "requireCleanWorkingDir": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular",
-        "infile": "CHANGELOG.md"
-      }
-    }
-  }
-}
-```
-
-#### Note before release
+### Contributors
 
-- 1.The registry of npm and yarn must set to the official npm mirror
-- 2.Both npm and yarn must execute the login command for user login
+<a href="https://github.com/haoziqaq/varlet/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=haoziqaq/varlet" />
+</a>

package/README.md

@@ -13,20 +13,21 @@
 - 7.开箱即用的代码发布工具,发布到npm和github,并自动生成更新日志
 - 8.支持`Typescript`
 - 9.支持`暗黑模式`
+- 10.基于`pnpm`
 
 ### 快速开始
 
 `@varlet/cli`内置了`单文件组件(sfc)`和`tsx, jsx`两种风格的组件库项目模板，可以通过`gen`命令直接生成。
-帮助用户直接进入组件本身的开发，这里推荐使用`yarn`作为包管理工具，首先确保安装了`yarn`并且添加到系统环境变量中去，这里不展开介绍`yarn`的安装和配置方法。
+帮助用户直接进入组件本身的开发，推荐使用`pnpm`作为包管理工具。
 
 ```shell
 # 安装命令行工具
-yarn global add @varlet/cli
+pnpm add @varlet/cli -g
 # 使用gen命令生成项目
 varlet-cli gen 项目名
 cd 项目名
-yarn
-yarn dev
+pnpm install
+pnpm dev
 ```
 
 然后通过简单修改一些组件库模板的基础信息，就可以开始组件库的开发了
@@ -233,6 +234,24 @@ varlet-cli test -wa
 varlet-cli lint
 ```
 
+#### 校验提交信息
+
+```shell
+varlet-cli commit-lint
+```
+
+#### 生成更新日志
+
+```shell
+varlet-cli changelog
+```
+
+#### 发布组件库
+
+```shell
+varlet-cli release
+```
+
 #### 快速创建一个组件文件夹
 
 ```shell
@@ -277,18 +296,12 @@ module.exports = {
 
 #### git-hook
 
-`husky`，`lint-staged`配合`eslint`，`stylelint`，`commitlint`做commit前的检查，`package.json`配置如下
+`husky`，`lint-staged`配合`eslint`，`stylelint`，`varlet-cli commit-lint`做commit前的检查，`package.json`配置如下
 
 ```json
 {
   "scripts": {
-    "prepare": "husky install",
-    "commit": "git-cz"
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
+    "prepare": "husky install"
   },
   "lint-staged": {
     "*.{ts,tsx,js,vue,less}": "prettier --write",
@@ -325,15 +338,6 @@ module.exports = {
 }
 ```
 
-创建`commitlint.config.js`
-
-```js
-// commitlint.config.js
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-}
-```
-
 创建`.prettierignore`
 
 ```text
@@ -367,35 +371,13 @@ src/*/__tests__/**
 }
 ```
 
-### 发布代码
+#### 发布前注意
 
-使用`release-it`和`conventional-changelog`进行代码发布和更新日志的生成，`package.json`配置如下
+- 1.npm的仓库源必须指向npm官方镜像
+- 2.执行npm login进行登录
 
-```json
-{
-  "scripts": {
-    "genlog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "genAllLog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
-    "release": "yarn compile && release-it"
-  },
-  "release-it": {
-    "git": {
-      "changelog": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}",
-      "tagName": "v${version}",
-      "commitMessage": "chore: release ${version}",
-      "requireCleanWorkingDir": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular",
-        "infile": "CHANGELOG.md"
-      }
-    }
-  }
-}
-```
-
-#### 发布前注意
+### Contributors
 
-- 1.npm和yarn的仓库源必须指向npm官方镜像
-- 2.npm和yarn都必须执行login命令进行用户登录
+<a href="https://github.com/haoziqaq/varlet/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=haoziqaq/varlet" />
+</a>

package/generators/base/.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit $1
+npx --no-install varlet-cli commit-lint $1

package/generators/base/README.md

@@ -8,8 +8,8 @@
 ### Quickstart
 
 ```shell
-yarn
-yarn dev
+pnpm install
+pnpm dev
 ```
 
 ### Commands
@@ -17,72 +17,66 @@ yarn dev
 #### Start the development server
 
 ```shell
-yarn dev
+pnpm dev
 ```
 
 #### Build documentation site
 
 ```shell
-yarn build
+pnpm build
 ```
 
 #### Building component libraries
 
 ```shell
-yarn compile
+pnpm compile
 ```
 
 #### Lint code
 
 ```shell
-yarn lint
+pnpm lint
 ```
 
 #### Run unit test
 
 ```shell
-yarn test
+pnpm test
 ```
 
 #### Run unit test in watch mode
 
 ```shell
-yarn test:watch 
+pnpm test:watch 
 or
-yarn test:watchAll 
+pnpm test:watchAll 
 ```
 
 #### Quickly create a component folder
 
 ```shell
-yarn run create <componentName>
+pnpm run create <componentName>
 ```
 
 #### Mount git hook
 
 ```shell
-yarn husky
+pnpm husky
 ```
 
 #### Generate changelog
 
 ```shell
-yarn genlog
+pnpm changelog
 ```
 
-#### Generate all changelog
-
-```shell
-yarn genAllLog
-```
-
-#### Publish
+#### Release
 
 tips: 
-- 1.The registry of npm and yarn must be the official source of npm
-- 2.Both npm and yarn must be logged in
+- 1.The registry of npm must be the official source of npm
+- 2.The npm must be logged in
 
 ```shell
-yarn release
+pnpm release
 ```
 

package/generators/base/package.json

@@ -17,16 +17,15 @@
   "license": "MIT",
   "scripts": {
     "husky": "husky install",
-    "commit": "git-cz",
+    "preinstall": "npx only-allow pnpm",
     "dev": "varlet-cli dev",
     "build": "varlet-cli build",
     "preview": "varlet-cli preview",
     "compile": "varlet-cli compile",
     "create": "varlet-cli create",
     "lint": "varlet-cli lint",
-    "genlog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "genAllLog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
-    "release": "pnpm compile && release-it",
+    "changelog": "varlet-cli changelog",
+    "release": "pnpm compile && varlet-cli release",
     "test": "varlet-cli jest",
     "test:watch": "varlet-cli jest -w",
     "test:watchAll": "varlet-cli jest -wa"
@@ -36,26 +35,21 @@
   },
   "devDependencies": {
     "@varlet/cli": "workspace:*",
-    "vue": "3.2.16"
-  },
-  "release-it": {
-    "git": {
-      "changelog": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}",
-      "tagName": "v${version}",
-      "commitMessage": "chore: release ${version}",
-      "requireCleanWorkingDir": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular",
-        "infile": "CHANGELOG.md"
-      }
-    }
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
+    "@varlet/touch-emulator": "workspace:*",
+    "@varlet/icons": "workspace:*",
+    "@varlet/eslint-config": "workspace:*",
+    "@varlet/stylelint-config": "workspace:*",
+    "@vue/test-utils": "2.0.0-rc.6",
+    "typescript": "^4.4.4",
+    "vue-router": "4.0.12",
+    "vue": "3.2.16",
+    "live-server": "^1.2.1",
+    "prettier": "^2.3.2",
+    "stylelint": "^13.13.1",
+    "eslint": "^7.30.0",
+    "lint-staged": "^10.5.0",
+    "lodash-es": "^4.17.21",
+    "clipboard": "^2.0.6"
   },
   "lint-staged": {
     "*.{ts,tsx,js,vue,less}": "prettier --write",
@@ -88,11 +82,13 @@
       "site/**",
       "coverage/**",
       "public/**",
-      "highlight/**"
+      "highlight/**",
+      ".varlet/**"
     ]
   },
   "browserslist": [
     "Chrome >= 51",
     "iOS >= 10"
-  ]
+  ],
+  "packageManager": "pnpm@6.24.3"
 }

package/lib/commands/create.js

@@ -47,14 +47,13 @@ var path_1 = require("path");
 var constant_1 = require("../shared/constant");
 var varlet_config_1 = require("../config/varlet.config");
 var lodash_1 = require("lodash");
-var varletConfig = (0, varlet_config_1.getVarletConfig)();
 function create(name) {
     return __awaiter(this, void 0, void 0, function () {
         var namespace, bigCamelizeName, vueTemplate, indexTemplate, testsTemplate, exampleTemplate, localeIndexTemplate, localTemplate, componentDir, testsDir, exampleDir, exampleLocalDir, docsDir;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    namespace = (0, lodash_1.get)(varletConfig, 'namespace');
+                    namespace = (0, lodash_1.get)((0, varlet_config_1.getVarletConfig)(), 'namespace');
                     bigCamelizeName = (0, fsUtils_1.bigCamelize)(name);
                     vueTemplate = "<template>\n  <div class=\"".concat(namespace, "-").concat(name, "\"></div>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent } from 'vue'\n\nexport default defineComponent({\n  name: '").concat((0, fsUtils_1.bigCamelize)(namespace)).concat(bigCamelizeName, "'\n})\n</script>\n\n<style lang=\"less\">\n.").concat(namespace, "-").concat(name, " {\n  display: flex;\n}\n</style>\n");
                     indexTemplate = "import ".concat(bigCamelizeName, " from './").concat(bigCamelizeName, ".vue'\nimport type { App } from 'vue'\n\n").concat(bigCamelizeName, ".install = function(app: App) {\n  app.component(").concat(bigCamelizeName, ".name, ").concat(bigCamelizeName, ")\n}\n\nexport const _").concat(bigCamelizeName, "Component = ").concat(bigCamelizeName, "\n\nexport default ").concat(bigCamelizeName, "\n");

package/lib/commands/gen.js

@@ -49,12 +49,19 @@ function removeFiles(dest) {
     var files = ['es', 'lib', 'umd', 'highlight', 'types/index.d.ts', '.varlet', 'node_modules'];
     files.forEach(function (filename) { return (0, fs_extra_1.removeSync)((0, path_1.resolve)(dest, filename)); });
 }
+function generateGitIgnore(name) {
+    (0, fs_extra_1.writeFileSync)((0, path_1.resolve)(constant_1.CWD, name, '.gitignore'), "node_modules\n\n.varlet\n.idea\n.vscode\n*.log\n.DS_Store\n\nsite\nlib\nes\numd\ncoverage\nhighlight");
+}
 function syncVersion(name) {
     var file = (0, path_1.resolve)(constant_1.CWD, name, 'package.json');
     var pkg = JSON.parse((0, fs_extra_1.readFileSync)(file, 'utf-8'));
     var cliPkg = JSON.parse((0, fs_extra_1.readFileSync)(constant_1.CLI_PACKAGE_JSON, 'utf-8'));
-    pkg.devDependencies['@varlet/cli'] = "^".concat(cliPkg.version);
-    pkg.files = ['es', 'lib', 'umd', 'highlight', 'types', 'README.md'];
+    Object.keys(pkg.devDependencies).forEach(function (key) {
+        if (key.startsWith('@varlet')) {
+            pkg.devDependencies[key] = "^".concat(cliPkg.version);
+        }
+    });
+    pkg.files = ['es', 'lib', 'umd', 'highlight', 'types'];
     (0, fs_extra_1.writeFileSync)(file, JSON.stringify(pkg, null, 2));
 }
 function gen(name) {
@@ -88,6 +95,7 @@ function gen(name) {
                     _a.sent();
                     removeFiles(dest);
                     syncVersion(name);
+                    generateGitIgnore(name);
                     logger_1.default.success('Application generated successfully!');
                     logger_1.default.info("  cd ".concat(name, "\n  yarn\n  yarn dev"));
                     logger_1.default.success("=======================\n  Good luck have fun\n=======================      ");

package/lib/commands/release.js

@@ -83,7 +83,7 @@ function publish(preRelease) {
         });
     });
 }
-function pushGit(version, message) {
+function pushGit(version) {
     return __awaiter(this, void 0, void 0, function () {
         var s, ret;
         return __generator(this, function (_a) {
@@ -93,10 +93,10 @@ function pushGit(version, message) {
                     return [4 /*yield*/, (0, execa_1.default)('git', ['add', '.'])];
                 case 1:
                     _a.sent();
-                    return [4 /*yield*/, (0, execa_1.default)('git', ['commit', '-m', message])];
+                    return [4 /*yield*/, (0, execa_1.default)('git', ['commit', '-m', "v".concat(version)])];
                 case 2:
                     _a.sent();
-                    return [4 /*yield*/, (0, execa_1.default)('git', ['tag', version])];
+                    return [4 /*yield*/, (0, execa_1.default)('git', ['tag', "v".concat(version)])];
                 case 3:
                     _a.sent();
                     return [4 /*yield*/, (0, execa_1.default)('git', ['push'])];
@@ -172,7 +172,7 @@ function release() {
                     return [4 /*yield*/, (0, changelog_1.changelog)()];
                 case 4:
                     _a.sent();
-                    return [4 /*yield*/, pushGit(expectVersion, "v".concat(expectVersion))];
+                    return [4 /*yield*/, pushGit(expectVersion)];
                 case 5:
                     _a.sent();
                     _a.label = 6;

package/lib/compiler/compileSiteEntry.js

@@ -203,7 +203,7 @@ function buildSiteEntry() {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    (0, varlet_config_1.getVarletConfig)();
+                    (0, varlet_config_1.getVarletConfig)(true);
                     return [4 /*yield*/, Promise.all([buildMobileSiteRoutes(), buildPcSiteRoutes(), buildSiteSource()])];
                 case 1:
                     _a.sent();

package/lib/compiler/compileTemplateHighlight.d.ts

@@ -2,9 +2,9 @@ export declare const replaceDot: (s: string) => string;
 export declare const replaceUnderline: (s: string) => string;
 export declare function parseTable(table: string): string[][];
 export declare function compileTable(md: string, titleRe: RegExp): string;
-export declare function compileTags(table: Record<string, any>, tags: Record<string, any>, componentName: string): void;
-export declare function compileAttributes(table: Record<string, any>, attributes: Record<string, any>, componentName: string): void;
-export declare function compileWebTypes(table: Record<string, any>, webTypes: Record<string, any>, componentName: string): void;
-export declare function compileMD(path: string, tags: Record<string, any>, attributes: Record<string, any>, webTypes: Record<string, any>): void;
-export declare function compileDir(path: string, tags: Record<string, any>, attributes: Record<string, any>, webTypes: Record<string, any>): void;
+export declare function compileTags(table: Record<string, any>, tags: Record<string, any>, componentName: string, varletConfig: Record<string, any>): void;
+export declare function compileAttributes(table: Record<string, any>, attributes: Record<string, any>, componentName: string, varletConfig: Record<string, any>): void;
+export declare function compileWebTypes(table: Record<string, any>, webTypes: Record<string, any>, componentName: string, varletConfig: Record<string, any>): void;
+export declare function compileMD(path: string, tags: Record<string, any>, attributes: Record<string, any>, webTypes: Record<string, any>, varletConfig: Record<string, any>): void;
+export declare function compileDir(path: string, tags: Record<string, any>, attributes: Record<string, any>, webTypes: Record<string, any>, varletConfig: Record<string, any>): void;
 export declare function compileTemplateHighlight(): Promise<void>;

package/lib/compiler/compileTemplateHighlight.js

@@ -43,7 +43,6 @@ var path_1 = require("path");
 var fsUtils_1 = require("../shared/fsUtils");
 var lodash_1 = require("lodash");
 var varlet_config_1 = require("../config/varlet.config");
-var varletConfig = (0, varlet_config_1.getVarletConfig)();
 var TABLE_HEAD_RE = /\s*\|.*\|\s*\n\s*\|.*---+\s*\|\s*\n+/;
 var TABLE_FOOT_RE = /(\|\s*$)|(\|\s*\n(?!\s*\|))/;
 var replaceDot = function (s) { return s.replace(/`/g, ''); };
@@ -84,13 +83,13 @@ function compileTable(md, titleRe) {
     return md.replace(/\\\|/g, '__varlet_axis__').trim();
 }
 exports.compileTable = compileTable;
-function compileTags(table, tags, componentName) {
+function compileTags(table, tags, componentName, varletConfig) {
     tags["".concat((0, lodash_1.get)(varletConfig, 'namespace'), "-").concat(componentName)] = {
         attributes: table.attributesTable.map(function (row) { return (0, exports.replaceDot)(row[0]); }),
     };
 }
 exports.compileTags = compileTags;
-function compileAttributes(table, attributes, componentName) {
+function compileAttributes(table, attributes, componentName, varletConfig) {
     table.attributesTable.forEach(function (row) {
         var attrNamespace = "".concat((0, lodash_1.get)(varletConfig, 'namespace'), "-").concat(componentName, "/").concat((0, exports.replaceDot)(row[0]));
         attributes[attrNamespace] = {
@@ -100,7 +99,7 @@ function compileAttributes(table, attributes, componentName) {
     });
 }
 exports.compileAttributes = compileAttributes;
-function compileWebTypes(table, webTypes, componentName) {
+function compileWebTypes(table, webTypes, componentName, varletConfig) {
     var attributesTable = table.attributesTable, eventsTable = table.eventsTable, slotsTable = table.slotsTable;
     var attributes = attributesTable.map(function (row) { return ({
         name: (0, exports.replaceDot)(row[0]),
@@ -127,7 +126,7 @@ function compileWebTypes(table, webTypes, componentName) {
     });
 }
 exports.compileWebTypes = compileWebTypes;
-function compileMD(path, tags, attributes, webTypes) {
+function compileMD(path, tags, attributes, webTypes, varletConfig) {
     if (!path.endsWith(constant_1.HL_MD)) {
         return;
     }
@@ -141,28 +140,29 @@ function compileMD(path, tags, attributes, webTypes) {
         eventsTable: eventsTable,
         slotsTable: slotsTable,
     };
-    compileWebTypes(table, webTypes, componentName);
-    compileTags(table, tags, componentName);
-    compileAttributes(table, attributes, componentName);
+    compileWebTypes(table, webTypes, componentName, varletConfig);
+    compileTags(table, tags, componentName, varletConfig);
+    compileAttributes(table, attributes, componentName, varletConfig);
 }
 exports.compileMD = compileMD;
-function compileDir(path, tags, attributes, webTypes) {
+function compileDir(path, tags, attributes, webTypes, varletConfig) {
     var dir = (0, fs_extra_1.readdirSync)(path);
     dir.forEach(function (filename) {
         var filePath = (0, path_1.resolve)(path, filename);
-        (0, fsUtils_1.isDir)(filePath) && compileDir(filePath, tags, attributes, webTypes);
-        (0, fsUtils_1.isMD)(filePath) && compileMD(filePath, tags, attributes, webTypes);
+        (0, fsUtils_1.isDir)(filePath) && compileDir(filePath, tags, attributes, webTypes, varletConfig);
+        (0, fsUtils_1.isMD)(filePath) && compileMD(filePath, tags, attributes, webTypes, varletConfig);
     });
 }
 exports.compileDir = compileDir;
 function compileTemplateHighlight() {
     return __awaiter(this, void 0, void 0, function () {
-        var tags, attributes, webTypes;
+        var varletConfig, tags, attributes, webTypes;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, (0, fs_extra_1.ensureDir)(constant_1.HL_DIR)];
                 case 1:
                     _a.sent();
+                    varletConfig = (0, varlet_config_1.getVarletConfig)();
                     tags = {};
                     attributes = {};
                     webTypes = {
@@ -177,7 +177,7 @@ function compileTemplateHighlight() {
                             },
                         },
                     };
-                    compileDir(constant_1.SRC_DIR, tags, attributes, webTypes);
+                    compileDir(constant_1.SRC_DIR, tags, attributes, webTypes, varletConfig);
                     return [4 /*yield*/, Promise.all([
                             (0, fs_extra_1.writeFile)(constant_1.HL_WEB_TYPES_JSON, JSON.stringify(webTypes, null, 2)),
                             (0, fs_extra_1.writeFile)(constant_1.HL_TAGS_JSON, JSON.stringify(tags, null, 2)),

package/lib/config/varlet.config.d.ts

@@ -1 +1 @@
-export declare function getVarletConfig(): Record<string, any>;
+export declare function getVarletConfig(emit?: boolean): Record<string, any>;

package/lib/config/varlet.config.js

@@ -5,7 +5,8 @@ var fs_extra_1 = require("fs-extra");
 var lodash_1 = require("lodash");
 var constant_1 = require("../shared/constant");
 var fsUtils_1 = require("../shared/fsUtils");
-function getVarletConfig() {
+function getVarletConfig(emit) {
+    if (emit === void 0) { emit = false; }
     var config = {};
     if ((0, fs_extra_1.pathExistsSync)(constant_1.VARLET_CONFIG)) {
         delete require.cache[require.resolve(constant_1.VARLET_CONFIG)];
@@ -14,8 +15,10 @@ function getVarletConfig() {
     delete require.cache[require.resolve('../../varlet.default.config.js')];
     var defaultConfig = require('../../varlet.default.config.js');
     var mergedConfig = (0, lodash_1.merge)(defaultConfig, config);
-    var source = JSON.stringify(mergedConfig, null, 2);
-    (0, fsUtils_1.outputFileSyncOnChange)(constant_1.SITE_CONFIG, source);
+    if (emit) {
+        var source = JSON.stringify(mergedConfig, null, 2);
+        (0, fsUtils_1.outputFileSyncOnChange)(constant_1.SITE_CONFIG, source);
+    }
     return mergedConfig;
 }
 exports.getVarletConfig = getVarletConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/cli",
-  "version": "1.24.2-alpha.1640872052259",
+  "version": "1.24.3-alpha.1640877804572",
   "description": "cli of varlet",
   "bin": {
     "varlet-cli": "./lib/index.js"
@@ -29,9 +29,9 @@
   },
   "gitHead": "ee9c3866bedad96c86365b0f9888a3a6bb781b1f",
   "dependencies": {
-    "@varlet/icons": "1.24.2-alpha.1640872052259",
-    "@varlet/markdown-vite-plugin": "1.24.2-alpha.1640872052259",
-    "@varlet/touch-emulator": "1.24.2-alpha.1640872052259",
+    "@varlet/icons": "1.24.3-alpha.1640877804572",
+    "@varlet/markdown-vite-plugin": "1.24.3-alpha.1640877804572",
+    "@varlet/touch-emulator": "1.24.3-alpha.1640877804572",
     "@babel/core": "^7.14.8",
     "@babel/preset-env": "^7.14.8",
     "@babel/preset-typescript": "^7.14.5",
@@ -73,7 +73,7 @@
     "@types/lodash-es": "^4.17.5"
   },
   "peerDependencies": {
-    "@varlet/touch-emulator": "1.24.2-alpha.1640872052259",
+    "@varlet/touch-emulator": "1.24.3-alpha.1640877804572",
     "@vue/test-utils": "^2.0.0-rc.6",
     "vue": "3.2.16",
     "vue-router": "4.0.12",
@@ -84,5 +84,6 @@
   "scripts": {
     "dev": "tsc --watch",
     "build": "tsc"
-  }
+  },
+  "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\n- 1.npm的仓库源必须指向npm官方镜像\n- 2.执行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>"
 }

package/site/index.html

@@ -9,6 +9,9 @@
   <link href="<%= logo %>" rel="icon" type="image/png" />
   <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, viewport-fit=cover"
         name="viewport" />
+  <meta property="og:title" content="<%= pcTitle %>" />
+  <meta property="og:type" content="website" />
+  <meta property="og:image" content="<%= logo %>" />
   <style>
     @font-face {
       font-family: "Roboto";

package/site/mobile.html

@@ -9,6 +9,9 @@
   <link href="<%= logo %>" rel="icon" type="image/png" />
   <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, viewport-fit=cover"
         name="viewport" />
+  <meta property="og:title" content="<%= mobileTitle %>" />
+  <meta property="og:type" content="website" />
+  <meta property="og:image" content="<%= logo %>" />
   <style>
     @font-face {
       font-family: "Roboto";

package/generators/base/commitlint.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-}