阅读 2376

vue3+vite+typeScript+eslint创建一个vue3项目

创建项目

// 创建项目命令
# 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
复制代码

tips:使用yarn的时候会报错,不知道为什么,有大佬知道的麻烦告知一下

项目创建完成之后

cd my-project

npm install
npm run dev
复制代码

引入路由

npm i vue-router@4.0.9
复制代码

创建router文件夹,并在文件夹中创建index.ts文件,文件内容如下

import { createRouter, createWebHashHistory, RouteRecordRaw } from "vue-router";

const routes: Array<RouteRecordRaw> = [
    {
        path: "/",
        name: "index",
        component: () => import("../pages/index.vue"),
        children: [
            {
                path: "/demoTable",
                name: "demoTable",
                component: () => import("../pages/demo-table/list.vue")
            }
        ]
    }
]

const router = createRouter({
    history: createWebHashHistory(),
    routes,
})

export default router;
复制代码

在main.ts文件中做修改

import { createApp } from 'vue'
import App from './App.vue'
import router from "./router"

createApp(App)
    .use(router)
    .mount('#app')

复制代码

引用eslint

1.引入eslint及相关的插件
npm i typescript eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin -D
复制代码
  • eslint: ESlint的核心代码
  • @typescript-eslint/parser:ESlint的解析器,用于解析typescript,从而检查和规范typescript代码
  • @typescript-eslint/eslint-plugin:Eslint插件,包含了各类定义好的检测TS代码的规范
2.引入Prettier
npm i prettier eslint-config-prettier eslint-plugin-prettier -D
复制代码
  • prettier:prettier的核心代码
  • eslint-config-prettier:解决ESlint中的样式规范和prettier中样式规范的冲突,以prettier的样式规范为准,使用ESlint中的样式规范自动失效
  • eslint-plugin-prettier:将prettier做为ESlint规范来使用

.eslintrc.js配置

