@varlet/cli 3.15.0-alpha.1776606769606 → 3.15.0

package/README.md

@@ -22,19 +22,17 @@ The out-of-the-box `Vue3 component library` rapid prototyping tool provides a se
 
 ### Recommended toolchain
 
-Under Varlet’s current **component-library toolchain**, we recommend combining **`@varlet/cli`**, **[vite-plus](https://viteplus.dev/)** (`vp`), and **rattail** (`rt`, npm package `rattail`): `@varlet/cli` covers first-party library workflows (docs, compile, tests, …), `vp` covers lint/format and app/extension build entrypoints aligned with the Ox/Rolldown stack, and `rt` covers `clean`, git hooks, `changelog`, `release`, `commit-lint`, and similar automation. Use this trio for **new libraries**, **scaffold upgrades**, or whenever you re-run **`varlet-cli gen`** to match the latest template.
+Under Varlet’s current `component-library toolchain`, we recommend combining `@varlet/cli`, [`vite-plus`](https://viteplus.dev/) (`vp`), and [`rattail`](https://rattail.varletjs.org/) (`rt`): `@varlet/cli` covers first-party library workflows (docs, compile, tests, …), `vp` covers lint/format and app/extension build entrypoints aligned with the Oxc/Rolldown stack, and `rattail` covers `clean`, git hooks, `changelog`, `release`, `commit-lint`, and similar automation. Use this trio for new libraries and scaffold upgrades.
 
 | Piece | Role |
 | --- | --- |
-| **`@varlet/cli`** | First-party Varlet workflows: `create`, `gen`, `dev`, `build`, `preview`, `compile`, `compile:style-vars`, `build:icons`, `test`, … |
-| **[vite-plus](https://viteplus.dev/)** (`vp`) | Lint, format, app/extension `build`/`dev`/`preview`, and other toolchain entrypoints aligned with the Ox/Rolldown stack |
-| **rattail** (`rt`, npm package `rattail`) | `clean`, git hooks, `changelog`, `release`, `commit-lint`, and other repo automation |
+| `@varlet/cli` | First-party Varlet workflows: `create`, `gen`, `dev`, `build`, `preview`, `compile`, `compile:style-vars`, `build:icons`, `test`, … |
+| [`vite-plus`](https://viteplus.dev/) (`vp`) | Lint, format, app/extension `build`/`dev`/`preview`, and other toolchain entrypoints aligned with the Oxc/Rolldown stack |
+| [`rattail`](https://rattail.varletjs.org/) (`rt`) | `clean`, git hooks, `changelog`, `release`, `commit-lint`, and other repo automation |
 
-After upgrading `@varlet/cli`, you can align an existing app with the **latest built-in template** by running **`varlet-cli gen`** again from the parent directory (commit or back up first; `gen` may overwrite generated files).
+### Commands pending deprecation
 
-### Legacy subcommands (prefer alternatives)
-
-These subcommands **still run** for backward compatibility and may print a deprecation notice. **Do not rely on them in new scripts or new projects** — prefer `vp` / `rt` (or `vr` where documented). Any future changes will be called out in release notes.
+These commands still run for backward compatibility and may print a deprecation notice. Do not rely on them in new scripts or new projects — prefer `vp` / `rt` (or `vr` where documented). Any future changes will be called out in release notes.
 
 | Command | Use instead |
 | --- | --- |
@@ -43,9 +41,9 @@ These subcommands **still run** for backward compatibility and may print a depre
 | `varlet-cli dev:extension` | `vp pack --watch` (with a local `vite.config.ts` for the extension) |
 | `varlet-cli build:extension` | `vp pack` |
 | `varlet-cli commit-lint` | `rt commit-lint` |
-| `varlet-cli checklist` | _(no direct replacement; optional manual checklist in docs)_ |
+| `varlet-cli checklist` | Minimal value; deprecated without replacement |
 | `varlet-cli changelog` | `rt changelog` |
-| `varlet-cli release` | `rt release` (or `vr release` from `@varlet/release`) |
+| `varlet-cli release` | `rt release` |
 
 ### Quickstart
 

package/README.zh-CN.md

@@ -22,19 +22,17 @@
 
 ### 推荐技术栈
 
-在全新的 **Varlet 组件库工具链**体系下，我们建议将 **`@varlet/cli`**、**[vite-plus](https://viteplus.dev/)**（`vp`）与 **rattail**（`rt`，npm 包 `rattail`）组合使用：前者覆盖组件库文档站与编译等一等能力，后两者承接与 Ox / Rolldown 栈一致的 lint、format、打包入口，以及 `clean`、Git 钩子、`changelog`、`release`、`commit-lint` 等工程自动化。无论是从零搭建新库，还是升级旧脚手架、需要与模板对齐时，都推荐沿用这一组合。
+在全新的 `Varlet 组件库工具链` 体系下，我们建议将 `@varlet/cli`、[`vite-plus`](https://viteplus.dev/)（`vp`）与 [`rattail`](https://rattail.varletjs.org/)（`rt`）组合使用：前者覆盖组件库文档站与编译等一等能力，后两者承接与 Oxc / Rolldown 栈一致的 lint、format、打包入口，以及 `clean`、git hooks、`changelog`、`release`、`commit-lint` 等工程自动化。无论是从零搭建新库，还是升级旧脚手架、需要与模板对齐时，都推荐沿用这一组合。
 
 | 部分 | 作用 |
 | --- | --- |
-| **`@varlet/cli`** | Varlet 一等能力：`create`、`gen`、`dev`、`build`、`preview`、`compile`、`compile:style-vars`、`build:icons`、`test` 等 |
-| **[vite-plus](https://viteplus.dev/)**（`vp`） | 与 Ox / Rolldown 栈一致的 lint、format、应用/扩展的 `build`/`dev`/`preview` 等入口 |
-| **rattail**（`rt`，npm 包 `rattail`） | `clean`、Git 钩子、`changelog`、`release`、`commit-lint` 等工程自动化 |
+| `@varlet/cli` | Varlet 一等能力：`create`、`gen`、`dev`、`build`、`preview`、`compile`、`compile:style-vars`、`build:icons`、`test` 等 |
+| [`vite-plus`](https://viteplus.dev/)（`vp`） | 与 Oxc / Rolldown 栈一致的 lint、format、应用/扩展的 `build`/`dev`/`preview` 等入口 |
+| [`rattail`](https://rattail.varletjs.org/)（`rt`） | `clean`、git hooks、`changelog`、`release`、`commit-lint` 等工程自动化 |
 
-升级 `@varlet/cli` 后，可在上级目录再次执行 **`varlet-cli gen`**，将已有工程与**当前内置的最新模板**对齐（请先提交或备份；`gen` 可能覆盖生成型文件）。
+### 以下命令即将废弃
 
-### 不建议继续使用的子命令
-
-以下子命令**仍可执行**（会给出废弃相关提示），但**不应在新脚本或新工程中再依赖**，请优先改用 `vp` / `rt`（或文档中的 `vr`）。具体时间表以后续发布说明为准。
+以下命令仍可执行（会给出废弃相关提示），但不应在新脚本或新工程中再依赖，请优先改用 `vp` / `rt`（或文档中的 `vr`）。具体时间表以后续发布说明为准。
 
 | 命令 | 请改用 |
 | --- | --- |
@@ -43,9 +41,9 @@
 | `varlet-cli dev:extension` | `vp pack --watch`（扩展包内需有本地 `vite.config.ts`） |
 | `varlet-cli build:extension` | `vp pack` |
 | `varlet-cli commit-lint` | `rt commit-lint` |
-| `varlet-cli checklist` | 无直接替代；见贡献文档中的提交前说明 |
+| `varlet-cli checklist` | 用处极小，直接废弃 |
 | `varlet-cli changelog` | `rt changelog` |
-| `varlet-cli release` | `rt release`（或 `@varlet/release` 提供的 `vr release`） |
+| `varlet-cli release` | `rt release` |
 
 ### 快速开始
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/cli",
-  "version": "3.15.0-alpha.1776606769606",
+  "version": "3.15.0",
   "description": "cli of varlet",
   "keywords": [
     "cli",
@@ -56,8 +56,8 @@
     "typescript": "5.6.3",
     "vite-plus": "0.1.18",
     "vue": "3.5.21",
-    "@varlet/vite-plugins": "3.15.0-alpha.1776606769606",
-    "@varlet/shared": "3.15.0-alpha.1776606769606"
+    "@varlet/shared": "3.15.0",
+    "@varlet/vite-plugins": "3.15.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.20.1",
@@ -69,9 +69,9 @@
     "@types/node": "^20.19.0",
     "@types/sharp": "0.31.1",
     "rimraf": "^5.0.1",
-    "@varlet/ui": "3.15.0-alpha.1776606769606",
-    "@varlet/icons": "3.15.0-alpha.1776606769606",
-    "@varlet/touch-emulator": "3.15.0-alpha.1776606769606"
+    "@varlet/icons": "3.15.0",
+    "@varlet/touch-emulator": "3.15.0",
+    "@varlet/ui": "3.15.0"
   },
   "peerDependencies": {
     "@vitest/coverage-istanbul": "4.1.4",
@@ -82,9 +82,9 @@
     "live-server": "^1.2.1",
     "vue": "3.5.21",
     "vue-router": "4.5.1",
-    "@varlet/icons": "3.15.0-alpha.1776606769606",
-    "@varlet/touch-emulator": "3.15.0-alpha.1776606769606",
-    "@varlet/ui": "3.15.0-alpha.1776606769606"
+    "@varlet/touch-emulator": "3.15.0",
+    "@varlet/icons": "3.15.0",
+    "@varlet/ui": "3.15.0"
   },
   "engines": {
     "node": "^14.18.0 || >=16.0.0"

package/template/generators/config/i18n/base/varlet.config.mjs

@@ -3,11 +3,86 @@ import { defineConfig } from '@varlet/cli'
 export default defineConfig({
   logo: './logo.svg',
   useMobile: true,
+  title: 'Varlet X',
   pc: {
+    description: {
+      'zh-CN':
+        'Varlet X 是一个基于 Vue3 开发的 Material design 组件库，支持移动端和桌面端，由 varletjs 组织开发和维护。支持 Typescript、按需引入、暗黑模式、主题定制、国际化，并提供 VSCode 插件以保证良好的开发体验。',
+      'en-US':
+        'Varlet X is a Material design component library developed based on Vue3, supporting mobile and desktop, developed and maintained by varletjs organization. Support Typescript, import on demand, dark mode, theme customization, internationalization, and provide VSCode plugin to ensure a good development experience.',
+    },
     header: {
       darkMode: null,
       playground: null,
       versions: null,
+      changelog: null,
+    },
+    indexPage: {
+      sponsors: null,
+      contributors: null,
+      teamMembers: null,
+      features: [
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+        {
+          name: {
+            'zh-CN': '特性',
+            'en-US': 'Feature',
+          },
+          description: {
+            'zh-CN': '特性描述',
+            'en-US': 'Feature description',
+          },
+        },
+      ],
     },
     menu: [
       {
@@ -46,5 +121,11 @@ export default defineConfig({
     header: {
       darkMode: null,
     },
+    title: {
+      'zh-CN':
+        'Varlet X 是一个基于 Vue3 开发的 Material design 组件库，支持移动端和桌面端，由 varletjs 组织开发和维护。支持 Typescript、按需引入、暗黑模式、主题定制、国际化，并提供 VSCode 插件以保证良好的开发体验。',
+      'en-US':
+        'Varlet X is a Material design component library developed based on Vue3, supporting mobile and desktop, developed and maintained by varletjs organization. Support Typescript, import on demand, dark mode, theme customization, internationalization, and provide VSCode plugin to ensure a good development experience.',
+    },
   },
 })

package/template/generators/base/.prettierignore

@@ -1,14 +0,0 @@
-coverage/**
-highlight/**
-es/**
-umd/**
-lib/**
-site/**
-public/**
-.varlet/**
-types/index.d.ts
-*.md
-package.json
-
-pnpm-lock.yaml
-pnpm-workspace.yaml

package/template/generators/config/i18n/sfc/src/locale/__tests__/index.spec.js

@@ -1,52 +0,0 @@
-import { expect, test, vi } from 'vite-plus/test'
-import enUS from '../en-US'
-import { useLocale } from '../index'
-
-function mockConsole(method, fn = () => {}) {
-  const originMethod = console[method]
-
-  console[method] = fn
-
-  return {
-    mockRestore() {
-      console[method] = originMethod
-    },
-  }
-}
-
-test('test add lang', () => {
-  const { add, use, pack, packs } = useLocale()
-
-  const LANG = 'custom'
-  const PACK = {
-    button: 'Custom Text',
-  }
-
-  add(LANG, PACK)
-  use(LANG)
-
-  expect(pack.value.lang).toBe(LANG)
-  expect(packs[LANG]).toBe(PACK)
-})
-
-test('test merge lang', () => {
-  const fn = vi.fn()
-  const { mockRestore } = mockConsole('warn', fn)
-  const { add, use, merge, pack } = useLocale()
-
-  const LANG = 'en-US'
-  const PACK = {
-    button: 'Custom Text',
-  }
-
-  add(LANG, enUS)
-  use('zh_HK')
-  use(LANG)
-  merge('zh_HK', PACK)
-  merge(LANG, PACK)
-
-  expect(pack.value.button).toBe('Custom Text')
-  expect(fn).toHaveBeenCalledTimes(2)
-
-  mockRestore()
-})

package/template/generators/config/i18n/tsx/src/locale/__tests__/index.spec.js

@@ -1,52 +0,0 @@
-import { expect, test, vi } from 'vite-plus/test'
-import enUS from '../en-US'
-import { useLocale } from '../index'
-
-function mockConsole(method, fn = () => {}) {
-  const originMethod = console[method]
-
-  console[method] = fn
-
-  return {
-    mockRestore() {
-      console[method] = originMethod
-    },
-  }
-}
-
-test('test add lang', () => {
-  const { add, use, pack, packs } = useLocale()
-
-  const LANG = 'custom'
-  const PACK = {
-    button: 'Custom Text',
-  }
-
-  add(LANG, PACK)
-  use(LANG)
-
-  expect(pack.value.lang).toBe(LANG)
-  expect(packs[LANG]).toBe(PACK)
-})
-
-test('test merge lang', () => {
-  const fn = vi.fn()
-  const { mockRestore } = mockConsole('warn', fn)
-  const { add, use, merge, pack } = useLocale()
-
-  const LANG = 'en-US'
-  const PACK = {
-    button: 'Custom Text',
-  }
-
-  add(LANG, enUS)
-  use('zh_HK')
-  use(LANG)
-  merge('zh_HK', PACK)
-  merge(LANG, PACK)
-
-  expect(pack.value.button).toBe('Custom Text')
-  expect(fn).toHaveBeenCalledTimes(2)
-
-  mockRestore()
-})