vue3.0+vite2.0+ts框架搭建
写在开头
为了更好的了解前端vue3.0+vite2.0+ts进行项目开发，特整理整个项目框架搭建的步骤，以便于学习
1、使用vite创建Vue项目
# npm 6.x
npm init @vitejs/app my-vue-app --template vue
# npm 7+, 需要额外的双横线：
npm init @vitejs/app my-vue-app -- --template vue
# yarn
yarn create @vitejs/app my-vue-app --template vue
支持的模板预设包括：
- vanilla
- vue
- vue-ts
- react
- react-ts
- preact
- preact-ts
- lit-element
- lit-element-ts
2、修改项目目录、统一项目固定目录意义
最终生成的目录如下：
|-- .vscode vscode工作区配置
| |-- settings.json 详细配置json 统一vscode风格
|-- dist 项目打包生成的目录
|-- node_modules 安装的依赖包
|-- public public中的静态资源会被复制到输出目录(dist)中
|-- src 项目主要文件
| |-- api 与后端交互使用相关方法和配置
| | |-- services 对应组件使用的api方法和数据处理方法
| | | |-- instance.js 封装使用的axios请求方法和拦截器
| | | |-- xxx.js 各个组件或者模块页面的api
| | |-- config.js 项目配置生产，开发，测试接口配置
| | |-- index.js services文件的api统一出口，方便模块使用
| | |-- resource.js 全局使用的常量
| |-- assets 放置一些静态资源，例如图片，图标，字体
| |-- conponents 一些公共组件
| |-- config
| |-- layout 项目公共lauout模板
| |-- lib
| |-- plugins
| |-- router vue-router 相关配置
| | |-- index.js 导出路由配置
| | |-- modules 项目模块全部路由
| | |-- error.js 错误页面路由
| | |-- router.js 集合模块路由和错误页面路由导出全部路由
| |-- store vuex相关配置
| | |-- global 全局vuex使用的配置
| | | |-- actions.js 全局vuex actions方法
| | | |-- index.js 导出全局vuex配置
| | | |-- mutations.js 全局vuex mutations方法
| | | |-- state.js 全局vuex state方法
| | |-- modules 模块化的vuex
| | | |-- index.js 将modules下的所有模块导出
| | | |-- xxx.js 组件对应的vuex模块
| | |-- index.js 导出vuex所有配置
| |-- util 封装的工具函数
| |-- views 所有的路由组件
| |-- |-- xxx/xxx 路由对应的文件
| | | |-- Child/xxx 路由对应的子路由文件
| |-- App.vue 路由组件的顶层路由
| |-- main.js vue入口文件
| |-- shims-vue.d.ts 用于解决VScode找不到vue模块的问题
|-- env.xxx 多环境运行配置环境变量文件
|-- .gitignore 配置不提交到git仓库的文件
|-- .eslintrc.js Eslint 配置文件
|-- .eslintignore 配置Eslint不校验的文件
|-- prettier.config.js 配置代码格式化插件统一代码风格
|-- .prettierignore 配置代码格式化不校验的文件
|-- babel.config.js 配置babel文件
|-- commitlint.config.js 配置git提交判断的文件
|-- tsconfig.json 配置ts的文件
|-- jsconfig.json 配置js的文件
|-- vue.config.js || vite.config.ts vue-cli生成的配置文件||vite生成的配置文件
|-- package.json vue项目信息和插件库信息文件
3、初始化完成的项目引入ts
- 安装ts
# npm
npm install typescript
# yarn
yarn add typescript
- 在项目的根目录创建文件：tsconfig.json,具体代码如下:
{
"compilerOptions": {
"target": "esnext",
"module": "esnext",
"strict": true,
"jsx": "preserve",
"importHelpers": true,
"moduleResolution": "node",
"experimentalDecorators": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"sourceMap": true,
"baseUrl": ".",
"resolveJsonModule": true,
"types": [
"webpack-env"
],
"paths": {
"@/*": [
"src/*"
]
},
"lib": [
"esnext",
"dom",
"dom.iterable",
"scripthost"
]
},
"include": [
"src/**/*.ts",
"src/**/*.tsx",
"src/**/*.vue",
"tests/**/*.ts",
"tests/**/*.tsx"
],
"exclude": [
"node_modules"
]
}
- 修改src/main.js为src/main.ts;
- 修改根目录下index.html中引入的main.js为main.ts
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Vite App</title>
</head>
<body>
<div id="app"></div>
<!--<script type="module" src="/src/main.js"></script>-->
<script type="module" src="/src/main.ts"></script>
</body>
</html>
- 在src目录下新建shims-vue.d.ts文件:
// 在没用用到需要具体定义的内容的时候，可以只声明一下'*.vue'就可以
// src/main.d.ts
declare module '*.vue' {
/*
import {ComponentOptions} from 'vue';
const componentOptions: ComponentOptions;
export default componentOptions; */
}
4、项目中加入eslint
1、安装eslint
# npm
npm install eslint elsint-plugin-vue -D
# yarn
yarn add eslint elsint-plugin-vue
2、安装好之后在项目根目录下添加.eslintrc.js文件：
module.exports = {
root: true,
env: {
node: true,
},
extends: [
"plugin:vue/vue3-essential",
"@vue/airbnb",
"@vue/typescript/recommended",
],
parserOptions: {
ecmaVersion: 2020,
},
// "off"或0 -关闭规则
// "warn" 或1 - 开启规则, 使用警告 程序不会退出
// "error"或2 - 开启规则, 使用错误 程序退出
rules: {
"@typescript-eslint/no-explicit-any": 0,
"class-methods-use-this": 0,
"import/prefer-default-export": 0, //当模块中只有一个导出时，最好使用默认导出而不是指定导出
"import/no-extraneous-dependencies": [2, { devDependencies: true }],
"import/no-unresolved": [2, { ignore: ["ant-design-vue"] }],
"no-restricted-syntax": [
"error",
"WithStatement",
"BinaryExpression[operator='in']",
],
"no-alert": 0, //禁止使用alert confirm prompt
"no-array-constructor": 2, //禁止使用数组构造器
"no-bitwise": 0, //禁止使用按位运算符
"no-caller": 1, //禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2, //禁止catch子句参数与外部作用域变量同名
"no-class-assign": 2, //禁止给类赋值
"no-cond-assign": 2, //禁止在条件表达式中使用赋值语句
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off", //禁止使用console
"no-const-assign": 2, //禁止修改const声明的变量
"no-constant-condition": 2, //禁止在条件中使用常量表达式 if(true) if(1)
"no-continue": 0, //禁止使用continue
"no-control-regex": 2, //禁止在正则表达式中使用控制字符
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off", //禁止使用debugger
"no-delete-var": 2, //不能对var声明的变量使用delete操作符
"no-div-regex": 1, //不能使用看起来像除法的正则表达式/=foo/
"no-dupe-keys": 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
"no-dupe-args": 2, //函数参数不能重复
"no-duplicate-case": 2, //switch中的case标签不能重复
"no-else-return": 2, //如果if语句里面有return,后面不能跟else语句
"no-empty": 2, //块语句中的内容不能为空
"no-empty-character-class": 2, //正则表达式中的[]内容不能为空
"no-eq-null": 2, //禁止对null使用==或!=运算符
"no-eval": 1, //禁止使用eval
"no-ex-assign": 2, //禁止给catch语句中的异常参数赋值
"no-extend-native": 2, //禁止扩展native对象
"no-extra-bind": 2, //禁止不必要的函数绑定
"no-extra-boolean-cast": 2, //禁止不必要的bool转换
"no-extra-parens": 2, //禁止非必要的括号
"no-extra-semi": 2, //禁止多余的冒号
"no-fallthrough": 1, //禁止switch穿透
"no-floating-decimal": 2, //禁止省略浮点数中的0 .5 3.
"no-func-assign": 2, //禁止重复的函数声明
"no-implicit-coercion": 1, //禁止隐式转换
"no-implied-eval": 2, //禁止使用隐式eval
"no-inline-comments": 0, //禁止行内备注
"no-inner-declarations": [2, "functions"], //禁止在块语句中使用声明（变量或函数）
"no-invalid-regexp": 2, //禁止无效的正则表达式
"no-invalid-this": 2, //禁止无效的this，只能用在构造器，类，对象字面量
"no-irregular-whitespace": 2, //不能有不规则的空格
"no-iterator": 2, //禁止使用__iterator__ 属性
"no-label-var": 2, //label名不能与var声明的变量名相同
"no-labels": 2, //禁止标签声明
"no-lone-blocks": 2, //禁止不必要的嵌套块
"no-lonely-if": 2, //禁止else语句内只有if语句
"no-loop-func": 1, //禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
"no-mixed-requires": [0, false], //声明时不能混用声明类型
"no-mixed-spaces-and-tabs": [2, false], //禁止混用tab和空格
"linebreak-style": [0, "windows"], //换行风格
"no-multi-spaces": 0, //不能用多余的空格
"no-multi-str": 2, //字符串不能用\换行
"no-multiple-empty-lines": [1, { max: 3 }], //空行最多不能超过2行
"no-native-reassign": 2, //不能重写native对象
"no-negated-in-lhs": 2, //in 操作符的左边不能有!
"no-nested-ternary": 0, //禁止使用嵌套的三目运算
"no-new": 1, //禁止在使用new构造一个实例后不赋值
"no-new-func": 1, //禁止使用new Function
"no-new-object": 2, //禁止使用new Object()
"no-new-require": 2, //禁止使用new require
"no-new-wrappers": 2, //禁止使用new创建包装实例，new String new Boolean new Number
"no-obj-calls": 2, //不能调用内置的全局对象，比如Math() JSON()
"no-octal": 2, //禁止使用八进制数字
"no-octal-escape": 2, //禁止使用八进制转义序列
"no-param-reassign": 2, //禁止给参数重新赋值
"no-path-concat": 0, //node中不能使用__dirname或__filename做路径拼接
"no-plusplus": 0, //禁止使用++，--
"no-process-env": 0, //禁止使用process.env
"no-process-exit": 0, //禁止使用process.exit()
"no-proto": 2, //禁止使用__proto__属性
"no-redeclare": 2, //禁止重复声明变量
"no-regex-spaces": 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
"no-restricted-modules": 0, //如果禁用了指定模块，使用就会报错
"no-return-assign": 1, //return 语句中不能有赋值表达式
"no-script-url": 0, //禁止使用javascript:void(0)
"no-self-compare": 2, //不能比较自身
"no-sequences": 0, //禁止使用逗号运算符
"no-shadow": 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
"no-shadow-restricted-names": 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
"no-spaced-func": 2, //函数调用时 函数名与()之间不能有空格
"no-sparse-arrays": 2, //禁止稀疏数组， [1,,2]
"no-sync": 0, //nodejs 禁止同步方法
"no-ternary": 0, //禁止使用三目运算符
"no-trailing-spaces": 1, //一行结束后面不要有空格
"no-this-before-super": 0, //在调用super()之前不能使用this或super
"no-throw-literal": 2, //禁止抛出字面量错误 throw "error";
"no-undef": 2, //不能有未定义的变量
"no-undef-init": 2, //变量初始化时不能直接给它赋值为undefined
"no-undefined": 2, //不能使用undefined
"no-unexpected-multiline": 2, //避免多行表达式
"no-underscore-dangle": 0, //标识符不能以_开头或结尾
"no-unneeded-ternary": 2, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable": 2, //不能有无法执行的代码
"no-unused-expressions": ["error", { allowTernary: true }], //禁止无用的表达式
"no-unused-vars": [2, { vars: "all", args: "after-used" }], //不能有声明后未被使用的变量或参数
"no-use-before-define": 2, //未定义前不能使用
"no-useless-call": 2, //禁止不必要的call和apply
"no-void": 2, //禁用void操作符
"no-var": 0, //禁用var，用let和const代替
"no-warning-comments": [
1,
{ terms: ["todo", "fixme", "xxx"], location: "start" },
], //不能有警告备注
"no-with": 2, //禁用with
"array-bracket-spacing": [2, "never"], //是否允许非空数组里面有多余的空格
"arrow-parens": 0, //箭头函数用小括号括起来
"arrow-spacing": 0, //=>的前/后括号
"accessor-pairs": 0, //在对象中使用getter/setter
"block-scoped-var": 0, //块语句中使用var
"brace-style": [1, "1tbs"], //大括号风格
"callback-return": 1, //避免多次调用回调什么的
camelcase: 2, //强制驼峰法命名
"comma-dangle": [2, "never"], //对象字面量项尾不能有逗号
"comma-spacing": 0, //逗号前后的空格
"comma-style": [2, "last"], //逗号风格，换行时在行首还是行尾
complexity: [0, 11], //循环复杂度
"computed-property-spacing": [0, "never"], //是否允许计算后的键名什么的
"consistent-return": 0, //return 后面是否允许省略
"consistent-this": [2, "that"], //this别名
"constructor-super": 0, //非派生类不能调用super，派生类必须调用super
curly: [2, "all"], //必须使用 if(){} 中的{}
"default-case": 2, //switch语句最后必须有default
"dot-location": 0, //对象访问符的位置，换行的时候在行首还是行尾
"dot-notation": [0, { allowKeywords: true }], //避免不必要的方括号
"eol-last": 0, //文件以单一的换行符结束
eqeqeq: 0, //必须使用全等
"func-names": 0, //函数表达式必须有名字
"func-style": [0, "declaration"], //函数风格，规定只能使用函数声明/函数表达式
"generator-star-spacing": 0, //生成器函数*的前后空格
"guard-for-in": 0, //for in循环要用if语句过滤
"handle-callback-err": 0, //nodejs 处理错误
"id-length": 0, //变量名长度
indent: 0, //缩进风格
"init-declarations": 0, //声明时必须赋初值
"key-spacing": [0, { beforeColon: false, afterColon: true }], //对象字面量中冒号的前后空格
"lines-around-comment": 0, //行前/行后备注
"max-depth": [0, 4], //嵌套块深度
"max-len": [0, 80, 4], //字符串最大长度
"max-nested-callbacks": [0, 2], //回调嵌套深度
"max-params": [0, 3], //函数最多只能有3个参数
"max-statements": [0, 10], //函数内最多有几个声明
"new-cap": 2, //函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
"new-parens": 2, //new时必须加小括号
"newline-after-var": 2, //变量声明后是否需要空一行
"object-curly-spacing": [0, "never"], //大括号内是否允许不必要的空格
"object-shorthand": 0, //强制对象字面量缩写语法
"one-var": 1, //连续声明
"operator-assignment": [0, "always"], //赋值运算符 += -=什么的
"operator-linebreak": [2, "after"], //换行时运算符在行尾还是行首
"padded-blocks": 0, //块语句内行首行尾是否要空行
"prefer-const": 0, //首选const
"prefer-spread": 0, //首选展开运算
"prefer-reflect": 0, //首选Reflect的方法
quotes: [1, "single"], //引号类型 `` "" ''
"quote-props": ["error", "as-needed"], //对象字面量中的属性名是否强制双引号
"id-match": 0, //命名检测
"require-yield": 0, //生成器函数必须有yield
semi: [2, "always"], //语句强制分号结尾
"semi-spacing": [0, { before: false, after: true }], //分号前后空格
"sort-vars": 0, //变量声明时排序
"space-after-keywords": [0, "always"], //关键字后面是否要空一格
"space-before-blocks": [0, "always"], //不以新行开始的块{前面要不要有空格
"space-before-function-paren": [0, "always"], //函数定义时括号前面要不要有空格
"space-in-parens": [0, "never"], //小括号里面要不要有空格
"space-infix-ops": 0, //中缀操作符周围要不要有空格
"space-unary-ops": [0, { words: true, nonwords: false }], //一元运算符的前/后要不要加空格
"spaced-comment": 0, //注释风格要不要有空格什么的
strict: 2, //使用严格模式
"use-isnan": 2, //禁止比较时使用NaN，只能用isNaN()
"valid-typeof": 2, //必须使用合法的typeof的值
"vars-on-top": 2, //var必须放在作用域顶部
"wrap-iife": [2, "inside"], //立即执行函数表达式的小括号风格
"wrap-regex": 0, //正则表达式字面量用小括号包起来
},
};