module.exports = {
  // 此项是用来告诉eslint找当前配置文件不能往父级查找
  root: true, 
  // 全局环境
  env: {
      node: true,
  },
  // 指定如何解析语法。可以为空,但若不为空,只能配该值
  parser: 'vue-eslint-parser',
  // 优先级低于parse的语法解析配置
  parserOptions: {
    // 指定ESlint的解析器
    parser: '@typescript-eslint/parser',
    // 允许使用ES语法
    ecmaVersion: 2020,
    // 允许使用import
    sourceType: 'module',
    // 允许解析JSX
    ecmaFeatures: {
      jsx: true,
    },
  },
  extends: [
    'plugin:vue/vue3-essential',
    'plugin:@typescript-eslint/recommended',
    'prettier',
  ],
  rules: {
    'vue/no-multiple-template-root': 'off',
    'array-bracket-spacing': ['error', 'never'], // 是否允许非空数组里面有多余的空格
    'arrow-parens': 'off', // 箭头函数用小括号括起来
    'block-spacing': ['error', 'always'], // =>的前/后括号
    'accessor-pairs': 'off', // 在对象中使用getter/setter
    'block-scoped-var': 'off', // 块语句中使用var
    'brace-style': ['warn', '1tabs'], // 大括号风格
    'callback-return': 'warn', // 避免多次调用回调什么的
    'camelcase': 'error', // 强制驼峰法命名
    'comma-dangle': ['error', 'never'], // 对象字面量项尾不能有逗号
    'comma-spacing': 'off', // 逗号前后的空格
    'comma-style': ['error', 'last'], // 逗号风格,换行时在行首还是行尾
    'complexity': ['off', 11], // 循环复杂度
    'computed-property-spacing': ['off', 'never'], // 是否允许计算后的键名什么的
    'consistent-return': 'off', // return 后面是否允许省略
    'consistent-this': ['error', 'that'], // this别名
    'constructor-super': 'off', // 非派生类不能调用super,派生类必须调用super
    'curly': ['error', 'all'], // 必须使用 if(){} 中的{}
    'default-case': 'error', // switch语句最后必须有default
    'dot-location': 'off', // 对象访问符的位置,换行的时候在行首还是行尾
    'dot-notation': ['off', { 'allowKeywords': true }], // 避免不必要的方括号
    'eol-last': 'off', // 文件以单一的换行符结束
    'eqeqeq': 'error', // 要求使用 === 和 !==
    'func-names': 'off', // 函数表达式必须有名字
    'func-style': ['off', 'declaration'], // 函数风格,规定只能使用函数声明/函数表达式
    'generator-star-spacing': 'off', // 生成器函数*的前后空格
    'guard-for-in': 'off', // for in循环要用if语句过滤
    'handle-callback-err': 'off', // nodejs 处理错误
    'id-length': 'off', // 变量名长度
    'indent': ['error', 4], // 缩进风格
    'init-declarations': 'off', // 声明时必须赋初始值
    'key-spacing': ['off', { 'beforeColon': false, 'afterColon': true }], // 对象字面量中冒号的前后空格
    'lines-around-comment': 'off', // 行前/行后备注
    'max-depth': ['off', 4], // 嵌套块深度
    'max-len': ['off', 80, 4], // 字符串最大长度
    'max-nested-callbacks': ['off', 'error'], // 回调嵌套深度
    'max-params': ['off', 3], // 函数最多只能有3个参数
    'max-statements': ['off', 10], // 函数内最多有几个声明
    'new-cap': 'error', // 函数名首行大写必须使用new方式调用,首行小写必须用不带new方式调用
    'new-parens': 'error', // new时必须加小括号
    'newline-after-var': 'error', // 变量声明后是否需要空一行
    'no-alert': 'off', // 禁止使用alert confirm prompt
    'no-array-constructor': 'error', // 禁止使用数组构造器
    'no-bitwise': 'off', // 禁止使用按位运算符
    'no-caller': 'warn', // 禁止使用arguments.caller或arguments.callee
    'no-catch-shadow': 'error', // 禁止catch子句参数与外部作用域变量同名
    'no-class-assign': 'error', // 禁止给类赋值
    'no-cond-assign': 'error', // 禁止在条件表达式中使用赋值语句
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off', // 是否使用 console
    'no-const-assign': 'error', // 禁止修改const声明的变量
    'no-constant-condition': 'error', // 禁止在条件中使用常量表达式 if(true) if('warn')
    'no-continue': 'off', // 禁止使用continue
    'no-control-regex': 'error', // 禁止在正则表达式中使用控制字符
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off', // 是否使用 debugger
    'no-delete-var': 'error', // 不能对var声明的变量使用delete操作符
    'no-div-regex': 'warn', // 不能使用看起来像除法的正则表达式/=foo/
    'no-dupe-keys': 'error', // 在创建对象字面量时不允许键重复 {a:'warn',a:'warn'}
    'no-dupe-args': 'error', // 函数参数不能重复
    'no-duplicate-case': 'error', // switch中的case标签不能重复
    'no-else-return': 'error', // 如果if语句里面有return,后面不能跟else语句
    'no-empty': 'error', // 块语句中的内容不能为空
    'no-empty-character-class': 'error', // 正则表达式中的[]内容不能为空
    'no-empty-label': 'error', // 禁止使用空label
    'no-eq-null': 'error', // 禁止对null使用==或!=运算符
    'no-eval': 'warn', // 禁止使用eval
    'no-ex-assign': 'error', // 禁止给catch语句中的异常参数赋值
    'no-extend-native': 'error', // 禁止扩展native对象
    'no-extra-bind': 'error', // 禁止不必要的函数绑定
    'no-extra-boolean-cast': 'error', // 禁止不必要的bool转换
    'no-extra-parens': 'error', // 禁止非必要的括号
    'no-extra-semi': 'error', // 禁止多余的冒号
    'no-fallthrough': 'warn', // 禁止switch穿透
    'no-floating-decimal': 'error', // 禁止省略浮点数中的'off' .5 3.
    'no-func-assign': 'error', // 禁止重复的函数声明
    'no-implicit-coercion': 'warn', // 禁止隐式转换
    'no-implied-eval': 'error', // 禁止使用隐式eval
    'no-inline-comments': 'off', // 禁止行内备注
    'no-inner-declarations': ['error', 'functions'], // 禁止在块语句中使用声明(变量或函数)
    'no-invalid-regexp': 'error', // 禁止无效的正则表达式
    'no-invalid-this': 'error', // 禁止无效的this,只能用在构造器,类,对象字面量
    'no-irregular-whitespace': 'error', // 不能有不规则的空格
    'no-iterator': 'error', // 禁止使用__iterator__ 属性
    'no-label-var': 'error', // label名不能与var声明的变量名相同
    'no-labels': 'error', // 禁止标签声明
    'no-lone-blocks': 'error', // 禁止不必要的嵌套块
    'no-lonely-if': 'error', // 禁止else语句内只有if语句
    'no-loop-func': 'warn', // 禁止在循环中使用函数(如果没有引用外部变量不形成闭包就可以)
    'no-mixed-requires': ['off', false], // 声明时不能混用声明类型
    'no-mixed-spaces-and-tabs': ['error', false], // 禁止混用tab和空格
    'linebreak-style': ['off', 'windows'], // 换行风格
    'no-multi-spaces': 'warn', // 不能用多余的空格
    'no-multi-str': 'error', // 字符串不能用\换行
    'no-multiple-empty-lines': ['warn', {'max': 'error'}], // 空行最多不能超过'error'行
    'no-native-reassign': 'error', // 不能重写native对象
    'no-negated-in-lhs': 'error', // in 操作符的左边不能有!
    'no-nested-ternary': 'off', // 禁止使用嵌套的三目运算
    'no-new': 'warn', // 禁止在使用new构造一个实例后不赋值
    'no-new-func': 'warn', // 禁止使用new Function
    'no-new-object': 'error', // 禁止使用new Object()
    'no-new-require': 'error', // 禁止使用new require
    'no-new-wrappers': 'error', // 禁止使用new创建包装实例,new String new Boolean new Number
    'no-obj-calls': 'error', // 不能调用内置的全局对象,比如Math() JSON()
    'no-octal': 'error', // 禁止使用八进制数字
    'no-octal-escape': 'error', // 禁止使用八进制转义序列
    'no-param-reassign': 'error', // 禁止给参数重新赋值
    'no-path-concat': 'off', // node中不能使用__dirname或__filename做路径拼接
    'no-plusplus': 'off', // 禁止使用++,--
    'no-process-env': 'off', // 禁止使用process.env
    'no-process-exit': 'off', // 禁止使用process.exit()
    'no-proto': 'error', // 禁止使用__proto__属性
    'no-redeclare': 'error', // 禁止重复声明变量
    'no-regex-spaces': 'error', // 禁止在正则表达式字面量中使用多个空格 /foo bar/
    'no-restricted-modules': 'off', // 如果禁用了指定模块,使用就会报错
    'no-return-assign': 'warn', // return 语句中不能有赋值表达式
    'no-script-url': 'off', // 禁止使用javascript:void('off')
    'no-self-compare': 'error', // 不能比较自身
    'no-sequences': 'off', // 禁止使用逗号运算符
    'no-shadow': 'error', // 外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
    'no-shadow-restricted-names': 'error', // 严格模式中规定的限制标识符不能作为声明时的变量名使用
    'no-spaced-func': 'error', // 函数调用时 函数名与()之间不能有空格
    'no-sparse-arrays': 'error', // 禁止稀疏数组, ['warn',,'error']
    'no-sync': 'off', // nodejs 禁止同步方法
    'no-ternary': 'off', // 禁止使用三目运算符
    'no-trailing-spaces': 'warn', // 一行结束后面不要有空格
    'no-this-before-super': 'off', // 在调用super()之前不能使用this或super
    'no-throw-literal': 'error', // 禁止抛出字面量错误 throw 'error';
    'no-undef': 'warn', // 不能有未定义的变量
    'no-undef-init': 'error', // 变量初始化时不能直接给它赋值为undefined
    'no-undefined': 'error', // 不能使用undefined
    'no-unexpected-multiline': 'error', // 避免多行表达式
    'no-underscore-dangle': 'warn', // 标识符不能以_开头或结尾
    'no-unneeded-ternary': 'error', // 禁止不必要的嵌套 var isYes = answer === 'warn' ? true : false;
    'no-unreachable': 'error', // 不能有无法执行的代码
    'no-unused-expressions': 'error', // 禁止无用的表达式
    'no-unused-vars': ['error', {'vars': 'all', 'args': 'after-used'}], // 不能有声明后未被使用的变量或参数
    'no-use-before-define': 'error', // 未定义前不能使用
    'no-useless-call': 'error', // 禁止不必要的call和apply
    'no-void': 'error', // 禁用void操作符
    'no-var': 'off', // 禁用var,用let和const代替
    'no-warning-comments': ['warn', { 'terms': ['todo', 'fixme', 'xxx'], 'location': 'start' }], // 不能有警告备注
    'no-with': 'error', // 禁用with
    'object-curly-spacing': ['off', 'never'], // 大括号内是否允许不必要的空格
    'object-shorthand': 'off', // 强制对象字面量缩写语法
    'one-var': 'warn', // 连续声明
    'operator-assignment': ['off', 'always'], // 赋值运算符 += -=什么的
    'operator-linebreak': ['error', 'after'], // 换行时运算符在行尾还是行首
    'padded-blocks': 'off', // 块语句内行首行尾是否要空行
    'prefer-const': 'off', // 首选const
    'prefer-spread': 'off', // 首选展开运算
    'prefer-reflect': 'off', // 首选Reflect的方法
    'quotes': ['warn', 'single'], // 引号类型 `` '' ''
    'quote-props':['error', 'always'], // 对象字面量中的属性名是否强制双引号
    'radix': 'error', // parseInt必须指定第二个参数
    'id-match': 'off', // 命名检测
    'require-yield': 'off', // 生成器函数必须有yield
    'semi': ['error', 'always'], // 语句强制分号结尾
    'semi-spacing': ['off', {'before': false, 'after': true}], // 分号前后空格
    'sort-vars': 'off', // 变量声明时排序
    'space-after-keywords': ['off', 'always'], // 关键字后面是否要空一格
    'space-before-blocks': ['off', 'always'], // 不以新行开始的块{前面要不要有空格
    'space-before-function-paren': ['off', 'always'], // 函数定义时括号前面要不要有空格
    'space-in-parens': ['off', 'never'], // 小括号里面要不要有空格
    'space-infix-ops': 'off', // 中缀操作符周围要不要有空格
    'space-return-throw-case': 'error', // return throw case后面要不要加空格
    'space-unary-ops': ['off', { 'words': true, 'nonwords': false }], // 一元运算符的前/后要不要加空格
    'spaced-comment': 'off', // 注释风格要不要有空格什么的
    'strict': 'error', // 使用严格模式
    'use-isnan': 'error', // 禁止比较时使用NaN,只能用isNaN()
    'valid-jsdoc': 'off', // jsdoc规则
    'valid-typeof': 'error', // 必须使用合法的typeof的值
    'vars-on-top': 'error', // var必须放在作用域顶部
    'vue/require-v-for-key': 'off', // vue的for循环是否必须有key
    'wrap-iife': ['error', 'inside'], // 立即执行函数表达式的小括号风格
    'wrap-regex': 'off', // 正则表达式字面量用小括号包起来
    'yoda': ['error', 'never'] // 禁止尤达条件
  },
};
复制代码
npm指令
"script": {
    "lint": "vue-cli-service lint"
}
复制代码

