create-vue-workspace 0.1.0 → 0.1.1

package/README.md

@@ -11,6 +11,7 @@
 ```
 cvw new [name]                  # 创建工作区
 cvw generate <type> [name]      # 运行生成器，别名 cvw g
+cvw update                      # 更新 cvw 自身到最新版本
 ```
 
 ### 生成器
@@ -71,9 +72,30 @@ cvw new          # 追问：工程信息
 cvw g list       # 打印生成器清单
 ```
 
+### 自更新
+
+```bash
+cvw update                  # 检查并升级到最新版本（会先询问确认）
+cvw update --check          # 只检查，不升级
+cvw update -y               # 不询问，直接升级
+cvw update --manager pnpm   # 指定包管理器
+```
+
+| 参数 | 说明 |
+| --- | --- |
+| `--check` | 只检查是否有新版本 |
+| `--manager <npm\|pnpm\|yarn\|bun>` | 指定用于升级的包管理器 |
+| `-y, --yes` | 不询问，直接升级 |
+
+说明：
+
+- 升级的是 **CLI 自身**，不会改动已生成的工程
+- 通过 `npx` / `pnpm dlx` 临时运行时会提示「无需手动更新」（这类方式每次都拉取最新版）
+- 安装方式由可执行文件路径推断（识别 pnpm / yarn / bun 的特征目录），推断不出时回退 `npm`；**实际执行的命令会先打印出来**，避免装错位置
+
 ### 名称归一化
 
-输入 `Button` / `button` / `input_group` 都会被归一化：目录 `button`、组件名 `FButton`、选择器 `f-button`、文件 `button.component.tsx`。
+输入 `Button` / `button` / `input_group` 都会被归一化：目录 `button`、组件名 `FButton`、选择器 `f-button`、组件文件 `components/button.component.tsx`。
 
 `cvw g h use-theme` 与 `cvw g h theme` 等价（自动去掉 `use` 前缀）。
 
@@ -94,10 +116,13 @@ my-app/
 │   ├── ui/                     # @my-app/ui，组件聚合包
 │   ├── utils/                  # @my-app/utils，纯 TS 工具
 │   └── button/                 # cvw g c 生成，独立组件包
-│       ├── index.ts
-│       ├── button.component.tsx
-│       ├── button.props.ts
-│       ├── composition/
+│       ├── index.ts            # 入口：导出组件与 props 类型
+│       ├── components/         # 组件实现
+│       │   ├── button.component.tsx
+│       │   └── button.props.ts
+│       ├── composition/        # 可组合逻辑
+│       ├── button.scss
+│       ├── types.ts
 │       ├── __tests__/
 │       ├── package.json
 │       └── vite.config.ts
@@ -106,7 +131,7 @@ my-app/
 └── .changeset/
 ```
 
-组件骨架遵循《Farris UI Vue 组件开发规范》：`index.ts` + `<name>.component.tsx` + `<name>.props.ts` + `composition/` + `__tests__/`，组件名 `F` 前缀、选择器 `f-` 前缀。
+组件骨架基于《Farris UI Vue 组件开发规范》，并按本仓库约定调整：组件实现（`<name>.component.tsx`、`<name>.props.ts`）统一放在 `components/` 下，与 `composition/`、`__tests__/` 平级；样式 `<name>.scss` 保留在组件包根目录。组件名 `F` 前缀、选择器 `f-` 前缀。
 
 ## 开发约定
 

package/dist/index.mjs

@@ -8,7 +8,9 @@ import { fileURLToPath } from 'node:url';
 import { execa } from 'execa';
 
 const CLI_NAME = "cvw";
-const CLI_FULL_NAME = "create-vue-workspace";
+const PACKAGE_NAME = "create-vue-workspace";
+const CLI_FULL_NAME = PACKAGE_NAME;
+const DEFAULT_REGISTRY = "https://registry.npmjs.org/";
 const APP_DIR_NAME = "web";
 const DEFAULT_PORT = 5173;
 const DEFAULT_PACKAGES = ["ui", "utils"];
@@ -233,13 +235,18 @@ function createComponentNaming(input) {
   };
 }
 
