Package.json Scripts 详解
本文档详细解释了项目中 package.json
的 scripts
部分,帮助开发者理解和使用这些命令。
Scripts 列表
脚本名称 | 命令 | 作用描述 |
---|---|---|
dev | vite | 启动 Vite 开发服务器,支持热更新(HMR),用于本地开发。 |
preview | vite preview --port 4173 | 预览生产环境构建结果,默认端口为 4173 。 |
build | vite build | 构建生产环境代码(输出到 dist 目录),包括压缩和优化。 |
deploy | sh scripts/deploy.sh | 执行部署脚本(如上传到服务器或静态托管平台)。 |
build:deploy | vite build && sh scripts/deploy.sh | 组合命令:先构建生产代码,再执行部署脚本。 |
type-check | vue-tsc --noEmit | 对 Vue + TypeScript 项目进行类型检查(不生成文件)。 |
lint | eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore | 用 ESLint 检查并自动修复代码规范问题(忽略 .gitignore 中的文件)。 |
使用示例
开发环境
bash
npm run dev
构建生产代码
bash
npm run build
检查 TypeScript 类型
bash
npm run type-check
一键构建并部署
bash
npm run build:deploy
提示:所有命令均需在项目根目录下执行,依赖需提前安装(
npm install
)。
### 文件说明:
1. **表头**:使用 Markdown 表格清晰展示脚本名称、命令和作用。
2. **代码块**:用 ```bash 高亮命令行示例。
3. **结构化**:分章节(`##`)和列表(`-`)提升可读性。
4. **兼容性**:支持 GitHub/GitLab 等平台的 Markdown 渲染。