运行项目格式化一次,打包项目前也格式化一次。保存最后的代码都被格式化过

.prettierrc配置

{
  "printWidth": 80, // 单行输出(不折行)的(最大)长度
  "useTabs": false, // 不使用缩进符,而使用空格
  "tabWidth": 2, // 每个缩进的空格数
  "tabs": false, // 使用制表符 (tab) 缩进行而不是空格 (space)
  "semi": true, // 是否在语句末尾打印分号
  "singleQuote": true, // 是否使用单引号
  // "quoteProps": "as-needed", // 尽在需要时在对象属性周围添加引号
  "quoteProps": "consistent",
  "trailingComma": "all", // 去除对象最末尾元素跟随的逗号
  "arrowParens": "always", // 箭头函数,只有一个参数的时候,也需要括号
  "rangeStart": 0, // 每个文件格式化的范围是文件的全部内容
  "proseWrap": "always", // 当超出print width(上面有这个参数)时就折行
  "endOfLine": "lf", // 换行符使用 lf
  "bracketSpacing": true, // 是否在对象属性添加空格
  "jsxBracketSameLine": true, // 将 > 多行 JSX 元素放在最后一行的末尾,而不是单独放在下一行(不适用于自闭元素),默认false,这里选择>不另起一行
  "htmlWhitespaceSensitivity": "ignore", // 指定 HTML 文件的全局空白区域敏感度, "ignore" - 空格被认为是不敏感的
  "jsxSingleQuote": false, // jsx 不使用单引号,而使用双引号
  "rangeStart": 0, // 每个文件格式化的范围是文件的全部内容
}
复制代码

