开箱即用的uniapp+vue3+ts模板

1,025 阅读4分钟

最近我以uniapp官方模板为基础,根据自己的工作需要自定义了一个uniapp+vue3+ts的项目模板gitee仓库地址),可以直接点击链接到仓库中查看了解。

本模板的优势

因为官方模板极其简洁,正式项目中往往需要安装和配置很多其他工具,而本模板预先对常用工具都进行了配置,可以做到快速且稳定地部署:

预先配置了Pinia和uni-ui

Pinia属于是非常常用的状态管理包了,不过在特定版本下可能会出现和Vue不兼容的问题,本模板对其版本进行了固定,可以直接放心使用。

uni-ui则是需要安装sass相关包,以及配置easycom,本模板也预先进行了配置。

预先配置了ESLint和StyleLint

ESLintStyleLint可以说是非常常用的代码检测工具了,本模板预先配置好了以airbnb和vue官方推荐的ESLint包为基础的规则,可以直接上手即用,也可以自己再进行二次配置。

ESLint只负责TS和HTML部分的代码规范显然是不够的,所以我也添加了StyleLint对样式相关代码进行规范(支持SCSS),以及添加了自己的css样式分组排序包,基本覆盖了样式代码规范的方方面面,基本不需要再配置。

本项目也推荐使用ESLint插件和StyleLint插件对代码文件进行实时检测和自动格式化,在项目的settings.json中进行了相关的配置,使用VScode进行开发时免去了自己再修改设置的麻烦。

预先配置各种uniapp相关的TS类型包

uniapp官方模板其实没提供完整的uniapp类型包,本模板也提前安装了uni-helper提供的ts类型包,预先支持uniappuni-ui的各种类型。

预先安装和配置了unplugin-auto-import

作为自动导入插件,unplugin-auto-import可以在编译时自动帮我们导入vueuniapp等相关api,而不需要书写import语句。本模板也安装了该插件和进行了完整配置。

预先进行了各种开发环境的配置

相信各位都有被各种vite.config.tsvue.config.jstsconfig.json等配置文件搞到头大的情况,本模板在二次加入各种npm包的情况下,也完整进行了路径解析、环境变量路径、ESLint和TS兼容设置等等一系列相关配置,可以让你在开发过程中更省心,少一些查配置方法的麻烦。

VScode插件和设置也预先进行了配置

作为要达到开箱即用的模板,连开发要使用什么插件,要进行怎样的配置也考虑到了,如果使用VScode进行开发,打开项目后,在扩展搜索栏输入@recommended即可查看本项目推荐的插件,都是经过实践检验适合本项目模板的插件。

而VScode的设置也通过.vscode/settings.json文件进行了配置,特别是预先配置了vue文件保存时自动使用ESLintStyleLint进行修复,而不进行格式化,可以满足开发的同时根据ESLint和StyleLint配置进行代码修复和格式化,避免了部分格式化插件和这两个包规则冲突的情况。

较为完整的项目文档

除了上述各种具体的配置,本模板也编写了较为完整的README.md文档,在其中对本模板从下载、编译、开发、目录结构等都进行了较为详细的说明,在使用时通过阅读README.md就可以对该模板达到较为完整的了解,也方便进行二次修改。

也可以以此为基础,修改作为正式项目的说明文档。

是否有必要使用该模板

从上面也可以看出,相比于官方模板,本模板主要是预先配置好了piniauni-ui,以及添加了ESLintStylelint,如果这些包或工具你的项目都不需要使用,那么本模板其实并不适合你。

因为就算不使用,这些工具的相关配置文件、代码还是存在于项目中,会增加项目的理解难度,甚至当使用其他有冲突的工具时,还会影响项目的开发。

当然,在README.md文档中,我详细说明了各npm包作用,以及项目结构中对应的配置文件,也可以基于此进行二次修改。

模板获取和使用

如果你确定需要使用本模板,则可以在目标文件夹下执行以下命令:

npx degit RJiazhen/uniapp-vue3-ts-template my-project

将本仓库去除git配置后下载到本地,即可使用。

如因为网络问题无法下载,可以点击该链接直接下载gitee仓库代码,解压后删除.git文件夹即可使用。

后续再根据模板中的README.md文档的说明进行开发。