create-uniapps 1.0.4 → 1.0.5

package/README.md

@@ -1,191 +1,67 @@
-# 🌈 uni-preset-vue 模板说明文档
+# Nuxt App Starter
 
-一个基于 **Vue3 + TypeScript + Vite + Pinia + TailwindCSS** 的 `uni-app` 模板，内置多端开发环境配置，支持一键运行微信小程序、H5、App 及各类小程序平台。  
-本模板旨在快速搭建跨端项目，统一前端开发规范，提高开发效率。
+一个由我个人搭建和维护的 **Nuxt 4 项目模板**，用于快速创建现代化的前端项目。  
+该模板集成了常用的 UI、样式、代码规范与工程化工具，开箱即用，适合中小型项目快速启动。
 
 ---
 
-## 📦 技术栈
+## ✨ 特性
 
-| 技术                               | 说明                   |
-| ---------------------------------- | ---------------------- |
-| **Vue 3**                          | 渐进式前端框架         |
-| **TypeScript**                     | 静态类型检查           |
-| **Vite**                           | 高性能构建工具         |
-| **Pinia**                          | 轻量级状态管理         |
-| **TailwindCSS**                    | 原子化 CSS 框架        |
-| **VueUse**                         | Vue3 实用工具库        |
-| **Iconify**                        | 图标库整合方案         |
-| **Day.js**                         | 日期处理库             |
-| **Crypto-js / js-md5 / js-base64** | 数据加密与编码工具     |
-| **ESLint + Prettier**              | 统一代码风格与语法检查 |
+- ⚡ 基于 **Nuxt 4 + Vue 3**
+- 🎨 内置 **Tailwind CSS** + **Nuxt UI**
+- 🧩 集成 **Element Plus（Nuxt 模块）**
+- 🧭 使用 **Vue Router 4**
+- 🛠 完整的 **ESLint + Prettier** 代码规范
+- 📦 使用 **ESM（type: module）**
+- 🔧 已配置 PostCSS 与 Sass
+- 🚀 支持构建、开发、生成、预览完整流程
 
 ---
 
-## 🚀 快速开始
-
-### 1️⃣ 安装依赖
-
-```bash
-pnpm install
-# 或
-npm install
-# 或
-yarn
-```
-
-### 2️⃣ 启动开发
-
-可根据需要启动不同端的调试模式：
-
-| 命令                           | 平台说明            |
-| ------------------------------ | ------------------- |
-| `npm run dev:h5`               | 运行 H5 页面        |
-| `npm run dev:mp-weixin`        | 运行微信小程序      |
-| `npm run dev:mp-alipay`        | 运行支付宝小程序    |
-| `npm run dev:mp-toutiao`       | 运行字节跳动小程序  |
-| `npm run dev:mp-baidu`         | 运行百度小程序      |
-| `npm run dev:mp-qq`            | 运行 QQ 小程序      |
-| `npm run dev:mp-xhs`           | 运行小红书小程序    |
-| `npm run dev:quickapp-webview` | 运行快应用          |
-| `npm run dev:h5:ssr`           | 运行 SSR 模式（H5） |
-
----
-
-### 3️⃣ 打包构建
-
-| 命令                             | 说明             |
-| -------------------------------- | ---------------- |
-| `npm run build:h5`               | 构建 H5 版本     |
-| `npm run build:mp-weixin`        | 构建微信小程序   |
-| `npm run build:mp-alipay`        | 构建支付宝小程序 |
-| `npm run build:mp-toutiao`       | 构建字节小程序   |
-| `npm run build:h5:ssr`           | 构建 SSR H5      |
-| `npm run build:quickapp-webview` | 构建快应用       |
-
----
-
-## 🧩 项目结构
-
-```
-uni-preset-vue/
-├── src/
-│   ├── pages/           # 页面目录
-│   ├── components/      # 公共组件
-│   ├── store/           # Pinia 状态管理
-│   ├── utils/           # 工具函数与封装
-│   ├── locales/         # i18n 国际化配置
-│   ├── styles/          # 全局样式与 Tailwind 配置
-│   └── main.ts          # 入口文件
-│
-├── uni_modules/         # uni-app 模块目录
-├── static/              # 静态资源
-├── package.json
-├── vite.config.ts
-├── tsconfig.json
-└── README.md
-```
-
----
-
-## 🧠 开发规范
-
-### 代码规范
-
-- 使用 **TypeScript** 编写逻辑。
-
-- 使用 **ESLint + Prettier + Tailwind** 进行自动格式化。
-
-- 提交前执行：
-
-  ```bash
-  npm run type-check
-  ```
-
-  确保类型检查通过。
-
-### 目录规范
-
-- 页面统一放在 `src/pages/`
-- 公共组件放在 `src/components/`
-- 全局状态放在 `src/store/`
-- 工具函数放在 `src/utils/`
-- 样式配置统一放在 `src/styles/`
-
----
-
-## 🧰 常用依赖说明
-
-| 依赖                                 | 用途           |
-| ------------------------------------ | -------------- |
-| `@vueuse/core`                       | 常用组合式函数 |
-| `dayjs`                              | 时间格式化     |
-| `crypto-js` / `js-md5` / `js-base64` | 数据加密与签名 |
-| `qs`                                 | 请求参数序列化 |
-| `@iconify/vue`                       | 图标组件       |
-| `pinia`                              | 全局状态管理   |
-| `vue-i18n`                           | 多语言支持     |
+## 📦 技术栈
 