引入TS

npm install typescript
复制代码

配置tsconfig.json文件

{
    "compilerOptions": {
        // 允许从没有设置默认导出的模块中默认导入。这并不影响代码的输出,仅为了类型检查。
        "allowSyntheticDefaultImports": true,
        // 从 tslib 导入辅助工具函数(比如 __extends, __rest等)
        "importHelpers": true,
        "target": "esnext",
        // 指定生成哪个模块系统代码
        "module": "esnext",
        // 决定如何处理模块
        "moduleResolution": "node",
        // 指定ECMAScript目标版本
        "strict": true,
        "jsx": "preserve",
        // 生成相应的 .map文件。
        "sourceMap": true,
        // 忽略所有的声明文件( *.d.ts)的类型检查。
        "skipLibCheck": true,
        "resolveJsonModule": true,
        "esModuleInterop": true,
        // 编译过程中需要引入的库文件的列表。
        "lib": ["esnext", "dom"],
        // 解析非相对模块名的基准目录
        "baseUrl": ".",
        // 模块名到基于 baseUrl的路径映射的列表。
        "paths": {
            "@/*": ["src/*"],
            "#/*": ["types/*"]
        },
        // 要包含的类型声明文件名列表
        "types": [
            // "node",
            "vite/client"
        ],
        "typeRoots": ["./node_modules/@types/", "./types"]
    },
    "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
}
复制代码

main.js修改为main.ts

引入element(vite)

npm install vite-plugin-style-import -D
复制代码

按照官网修改配置

问题记录

1.main.ts 中,提示import App from './App.vue'处,找不到 App.vue 这个模块 解决方案: 1、将 shims-vue.d.ts 文件一分为二

2、在 shims-vue.d.ts 文件同级目录下新建 vue.d.ts(名字不一定叫 vue,如 xxx.d.ts 也可以),然后此文件包含代码如下

// vue.d.ts
declare module '*.vue' {
  import Vue from 'vue'
  export default Vue
}
复制代码
// shims-vue.d.ts
import Vue from 'vue'
import VueRouter, { Route } from 'vue-router'
import { Store } from 'vuex'

declare module 'vue/types/vue' {
  interface Vue {
    $router: VueRouter;
    $route: Route;
    $store: Store<any>;
    // 以下是在main.ts中挂载到Vue.prototype上的变量
    $api: any;
    $mock: any;
    $configs: any;
  }
}
复制代码

资料参考:

blog.csdn.net/fu983531588… juejin.cn/post/684490…

文章分类
前端
文章标签