-function unwrap$1(value) {
+function unwrap(value) {
   if (p.isCancel(value)) {
     p.cancel("\u5DF2\u53D6\u6D88\u3002");
     process.exit(0);
   }
   return value;
 }
+async function confirmOrCancel(message) {
+  const answer = await p.confirm({ message });
+  return unwrap(answer);
+}
+
 function normalizeScope(raw, projectName) {
   const value = (raw ?? "").trim() || projectName;
   return value.startsWith("@") ? value : `@${value}`;
@@ -262,16 +269,16 @@ async function resolveNewAnswers(nameOption, options) {
   let port = options.port ? Number(options.port) : DEFAULT_PORT;
   let ui = options.ui === "none" ? "none" : "farris";
   if (isInteractive(options)) {
-    name = unwrap$1(
+    name = unwrap(
       await p.text({ message: "\u5DE5\u7A0B\u76EE\u5F55\u540D", placeholder: defaultName, defaultValue: defaultName })
     );
     scope = normalizeScope(
-      unwrap$1(
+      unwrap(
         await p.text({ message: "\u5305 scope\uFF08\u751F\u6210\u7269\u5305\u540D\u524D\u7F00\uFF09", placeholder: scope, defaultValue: scope })
       ),
       projectName
     );
-    packages = unwrap$1(
+    packages = unwrap(
       await p.multiselect({
         message: "\u521D\u59CB\u521B\u5EFA\u54EA\u4E9B packages",
         options: [
@@ -283,11 +290,11 @@ async function resolveNewAnswers(nameOption, options) {
       })
     );
     port = Number(
-      unwrap$1(
+      unwrap(
         await p.text({ message: "\u5E94\u7528\u5F00\u53D1\u7AEF\u53E3", placeholder: String(port), defaultValue: String(port) })
       )
     );
-    ui = unwrap$1(
+    ui = unwrap(
       await p.select({
         message: "UI \u57FA\u7840\u5E93",
         options: [
@@ -322,6 +329,16 @@ async function runCommand(command, args, cwd) {
 ${detail}`);
   }
 }
+async function captureCommand(command, args, cwd) {
+  try {
+    const { stdout } = await execa(command, args, { cwd, stdio: "pipe" });
+    return stdout;
+  } catch (error) {
+    const detail = error instanceof Error ? error.message : String(error);
+    throw new Error(`\u6267\u884C\u547D\u4EE4\u5931\u8D25\uFF1A${command} ${args.join(" ")}
+${detail}`);
+  }
+}
 async function tryRunCommand(command, args, cwd) {
   try {
     await execa(command, args, { cwd, stdio: "pipe" });
@@ -433,6 +450,129 @@ async function installDependencies(targetDir, answers) {
   spinner.stop("\u4F9D\u8D56\u5B89\u88C5\u5B8C\u6210");
 }
 
+function parseVersion(version) {
+  return version.replace(/^v/i, "").split("-")[0].split(".").map((part) => Number.parseInt(part, 10) || 0).concat([0, 0, 0]).slice(0, 3);
+}
+function compareVersions(left, right) {
+  const leftParts = parseVersion(left);
+  const rightParts = parseVersion(right);
+  for (let index = 0; index < 3; index += 1) {
+    if (leftParts[index] !== rightParts[index]) {
+      return leftParts[index] > rightParts[index] ? 1 : -1;
+    }
+  }
+  return 0;
+}
+function isNewerVersion(candidate, current) {
+  return compareVersions(candidate, current) > 0;
+}
+
+const PACKAGE_MANAGERS = ["npm", "pnpm", "yarn", "bun"];
+const GLOBAL_INSTALL_ARGS = {
+  npm: ["install", "-g", `${PACKAGE_NAME}@latest`],
+  pnpm: ["add", "-g", `${PACKAGE_NAME}@latest`],
+  yarn: ["global", "add", `${PACKAGE_NAME}@latest`],
+  bun: ["add", "-g", `${PACKAGE_NAME}@latest`]
+};
+function normalizeScriptPath() {
+  return (process.argv[1] ?? "").replace(/\\/g, "/");
+}
+function detectManager() {
+  const scriptPath = normalizeScriptPath();
+  if (scriptPath.includes("/.pnpm/") || scriptPath.includes("/pnpm/")) {
+    return "pnpm";
+  }
+  if (scriptPath.includes("/.yarn/") || scriptPath.includes("/yarn/")) {
+    return "yarn";
+  }
+  if (scriptPath.includes("/.bun/") || scriptPath.includes("/bun/")) {
+    return "bun";
+  }
+  return "npm";
+}
+function resolveManager(raw) {
+  if (!raw) {
+    return detectManager();
+  }
+  const value = raw.trim().toLowerCase();
+  if (!PACKAGE_MANAGERS.includes(value)) {
+    throw new Error(`\u4E0D\u652F\u6301\u7684\u5305\u7BA1\u7406\u5668 "${raw}"\uFF0C\u53EF\u9009\uFF1A${PACKAGE_MANAGERS.join(" / ")}`);
+  }
+  return value;
+}
+function buildUpgradeCommand(manager) {
+  return [manager, ...GLOBAL_INSTALL_ARGS[manager]].join(" ");
+}
+function isEphemeralRun() {
+  const scriptPath = normalizeScriptPath();
+  return scriptPath.includes("/_npx/") || scriptPath.includes("/dlx/");
+}
+async function resolveRegistry() {
+  try {
+    const registry = (await captureCommand("npm", ["config", "get", "registry"], process.cwd())).trim();
+    return registry && registry !== "undefined" ? registry : DEFAULT_REGISTRY;
+  } catch {
+    return DEFAULT_REGISTRY;
+  }
+}
+async function fetchLatestVersion(registry) {
+  const url = `${registry.replace(/\/+$/, "")}/${PACKAGE_NAME}`;
+  const response = await fetch(url, {
+    headers: { accept: "application/vnd.npm.install-v1+json" }
+  });
+  if (response.status === 404) {
+    throw new Error(`registry\uFF08${registry}\uFF09\u4E0A\u672A\u627E\u5230 ${PACKAGE_NAME}\uFF0C\u53EF\u80FD\u5C1A\u672A\u53D1\u5E03\u3002`);
+  }
+  if (!response.ok) {
+    throw new Error(`\u67E5\u8BE2\u6700\u65B0\u7248\u672C\u5931\u8D25\uFF1AHTTP ${response.status}\uFF08${url}\uFF09`);
+  }
+  const metadata = await response.json();
+  const latest = metadata["dist-tags"]?.latest;
+  if (!latest) {
+    throw new Error(`\u672A\u80FD\u4ECE registry \u89E3\u6790 ${PACKAGE_NAME} \u7684 latest \u7248\u672C\u3002`);
+  }
+  return latest;
+}
+async function updateCommand(options) {
+  p.intro(pc.bgCyan(pc.black(` ${CLI_NAME} update `)));
+  const manager = resolveManager(options.manager);
+  const spinner = p.spinner();
+  spinner.start(`\u68C0\u67E5 ${PACKAGE_NAME} \u7684\u6700\u65B0\u7248\u672C`);
+  const registry = await resolveRegistry();
+  let latest;
+  try {
+    latest = await fetchLatestVersion(registry);
+  } catch (error) {
+    spinner.stop("\u68C0\u67E5\u5931\u8D25");
+    throw error;
+  }
+  spinner.stop(`\u5F53\u524D ${VERSION} \xB7 \u6700\u65B0 ${latest}`);
+  if (!isNewerVersion(latest, VERSION)) {
+    p.outro(pc.green("\u5DF2\u662F\u6700\u65B0\u7248\u672C\uFF0C\u65E0\u9700\u66F4\u65B0"));
+    return;
+  }
+  if (isEphemeralRun()) {
+    p.log.info("\u5F53\u524D\u901A\u8FC7 npx / pnpm dlx \u4E34\u65F6\u8FD0\u884C\uFF0C\u8FD9\u7C7B\u65B9\u5F0F\u6BCF\u6B21\u90FD\u4F1A\u62C9\u53D6\u6700\u65B0\u7248\uFF0C\u65E0\u9700\u624B\u52A8\u66F4\u65B0\u3002");
+    p.outro(pc.dim(`\u5982\u9700\u56FA\u5B9A\u5B89\u88C5\uFF1A${buildUpgradeCommand("npm")}`));
+    return;
+  }
+  const upgradeCommand = buildUpgradeCommand(manager);
+  p.log.info(`\u5347\u7EA7\u547D\u4EE4\uFF1A${pc.cyan(upgradeCommand)}`);
+  if (options.check) {
+    p.outro(pc.yellow(`\u53D1\u73B0\u65B0\u7248\u672C ${latest}\uFF08\u5F53\u524D ${VERSION}\uFF09\uFF0C\u5DF2\u6309 --check \u8DF3\u8FC7\u5347\u7EA7`));
+    return;
+  }
+  if (!options.yes) {
+    const confirmed = await confirmOrCancel(`\u662F\u5426\u73B0\u5728\u5347\u7EA7\u5230 ${latest}\uFF1F`);
+    if (!confirmed) {
+      p.outro("\u5DF2\u53D6\u6D88");
+      return;
+    }
+  }
+  await runCommand(manager, GLOBAL_INSTALL_ARGS[manager], process.cwd());
+  p.outro(pc.green(`\u5347\u7EA7\u5B8C\u6210\uFF0C\u8BF7\u91CD\u65B0\u6267\u884C ${CLI_NAME} --version \u786E\u8BA4\u7248\u672C`));
+}
+
 function stringify(manifest) {
   return `${JSON.stringify(manifest, null, 2)}
 `;
@@ -611,7 +751,7 @@ function componentGenerator(inputName, options, context) {
   const packageName = `${scope}/${naming.packageName}`;
   const skip = [];
   if (!options.withSub) {
-    skip.push("components");
+    skip.push("components/{{fileName}}-sub.component.tsx");
   }
   if (options.skipTests) {
     skip.push("__tests__");
@@ -824,13 +964,6 @@ function formatGeneratorList() {
   ).join("\n");
 }
 
-function unwrap(value) {
-  if (p.isCancel(value)) {
-    p.cancel("\u5DF2\u53D6\u6D88\u3002");
-    process.exit(0);
-  }
-  return value;
-}
 async function resolveGenerateInput(type, name, options) {
   const interactive = !options.yes && Boolean(process.stdout.isTTY);
   let generator = type ? resolveGenerator(type) : void 0;
@@ -900,6 +1033,9 @@ function runCli(argv = process.argv) {
   cli.command("new [name]", "\u521B\u5EFA Vue 3 + Vite + TypeScript \u7684 pnpm monorepo \u5DE5\u4F5C\u533A").option("--scope <scope>", "\u751F\u6210\u7269\u7684\u5305 scope\uFF0C\u5982 @my-app").option("--packages <list>", "\u521D\u59CB\u521B\u5EFA\u7684 packages\uFF0C\u9017\u53F7\u5206\u9694", { default: "ui,utils" }).option("--ui <provider>", "UI \u57FA\u7840\u5E93\uFF1Afarris \u6216 none", { default: "farris" }).option("--port <port>", "\u5E94\u7528\u5F00\u53D1\u7AEF\u53E3").option("--skip-install", "\u8DF3\u8FC7\u4F9D\u8D56\u5B89\u88C5").option("--skip-git", "\u8DF3\u8FC7 git \u521D\u59CB\u5316").option("--dry-run", "\u53EA\u6253\u5370\u5C06\u751F\u6210\u7684\u6587\u4EF6\uFF0C\u4E0D\u843D\u76D8").option("-y, --yes", "\u5168\u90E8\u4F7F\u7528\u9ED8\u8BA4\u503C\uFF0C\u975E\u4EA4\u4E92\u6267\u884C").action((name, options) => {
     handleCommand(() => newCommand(name, options));
   });
+  cli.command("update", "\u66F4\u65B0 cvw \u81EA\u8EAB\u5230\u6700\u65B0\u7248\u672C\uFF08\u4E0D\u5F71\u54CD\u5DF2\u751F\u6210\u7684\u5DE5\u7A0B\uFF09").option("--check", "\u53EA\u68C0\u67E5\u662F\u5426\u6709\u65B0\u7248\u672C\uFF0C\u4E0D\u6267\u884C\u5347\u7EA7").option("--manager <manager>", "\u6307\u5B9A\u5305\u7BA1\u7406\u5668\uFF1Anpm / pnpm / yarn / bun").option("-y, --yes", "\u4E0D\u8BE2\u95EE\uFF0C\u76F4\u63A5\u5347\u7EA7").action((options) => {
+    handleCommand(() => updateCommand(options));
+  });
   registerGenerate(cli, "generate", true);
   registerGenerate(cli, "g", false);
   cli.help();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vue-workspace",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Scaffold a Vue 3 pnpm monorepo (apps/* + packages/*) with independently publishable component packages.",
   "type": "module",
   "license": "MIT",

package/templates/component/__tests__/{{fileName}}.component.spec.tsx

@@ -1,6 +1,6 @@
 import { mount } from '@vue/test-utils';
 import { describe, expect, it } from 'vitest';
-import {{pascalName}} from '../{{fileName}}.component';
+import {{pascalName}} from '../components/{{fileName}}.component';
 
 describe('{{selector}}', () => {
   it('默认渲染根节点', () => {

package/templates/component/{{{fileName}}.component.tsx → components/{{fileName}}.component.tsx}

@@ -1,8 +1,8 @@
 import { defineComponent, ref, type SetupContext } from 'vue';
+import { use{{pascalName}}Composition } from '../composition/use-{{fileName}}';
 import { {{propsName}}, {{propsTypeName}} } from './{{fileName}}.props';
-import { use{{pascalName}}Composition } from './composition/use-{{fileName}}';
 
-import './{{fileName}}.scss';
+import '../{{fileName}}.scss';
 
 export default defineComponent({
   name: '{{componentName}}',

package/templates/component/composition/use-{{fileName}}.ts

@@ -1,5 +1,5 @@
 import { computed, type ComputedRef, type Ref, type SetupContext } from 'vue';
-import type { {{propsTypeName}} } from '../{{fileName}}.props';
+import type { {{propsTypeName}} } from '../components/{{fileName}}.props';
 
 export interface Use{{pascalName}} {
   /** 组件根节点样式 */

package/templates/component/index.ts

@@ -1,7 +1,7 @@
 import type { App } from 'vue';
-import {{pascalName}} from './{{fileName}}.component';
+import {{pascalName}} from './components/{{fileName}}.component';
 
-export * from './{{fileName}}.props';
+export * from './components/{{fileName}}.props';
 
 export { {{pascalName}} };