create-vee-vue 0.0.0-stage → 1.0.1

package/bin/index.js

@@ -0,0 +1,145 @@
+import { Command } from "commander";
+import { input, select } from "@inquirer/prompts";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const program = new Command();
+
+function normalizePackageName(name) {
+  return (
+    name
+      .trim()
+      .toLowerCase()
+      // 空格和下划线替换为 -
+      .replace(/[\s_]+/g, "-")
+      // 移除不允许的字符
+      .replace(/[^a-z0-9.-]/g, "")
+      // 连续的 - 合并为一个
+      .replace(/-+/g, "-")
+      // 移除开头和结尾的 -
+      .replace(/^-+|-+$/g, "")
+      // npm 包名不能以 . 开头
+      .replace(/^\.+/, "")
+  );
+}
+
+function updatePackageName(targetDir, projectName) {
+  const packageJsonPath = path.join(targetDir, "package.json");
+
+  // 读取 package.json
+  const packageJsonContent = fs.readFileSync(packageJsonPath, "utf-8");
+
+  // JSON 字符串转换成 JavaScript 对象
+  const packageJson = JSON.parse(packageJsonContent);
+
+  // 修改项目名称
+  packageJson.name = projectName;
+
+  // 将对象转换成 JSON 字符串并写入文件
+  fs.writeFileSync(
+    packageJsonPath,
+    JSON.stringify(packageJson, null, 2) + "\n",
+    "utf-8",
+  );
+}
+
+program
+  .name("create-vee-vue")
+  .description("Create a Vue 3 project using my template")
+  .version("1.0.0");
+
+// 项目名称改为可选参数
+program.argument("[project-name]", "项目名称").action(async (projectName) => {
+  try {
+    // 1. 用户没有输入项目名称时，弹出输入框
+    if (!projectName) {
+      projectName = await input({
+        message: "Project name:",
+        default: "my-vue-app",
+        validate(value) {
+          if (!value.trim()) {
+            return "项目名称不能为空";
+          }
+
+          const packageName = normalizePackageName(value);
+
+          if (!packageName) {
+            return "请输入有效的项目名称";
+          }
+
+          if (packageName.length > 214) {
+            return "项目名称不能超过 214 个字符";
+          }
+
+          return true;
+        },
+      });
+    }
+
+    // 去除项目名称首尾空格
+    projectName = projectName.trim();
+
+    // 生成合法的 npm 包名称
+    const packageName = normalizePackageName(projectName);
+
+    // 2. 选择项目模板
+    const templateName = await select({
+      message: "Select a template:",
+      choices: [
+        {
+          name: "Vue 3 + TypeScript",
+          value: "vue-ts",
+        },
+      ],
+    });
+
+    // 3. 计算项目路径
+    const targetDir = path.resolve(process.cwd(), projectName);
+
+    // 4. 计算模板路径
+    const templateDir = path.resolve(__dirname, "../templates", templateName);
+
+    // 5. 检查项目目录是否存在
+    if (fs.existsSync(targetDir)) {
+      console.error(`目录已存在：${targetDir}`);
+      process.exitCode = 1;
+      return;
+    }
+
+    // 6. 检查模板是否存在
+    if (!fs.existsSync(templateDir)) {
+      console.error(`模板不存在：${templateDir}`);
+      process.exitCode = 1;
+      return;
+    }
+
+    // 7. 复制模板
+    console.log(`Scaffolding project in ${projectName}...`);
+
+    fs.cpSync(templateDir, targetDir, {
+      recursive: true,
+    });
+
+    updatePackageName(targetDir, packageName);
+
+    console.log("");
+    console.log("Done!");
+    console.log("");
+    console.log(`  cd ${projectName}`);
+    console.log("  pnpm install");
+    console.log("  pnpm dev");
+  } catch (error) {
+    if (error.name === "AbortPromptError") {
+      console.log("\n取消创建项目");
+      return;
+    }
+
+    console.error(error);
+    process.exitCode = 1;
+  }
+});
+
+program.parseAsync();

package/package.json

@@ -1,6 +1,20 @@
 {
   "name": "create-vee-vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "My custom Vue 3 scaffolding",
+  "type": "module",
+  "bin": {
+    "create-vee-vue": "./bin/index.js"
+  },
+  "files": [
+    "bin",
+    "templates"
+  ],
+  "scripts": {
+    "dev": "node ./bin/index.js"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.7.5",
+    "commander": "^14.0.0"
+  }
+}

package/templates/vue-ts/.editorconfig

@@ -0,0 +1,8 @@
+[*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,vue,css,scss,sass,less,styl}]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+max_line_length = 100

package/templates/vue-ts/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/templates/vue-ts/.oxlintrc.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["eslint", "typescript", "unicorn", "oxc", "vue"],
+  "env": {
+    "browser": true
+  },
+  "categories": {
+    "correctness": "error"
+  }
+}

package/templates/vue-ts/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 100
+}

package/templates/vue-ts/README.md

