这里还是使用vue官方的脚手架创建项目,虽然Vite发展迅速,但对vue支持还是有所欠缺,还有很大的发展空间,大家可以根据自己的项目需求适当选择工具。
1、项目搭建
// 创建项目
vue create vue3-ts-ms
具体构建流程如下:
2、项目规范
2.1、.editorconfig
配置
.editorconfig
配置有助于为不同开发编辑器上开发同一项目的多个开发人员维护一致的编码风格。VScode编辑器读取该文件时,需要手动下载EditorConfig for VS Code
插件。
# http://editorconfig.org
root = true
[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格(tab | space)
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行
[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false
2.2、prettier
工具
Prettier 是一款强大的代码格式化工具,支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言,基本上前端能用到的文件格式它都可以格式处理,也是当下最流行的代码格式化工具。使用VScode编辑器时,需要安装Prettier - Code formatter
的插件。
2.2.1、安装prettier
// 考虑到协调开发,需要在项目里统一安装
npm install prettier -D
2.2.2、配置.prettierrc
文件
{
"useTabs": false, // 使用tab缩进还是空格缩进,选择false;
"tabWidth": 2, // tab是空格的情况下,是几个空格,选择2个;
"printWidth": 80, // 当行字符的长度,推荐80,也可以按照喜好设置;
"singleQuote": true, // 使用单引号还是双引号,选择true,使用单引号;
"trailingComma": "none", // 在多行输入的尾逗号是否添加,设置为 `none`;
"semi": false // 语句末尾是否要加分号,默认值true,选择false表示不加;
}
2.2.3、配置.prettierignore
忽略文件
/dist/*
.local
.output.js
/node_modules/**
**/*.svg
**/*.sh
/public/*
2.2.4、测试prettier是否生效
在package.json中配置一个scripts:
"prettier": "prettier --write ."
- 测试一:在代码中保存代码;
- 测试二:配置一次性修改的命令
npm run prettier
;
2.3、ESLint
检测
在创建项目的时候,我们就选择了ESLint,所以Vue会默认帮助我们配置需要的ESLint环境。由于我们也使用了prettier,这就需要解决eslint和prettier冲突的问题。使用VScode编辑器时,需要安装ESLint
的插件。
安装插件:(vue在创建项目时,如果选择prettier,那么这两个插件会自动安装)
npm i eslint-plugin-prettier eslint-config-prettier -D
安装完成后需要在.eslintrc.js
文件追加配置:
extends: [
'plugin:vue/vue3-essential',
'eslint:recommended',
'@vue/typescript/recommended',
'@vue/prettier',
'@vue/prettier/@typescript-eslint',
'plugin:prettier/recommended'
],