Skip to content

Latest commit

 

History

History
153 lines (126 loc) · 6.34 KB

README.md

File metadata and controls

153 lines (126 loc) · 6.34 KB
Raw

vite-vue3

Vue 3 + Typescript + Vite.

准备

安装使用

  • 获取项目代码
git clone https://github.com/liu-fatty/vite-vue3.git
  • 安装依赖
cd vite-vue3

yarn install
  • 运行
yarn serve
  • 打包
yarn build

npm script

"scripts": {
  // 安装依赖
  "bootstrap": "yarn install",
  // 运行项目
  "serve": "npm run dev",
  // 运行项目
  "dev": "vite",
  // 构建项目
  "build": "cross-env NODE_ENV=production vite build && esno ./build/script/postBuild.ts",
  // 清空缓存后构建项目
  "build:no-cache": "yarn clean:cache && npm run build",
  // 生成打包分析，在 `Mac OS` 电脑上执行完成后会自动打开界面，在 `Window` 电脑上执行完成后需要打开 `./build/.cache/stats.html` 查看
  "report": "cross-env REPORT=true npm run build",
  // 类型检查
  "type:check": "vue-tsc --noEmit --skipLibCheck",
  // 预览打包后的内容（先打包在进行预览）
  "preview": "npm run build && vite preview",
  // 直接预览本地 dist 文件目录
  "preview:dist": "vite preview",
  // 生成 ChangeLog
  "log": "conventional-changelog -p angular -i CHANGELOG.md -s",
  // 删除缓存
  "clean:cache": "rimraf node_modules/.cache/ && rimraf node_modules/.vite",
  // 删除 node_modules (`window` 系统手动删除该目录较慢，可以使用该命令来进行删除)
  "clean:lib": "rimraf node_modules",
  // 执行 eslint 校验，并修复部分问题
  "lint:eslint": "eslint \"{src,mock}/**/*.{vue,ts,tsx}\" --fix",
  // 执行 prettier 格式化（该命令会对项目所有代码进行 prettier 格式化，请谨慎执行）
  "lint:prettier": "prettier --write --loglevel warn \"src/**/*.{js,json,tsx,css,less,scss,vue,html,md}\"",
  // 执行 stylelint 格式化
  "lint:stylelint": "stylelint --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
  "lint:lint-staged": "lint-staged",
  // 重新安装依赖 该命令会先删除 node_modules、yarn.lock、package.lock.json 后再进行依赖重新安装（安装速度会明显变慢）
  "reinstall": "rimraf yarn.lock && rimraf package.lock.json && rimraf node_modules && npm run bootstrap",
  "prepare": "husky install"
},

目录说明

.
├── build # 打包脚本相关
│   ├── config # 配置文件
│   ├── generate # 生成器
│   ├── script # 脚本
│   └── vite # vite配置
├── public # 公共静态资源目录
├── src # 主目录
│   ├── api # 接口文件
│   ├── assets # 资源文件
│   │   ├── fonts # 字体图标文件夹
│   │   ├── icons # icon sprite 图标文件夹
│   │   ├── images # 项目存放图片的文件夹
│   │   └── style # 公共样式文件
│   ├── components # 公共组件
│   ├── enums # 枚举/常量
│   ├── hooks # hook
│   ├── layouts # 布局文件
│   │   ├── basic # 页面布局
│   │   └── blank # 空页面
│   ├── router # 路由配置
│   ├── store # 数据仓库
│   ├── utils # 工具类
│   ├── views # 页面
│   └── main.ts # 主入口
├── types # 类型文件
└── vite.config.ts # vite配置文件

Git 提交规范

  • 参考 vue 规范 (Angular)

    • feat 增加新功能
    • fix 修复问题/BUG
    • style 代码风格相关无影响运行结果的
    • perf 优化/性能提升
    • refactor 重构
    • revert 撤销修改
    • test 测试相关
    • docs 文档/注释
    • chore 依赖更新/脚手架配置修改等
    • workflow 工作流改进
    • ci 持续集成
    • types 类型定义文件更改
    • wip 开发中

浏览器支持

Chrome 80+ 本地开发推荐使用 Chrome 80+ 浏览器

支持现代浏览器, 不支持 IE

Edge
IE		 Edge
Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

相关仓库