----
+### 核心框架
 
-## 🧪 检查与优化
+- **Nuxt** `^4.1.1`
+- **Vue** `^3.5.21`
+- **Vue Router** `^4.5.1`
 
-| 命令                 | 功能                        |
-| -------------------- | --------------------------- |
-| `npm run type-check` | 类型检查                    |
-| `npm run lint`       | 语法检查                    |
-| `npm run format`     | 自动格式化（结合 Prettier） |
+### UI / 样式
 
----
+- **Tailwind CSS** `^3.4.17`
+- **Nuxt UI** `^3.3.3`
+- **Element Plus（Nuxt）** `^1.1.4`
+- **Sass Embedded**
+- **PostCSS**
+- **postcss-custom-media**
 
-## 🌍 支持平台
+### 工程化 & 规范
 
-| 平台                  | 是否支持 |
-| --------------------- | -------- |
-| H5                    | ✅       |
-| 微信小程序            | ✅       |
-| 支付宝小程序          | ✅       |
-| 抖音小程序            | ✅       |
-| 百度小程序            | ✅       |
-| QQ 小程序             | ✅       |
-| 快应用                | ✅       |
-| HarmonyOS (鸿蒙 NEXT) | ✅       |
+- **TypeScript** `^5.9.2`
+- **ESLint** `^9.35.0`
+- **Prettier**
+- **prettier-plugin-tailwindcss**
+- **@types/node**
 
 ---
 
-## 💡 开发建议
+## 📁 项目定位
 
-1. 推荐使用 **VSCode** 搭配以下插件：
+该项目是一个 **基础模板 / 起始项目（Starter）**：
 
-   - 🌟 `Volar`（Vue 3 支持）
-   - 🌟 `ESLint`
-   - 🌟 `Tailwind CSS IntelliSense`
-   - 🌟 `Iconify IntelliSense`
-
-2. 若需自定义端平台启动，请修改 `package.json` 中的 `scripts` 命令。
-
-3. 统一风格建议使用 `prettier-plugin-tailwindcss` 自动调整类名顺序。
-
----
-
-## 🧾 License
-
-本项目模板仅供学习与快速开发使用。  
-如需商用或二次封装，请保留原作者说明或在适当位置注明出处。
+- 不包含业务代码
+- 不强制约束目录结构
+- 适合作为：
+  - 新项目起点
+  - 技术选型实验
+  - 中小型项目基础工程
 
 ---
 
-## 👨‍💻 作者信息
+## 🚀 使用方式
 
-- 作者：josef
-- 模板名称：`uni-preset-vue`
-- 创建时间：2025 年
-- 版本：v1.0.0
+### 安装依赖
 
----
-
-## 📅 更新日志
-
-| 日期       | 版本   | 内容           |
-| ---------- | ------ | -------------- |
-| 2025-10-13 | v1.0.0 | 初始化项目模板 |
+```bash
+npm install
+```

package/index.mjs

@@ -37,6 +37,14 @@ function toValidPackageName(projectName) {
 		.replace(/[^a-z0-9-~]+/g, "-");
 }
 
