@varlet/cli 2.7.5 → 2.8.0-alpha.1676455225773

package/README.md

@@ -58,6 +58,15 @@ Also refer to `@varlet/ui` [varlet.config.mjs](https://github.com/varletjs/varle
 | `copy` | Copy file options | _[CopyPath[]](https://github.com/varletjs/varlet/blob/dev/packages/varlet-vite-plugins/src/copy.ts)_ | `-` |
 | `icons` | Font icon packaging related configuration | _[VarletConfigIcons](https://github.com/varletjs/varlet/blob/dev/packages/varlet-cli/src/node/config/varlet.config.ts)_ | `-` |
 
+#### Menu
+
+| 参数 | 说明 | 类型 | 默认值 |
+| -- | -------------- | -------- | ---------- |
+| `doc` | The document page corresponds to the matching file name, required | _string_ | `-` |
+| `type` | The type of menu, when the type is `1`, it means the category menu, when the type is `2`, the doc field matches the component file under src, when the type is `3`, the doc field matches the md file under docs, required | _MenuTypes_ | `-` |
+| `text` | The text displayed in the menu, English display text can be configured when internationalization is set, required | _Record<string, string>_ | `-` |
+| `useMobile` | Whether to display the mobile phone preview on the right side on the current document page, if not filled, the default value is useMobile in config  | _boolean_ | `-` |
+
 ### Custom pages
 
 If you want to insert other pages into the component library, you can create a `pages` folder in the project root directory to write a vue component to generate other pages.

package/README.zh-CN.md

@@ -58,6 +58,16 @@ varlet-cli gen
 | `copy` | 复制文件配置 | _[CopyPath[]](https://github.com/varletjs/varlet/blob/dev/packages/varlet-vite-plugins/src/copy.ts)_ | `-` |
 | `icons` | 字体图标打包相关配置 | _[VarletConfigIcons](https://github.com/varletjs/varlet/blob/dev/packages/varlet-cli/src/node/config/varlet.config.ts)_ | `-` |
 
+
+#### Menu
+
+| 参数 | 说明 | 类型 | 默认值 |
+| -- | -------------- | -------- | ---------- |
+| `doc` | 文档页面应匹配的文件名称, 必填 | _string_ | `-` |
+| `type` | menu 类型, 当 type 为 `1` 时表示分类 menu, 类型为 `2` 时 doc 字段匹配 src 下的组件文件, 类型为`3`时 doc 字段匹配 docs 下的 md 文件 | _MenuTypes_ | `-` |
+| `text` | menu 所展示的文字, 当设置国际化时可配置英文展示文字 | _Record<string, string>_ | `-` |
+| `useMobile` | 是否在当前文档页显示右侧手机预览, 如不填写, 默认取 config 中的 useMobile | _boolean_ | `-` |
+
 ### 自定义页面
 
 如果想在组件库中插入其他页面，可以在项目根目录下的创建 `pages` 文件夹编写 vue 组件， 用来生成其他的页面。

package/lib/node/shared/constant.js

@@ -35,15 +35,15 @@ export const SITE_CONFIG = resolve(CWD, '.varlet/site.config.json');
 // template highlight
 export const HL_DIR = resolve(CWD, 'highlight');
 export const HL_COMPONENT_NAME_RE = /.*(\/|\\)(.+)(\/|\\)docs(\/|\\)/;
-export const HL_API_RE = /##\s*API\n+/;
-export const HL_EN_TITLE_ATTRIBUTES_RE = /###\s*Props\s*\n+/;
-export const HL_EN_TITLE_EVENTS_RE = /###\s*Events\s*\n+/;
-export const HL_EN_TITLE_SLOTS_RE = /###\s*Slots\s*\n+/;
+export const HL_API_RE = /##\s*API(?:\r\n|\n)+/;
+export const HL_EN_TITLE_ATTRIBUTES_RE = /###\s*Props(?:\r\n|\n)+/;
+export const HL_EN_TITLE_EVENTS_RE = /###\s*Events(?:\r\n|\n)+/;
+export const HL_EN_TITLE_SLOTS_RE = /###\s*Slots(?:\r\n|\n)+/;
 export const HL_EN_MD = 'en-US.md';
 export const HL_EN_WEB_TYPES_JSON = resolve(HL_DIR, 'web-types.en-US.json');
-export const HL_ZH_TITLE_ATTRIBUTES_RE = /###\s*属性\s*\n+/;
-export const HL_ZH_TITLE_EVENTS_RE = /###\s*事件\s*\n+/;
-export const HL_ZH_TITLE_SLOTS_RE = /###\s*插槽\s*\n+/;
+export const HL_ZH_TITLE_ATTRIBUTES_RE = /###\s*属性(?:\r\n|\n)+/;
+export const HL_ZH_TITLE_EVENTS_RE = /###\s*事件(?:\r\n|\n)+/;
+export const HL_ZH_TITLE_SLOTS_RE = /###\s*插槽(?:\r\n|\n)+/;
 export const HL_ZH_MD = 'zh-CN.md';
 export const HL_ZH_WEB_TYPES_JSON = resolve(HL_DIR, 'web-types.zh-CN.json');
 // icons

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/cli",
-  "version": "2.7.5",
+  "version": "2.8.0-alpha.1676455225773",
   "type": "module",
   "description": "cli of varlet",
   "bin": {
@@ -68,8 +68,8 @@
     "vite": "4.0.4",
     "vue": "3.2.25",
     "vue-jest": "^5.0.0-alpha.8",
-    "@varlet/vite-plugins": "2.7.5",
-    "@varlet/shared": "2.7.5"
+    "@varlet/vite-plugins": "2.8.0-alpha.1676455225773",
+    "@varlet/shared": "2.8.0-alpha.1676455225773"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.12",
@@ -82,8 +82,8 @@
     "@types/semver": "^7.3.9",
     "@types/inquirer": "^9.0.2",
     "@types/sharp": "0.31.1",
-    "@varlet/icons": "2.7.5",
-    "@varlet/touch-emulator": "2.7.5"
+    "@varlet/icons": "2.8.0-alpha.1676455225773",
+    "@varlet/touch-emulator": "2.8.0-alpha.1676455225773"
   },
   "peerDependencies": {
     "@vue/runtime-core": "3.2.16",
@@ -93,8 +93,8 @@
     "lodash-es": "^4.17.21",
     "vue": "3.2.25",
     "vue-router": "4.0.12",
-    "@varlet/icons": "2.7.5",
-    "@varlet/touch-emulator": "2.7.5"
+    "@varlet/icons": "2.8.0-alpha.1676455225773",
+    "@varlet/touch-emulator": "2.8.0-alpha.1676455225773"
   },
   "scripts": {
     "dev": "tsc --watch",

package/site/pc/Layout.vue

@@ -87,6 +87,7 @@ watch(
     componentName.value = getComponentNameByMenuName(_menuName)
     menuName.value = _menuName
     language.value = lang
+    useMobile.value = menu.value.find(item => item.doc === _menuName)?.useMobile ?? get(config, 'useMobile')
     document.title = get(config, 'pc.title')[lang] as string
   },
   { immediate: true }

package/site/utils.ts

@@ -5,6 +5,7 @@ export interface Menu {
   doc: string
   text: Record<string, string>
   type: MenuTypes
+  useMobile?: boolean
 }
 
 export enum MenuTypes {