@@ -0,0 +1,48 @@
+# vee-vue-template
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+
+## Recommended Browser Setup
+
+- Chromium-based browsers (Chrome, Edge, Brave, etc.):
+  - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
+  - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
+- Firefox:
+  - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
+  - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vite.dev/config/).
+
+## Project Setup
+
+```sh
+pnpm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+pnpm dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+pnpm build
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+pnpm lint
+```

package/templates/vue-ts/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/templates/vue-ts/eslint.config.ts

@@ -0,0 +1,26 @@
+import { globalIgnores } from 'eslint/config'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import pluginVue from 'eslint-plugin-vue'
+import pluginOxlint from 'eslint-plugin-oxlint'
+import skipFormatting from 'eslint-config-prettier/flat'
+
+// To allow more languages other than `ts` in `.vue` files, uncomment the following lines:
+// import { configureVueProject } from '@vue/eslint-config-typescript'
+// configureVueProject({ scriptLangs: ['ts', 'tsx'] })
+// More info at https://github.com/vuejs/eslint-config-typescript/#advanced-setup
+
+export default defineConfigWithVueTs(
+  {
+    name: 'app/files-to-lint',
+    files: ['**/*.{vue,ts,mts,tsx}'],
+  },
+
+  globalIgnores(['**/dist/**', '**/dist-ssr/**', '**/coverage/**']),
+
+  ...pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
+
+  ...pluginOxlint.buildFromOxlintConfigFile('.oxlintrc.json'),
+
+  skipFormatting,
+)

package/templates/vue-ts/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/templates/vue-ts/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "vee-vue-template",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "run-p type-check \"build-only {@}\" --",
+    "preview": "vite preview",
+    "build-only": "vite build",
+    "type-check": "vue-tsc --build",
+    "lint": "run-s \"lint:*\"",
+    "lint:oxlint": "oxlint . --fix",
+    "lint:eslint": "eslint . --fix --cache",
+    "format": "prettier --write --experimental-cli src/"
+  },
+  "dependencies": {
+    "vue": "^3.5.42"
+  },
+  "devDependencies": {
+    "@tsconfig/node24": "^24.0.5",
+    "@types/node": "^24.13.4",
+    "@vitejs/plugin-vue": "^6.0.8",
+    "@vue/eslint-config-typescript": "^14.9.0",
+    "@vue/tsconfig": "^0.9.1",
+    "eslint": "^10.10.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-oxlint": "~1.82.0",
+    "eslint-plugin-vue": "~10.11.0",
+    "jiti": "^2.7.0",
+    "npm-run-all2": "^9.0.3",
+    "oxlint": "~1.82.0",
+    "prettier": "3.9.6",
+    "typescript": "~6.0.0",
+    "vite": "^8.2.2",
+    "vite-plugin-vue-devtools": "^8.2.1",
+    "vue-eslint-parser": "^10.4.1",
+    "vue-tsc": "^3.3.11"
+  },
+  "engines": {
+    "node": "^22.18.0 || >=24.12.0"
+  }
+}

package/templates/vue-ts/src/App.vue

@@ -0,0 +1,5 @@
+<script setup lang="ts"></script>
+
+<template>Hello Vue</template>
+
+<style scoped></style>

package/templates/vue-ts/src/main.ts

@@ -0,0 +1,4 @@
+import { createApp } from 'vue'
+import App from './App.vue'
+
+createApp(App).mount('#app')

package/templates/vue-ts/tsconfig.app.json

@@ -0,0 +1,18 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
+  "exclude": ["src/**/__tests__/*"],
+  "compilerOptions": {
+    // Extra safety for array and object lookups, but may have false positives.
+    "noUncheckedIndexedAccess": true,
+
+    // Path mapping for cleaner imports.
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+
+    // `vue-tsc --build` produces a .tsbuildinfo file for incremental type-checking.
+    // Specified here to keep it out of the root directory.
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo"
+  }
+}

package/templates/vue-ts/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}

package/templates/vue-ts/tsconfig.node.json

@@ -0,0 +1,28 @@
+// TSConfig for modules that run in Node.js environment via either transpilation or type-stripping.
+{
+  "extends": "@tsconfig/node24/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "playwright.config.*",
+    "eslint.config.*"
+  ],
+  "compilerOptions": {
+    // Most tools use transpilation instead of Node.js's native type-stripping.
+    // Bundler mode provides a smoother developer experience.
+    "module": "preserve",
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+
+    // Include Node.js types and avoid accidentally including other `@types/*` packages.
+    "types": ["node"],
+
+    // Disable emitting output during `vue-tsc --build`, which is used for type-checking only.
+    "noEmit": true,
+
+    // `vue-tsc --build` produces a .tsbuildinfo file for incremental type-checking.
+    // Specified here to keep it out of the root directory.
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo"
+  }
+}

package/templates/vue-ts/vite.config.ts

@@ -0,0 +1,18 @@
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import vueDevTools from 'vite-plugin-vue-devtools'
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [
+    vue(),
+    vueDevTools(),
+  ],
+  resolve: {
+    alias: {
+      '@': fileURLToPath(new URL('./src', import.meta.url)),
+    },
+  },
+})

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.