+// 将包名转换为目录名
+function packageNameToDirName(packageName) {
+	if (packageName.includes("/")) {
+		return packageName.split("/")[1];
+	}
+	return packageName;
+}
+
 // 交互式提问
 async function askForOptions(targetDir) {
 	const options = await prompt([
@@ -59,11 +67,11 @@ async function askForOptions(targetDir) {
 	return options;
 }
 
-// 拷贝模板（固定模板）
+// 拷贝模板
 async function copyTemplate(src, dest) {
 	const spinner = ora(`正在创建项目...`).start();
 	try {
-		await copy(src, dest); // 直接拷贝 src 下的所有文件到 dest
+		await copy(src, dest);
 		spinner.succeed("项目创建成功");
 	} catch (err) {
 		spinner.fail("项目创建失败");
@@ -121,34 +129,44 @@ function printCompletion(targetDir, installDeps) {
 	}
 
 	console.log(chalk.dim(` # 启动开发服务器`));
-	console.log(` npm run dev:h5`);
+	console.log(` npm run dev`);
+	console.log();
+	console.log(chalk.dim(` # 构建生产版本`));
+	console.log(` npm run build`);
+	console.log();
 }
 
 // 主函数
 async function main() {
 	printWelcome();
 
-	// 获取目标目录
-	const targetDir = process.argv[2];
+	// 获取初始目标目录
+	const initialTargetDir = process.argv[2];
 
-	if (!targetDir) {
+	if (!initialTargetDir) {
 		console.error(
 			chalk.red("❌ 必须指定项目名称，例如:") +
-			chalk.cyan(" npx create-uniapps my-project")
+			chalk.cyan("npx create-uniapps my-project")
 		);
 		process.exit(1);
 	}
 
-	// 检查目录是否已存在
-	const destDir = resolve(process.cwd(), targetDir);
-	if (fsExtra.existsSync(destDir)) {
-		console.error(chalk.red(`❌ 目录 "${targetDir}" 已存在!`));
-		process.exit(1);
-	}
+	let destDir = null;
+	let finalDirName = null;
 
 	try {
-		// 获取用户选项
-		const options = await askForOptions(targetDir);
+		// 先获取用户选项
+		const options = await askForOptions(initialTargetDir);
+
+		// 基于用户输入的项目名称确定最终目录名
+		finalDirName = packageNameToDirName(options.packageName);
+		destDir = resolve(process.cwd(), finalDirName);
+
+		// 检查目录是否已存在
+		if (fsExtra.existsSync(destDir)) {
+			console.error(chalk.red(`❌ 目录 "${finalDirName}" 已存在!`));
+			process.exit(1);
+		}
 
 		// 拷贝模板
 		await copyTemplate(join(__dirname, "template"), destDir);
@@ -162,12 +180,12 @@ async function main() {
 		}
 
 		// 打印完成信息
-		printCompletion(targetDir, options.installDeps);
+		printCompletion(finalDirName, options.installDeps);
 	} catch (err) {
 		console.error(chalk.red("❌ 创建项目失败:"), err.message);
 
 		// 清理已创建的文件
-		if (fsExtra.existsSync(destDir)) {
+		if (destDir && fsExtra.existsSync(destDir)) {
 			const spinner = ora("清理已创建的文件...").start();
 			await remove(destDir);
 			spinner.succeed("清理完成");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-uniapps",
-	"version": "1.0.4",
+	"version": "1.0.5",
 	"description": "UniApps template",
 	"main": "index.js",
 	"bin": {
@@ -8,15 +8,14 @@
 	},
 	"files": [
 		"index.mjs",
-		"template",
-		"README.md"
+		"template"
 	],
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://gitee.com/hu-hai-aaa/uniapps.git"
+		"url": "https://github.com/359Steve/create-uniplus.git"
 	},
 	"keywords": [
 		"uniapp",

package/template/.prettierrc

@@ -0,0 +1,9 @@
+{
+    "plugins": ["prettier-plugin-tailwindcss"],
+    "vueIndentScriptAndStyle": false,
+    "printWidth": 120,
+    "singleQuote": true,
+    "semi": true,
+    "tabWidth": 4,
+    "htmlWhitespaceSensitivity": "ignore"
+}

package/template/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+	"editor.formatOnSave": true,
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"[vue]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[typescript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[javascript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[json]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact",
+		"vue"
+	],
+	"prettier.requireConfig": true
+}

package/template/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Josef-qiao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/template/README.md

@@ -1,6 +1,6 @@
 # 🌈 uni-preset-vue 模板说明文档
 
-一个基于 **Vue3 + TypeScript + Vite + Pinia + TailwindCSS** 的 `uni-app` 模板，内置多端开发环境配置，支持一键运行微信小程序、H5、App 及各类小程序平台。  
+一个基于 **Vue3 + TypeScript + Vite + Pinia + TailwindCSS** 的 `uni-app` 模板，内置多端开发环境配置，支持一键运行微信小程序、H5、App 及各类小程序平台。
 本模板旨在快速搭建跨端项目，统一前端开发规范，提高开发效率。
 
 ---
@@ -169,7 +169,7 @@ uni-preset-vue/
 
 ## 🧾 License
 
-本项目模板仅供学习与快速开发使用。  
+本项目模板仅供学习与快速开发使用。
 如需商用或二次封装，请保留原作者说明或在适当位置注明出处。
 
 ---

package/template/eslint.config.ts

@@ -0,0 +1,23 @@
+// eslint.config.ts
+import antfu from '@antfu/eslint-config';
+
+export default antfu({
+    vue: true,
+    typescript: true,
+    stylistic: {
+        indent: 'tab',
+        quotes: 'single',
+        semi: true,
+    },
+    ignores: ['**/dist', '**/node_modules', '**/.vite', '**/auto-imports.d.ts', '**/components.d.ts'],
+    rules: {
+        'style/indent': 'off',
+        'style/no-tabs': 'off',
+        'unused-imports/no-unused-vars': 'warn',
+        'style/brace-style': 'warn',
+        'ts/no-empty-object-type': 'warn',
+        'style/eol-last': 'off',
+        'no-console': 'off',
+        'vue/html-indent': 'off',
+    },
+});