Vue3+TS:代碼規(guī)范和三方庫集成

本文整理來自深入Vue3+TypeScript技術(shù)棧-coderwhy大神新課,只作為個人筆記記錄使用,請大家多支持王紅元老師。

一. 代碼規(guī)范

1 - 集成editorconfig配置

.editorconfig文件 有助于為不同 IDE 編輯器上處理同一項目的多個開發(fā)人員維護一致的編碼風(fēng)格。

# Editor configuration, see http://editorconfig.org

# 表示是最頂層的 EditorConfig 配置文件
root = true

[*] # 表示所有文件適用
charset = utf-8 # 設(shè)置文件字符集為 utf-8
indent_style = space # 縮進風(fēng)格(tab | space)
indent_size = 2 # 縮進大小
end_of_line = lf # 控制換行類型(lf | cr | crlf), lf 適配 mac,linix ; cr 適配window;
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始終在文件末尾插入一個新行

[*.md] # 表示僅 md 文件適用以下規(guī)則
max_line_length = off
trim_trailing_whitespace = false

如果想VSCode讀取這個文件,需要安裝一個插件:EditorConfig for VS Code。

2 - 使用prettier工具

Prettier 是一款強大的代碼格式化工具,支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等語言,基本上前端能用到的文件格式它都可以搞定,是當(dāng)下最流行的代碼格式化工具。

如果使用的是VSCode,使用Prettier - Code formatter插件,按command+s保存即可對代碼進行格式化。如果使用的不是VSCode,甚至你想敲一個命令,通過這個命令就能對代碼進行格式化,這時候最好在項目中安裝Prettier的包, 安裝之后,即使不用VSCode也可以對我們的代碼進行格式化的。啥意思呢?也就是Prettier包是針對我們的項目的,插件是針對于VSCode的。

  1. 安裝prettier
npm install prettier -D
  1. 配置.prettierrc文件
{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false
}

useTabs:使用tab縮進還是空格縮進,選擇false,使用空格;
tabWidth:tab是空格的情況下,是幾個空格,選擇2個;
printWidth:一行代碼的長度,推薦80,也有人喜歡100或者120;
singleQuote:使用單引號還是雙引號,選擇true,使用單引號;
trailingComma:在多行輸入的時候尾部是否添加逗號,設(shè)置為 `none`;
semi:語句末尾是否要加分號,默認值true,選擇false表示不加;
  1. 創(chuàng)建.prettierignore忽略文件
/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*
  1. VSCode需要安裝prettier的插件
  1. 測試prettier是否生效

在代碼中command+s保存代碼,測試是否生效。如果我們?nèi)ッ總€文件,然后一個一個command+s會很麻煩,我們可以在package.json中配置一個scripts,如下,這樣我們執(zhí)行npm run prettier命令就可以將項目中所有的文件格式化了。

"prettier": "prettier --write ."

當(dāng)我們使用prettier格式化后的代碼可能和ESLint的規(guī)則有沖突,從而有警告,下面講一下ESLint。

3 - 使用ESLint檢測

ESLint是為了檢查我們的代碼是否規(guī)范。

  1. 在前面創(chuàng)建項目的時候,我們就選擇了ESLint,所以Vue會默認幫助我們配置需要的ESLint環(huán)境,然后自動生成.eslintrc.js文件。

  2. VSCode需要安裝ESLint插件

ESLint插件可以快速對我們的代碼進行檢查,從而報警告。

  1. 解決eslint和prettier沖突的問題

上面的.eslintrc.js文件,核心規(guī)范如下:

extends: [
  "plugin:vue/vue3-essential",   // vue3的規(guī)范
  "eslint:recommended",   // eslint默認推薦的規(guī)范
  "@vue/typescript/recommended",  // 在vue里面使用typescript的規(guī)范
  "@vue/prettier",  // 默認vue里面prettier的規(guī)范
  "@vue/prettier/@typescript-eslint",   // 默認vue里面prettier的typescript的規(guī)范
],

也就是說我們的代碼需要符合上面那些規(guī)范,但是上面那些規(guī)范和.prettierrc里面的東西是沖突的,也就是說我們格式化之后代碼會有警告,那么我們怎么讓它兼容起來呢?

我們需要安裝兩個插件(vue在創(chuàng)建項目時,如果選擇prettier,那么這兩個插件會自動安裝,就不用我們手動安裝了)。

npm i eslint-plugin-prettier eslint-config-prettier -D

這兩個插件就是用來做eslint和prettier兼容的,在extends中添加如下一行代碼,表示用剛才的插件,然后重啟項目,就不會警告了。

extends: [
  ......
  'plugin:prettier/recommended'
],

上面extends的規(guī)則都是繼承,但是規(guī)則有相同的情況下,后面的會把前面的覆蓋掉。

4 - git Husky和eslint

雖然我們已經(jīng)要求項目使用eslint了,但是不能保證組員提交代碼之前都將eslint中的問題解決掉了,也就是我們希望保證代碼倉庫中的代碼都是符合eslint規(guī)范的,那么我們需要在組員執(zhí)行 git commit 命令的時候?qū)ζ溥M行校驗,如果不符合eslint規(guī)范,那么自動通過規(guī)范進行修復(fù)。

那么如何做到這一點呢?可以通過Husky工具,husky是一個git hook工具,可以幫助我們觸發(fā)git提交的各個階段:pre-commit、commit-msg、pre-push。

如何使用husky呢?這里我們可以使用自動配置命令:

npx husky-init && npm install

這個命令其實就是幫我們完成了三個操作:

  1. 安裝husky相關(guān)的依賴
  1. 在項目目錄下創(chuàng)建.husky文件夾
npx huksy install

文件夾下面有個pre-commit文件,如果我們想在commit之前做一些事,可以在這個文件里面寫操作。

  1. 在package.json中添加一個腳本
  1. 接下來,我們需要去完成一個操作:在進行commit時,執(zhí)行l(wèi)int腳本

這個時候我們執(zhí)行g(shù)it commit的時候會自動對代碼進行l(wèi)int校驗。

5 - git commit規(guī)范

1. 代碼提交風(fēng)格

通常我們的git commit會按照統(tǒng)一的風(fēng)格來提交,這樣可以快速定位每次提交的內(nèi)容,方便之后對版本進行控制。

但是如果每次手動來編寫這些是比較麻煩的事情,我們可以使用一個工具:Commitizen,Commitizen 是一個幫助我們編寫規(guī)范 commit message 的工具。

  1. 安裝Commitizen
npm install commitizen -D
  1. 安裝cz-conventional-changelog,并且初始化cz-conventional-changelog
npx commitizen init cz-conventional-changelog --save-dev --save-exact

這個命令會幫助我們安裝cz-conventional-changelog:

并且在package.json中進行配置:

這時候我們提交代碼需要使用npx cz,執(zhí)行之后會出現(xiàn)終端選擇界面:

  1. 第一步是選擇提交的type,本次更新的類型
Type 作用
feat 新增特性 (feature)
fix 修復(fù) Bug(bug fix)
docs 修改文檔 (documentation)
style 代碼格式修改(white-space, formatting, missing semi colons, etc)
refactor 代碼重構(gòu)(refactor)
perf 改善性能(A code change that improves performance)
test 測試(when adding missing tests)
build 變更項目構(gòu)建或外部依賴(例如 scopes: webpack、gulp、npm 等)
ci 更改持續(xù)集成軟件的配置文件和 package 中的 scripts 命令,例如 scopes: Travis, Circle 等
chore 變更構(gòu)建流程或輔助工具(比如更改測試環(huán)境)
revert 代碼回退
  1. 第二步選擇本次修改的范圍(作用域)
  1. 第三步選擇提交的信息
  1. 第四步提交詳細的描述信息
  1. 第五步是否是一次重大的更改
  1. 第六步是否影響某個open issue

如果有組員不喜歡npx cz命令,我們可以在scripts中構(gòu)建一個命令來執(zhí)行cz,如下,我們執(zhí)行npm run commit即可進行提交操作。

2. 代碼提交驗證

如果我們按照cz來規(guī)范了提交風(fēng)格,但是依然有同事通過 git commit 按照不規(guī)范的格式提交應(yīng)該怎么辦呢?我們可以通過commitlint來限制提交。

  1. 安裝 @commitlint/config-conventional 和 @commitlint/cli
npm i @commitlint/config-conventional @commitlint/cli -D
  1. 在根目錄創(chuàng)建commitlint.config.js文件,配置commitlint,代碼如下:
module.exports = {
  extends: ['@commitlint/config-conventional']
}

上面我們講的pre-commit文件是commit之前的攔截文件,我們還需要攔截提交信息的文件,如下:

  1. 使用husky生成commit-msg文件,用來驗證提交信息:
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

這時候我們再使用git commit提交代碼的時候,如果不符合commitlint.config.js規(guī)范,就會報錯。

二. 第三方庫集成

1 - vue.config.js配置

我們都知道vue-cli是基于webpack來配置的,但是有時候我們對于vue-cli的默認配置不是很滿意,這時候我們可以通過修改webpack源碼(不推薦)來達到我們的目的,另外一種方式就是通過vue.config.js來配置,最后vue.config.js的配置會被合并到webpack里面的。如果不知道怎么配置,可以參開官網(wǎng):https://cli.vuejs.org/zh/config/

vue.config.js有三種配置方式:

  • 方式一:直接通過CLI提供給我們的選項來配置
    ① 比如publicPath:配置應(yīng)用程序部署的子目錄(默認是/,相當(dāng)于部署在 https://www.my-app.com/),如果想修改成https://www.my-app.com/why,就配置publicPath:'/why';
    ② 比如outputDir:修改輸出的文件夾,默認是dist文件夾,如果想修改成build文件夾,可以配置outputDir:'./bulid'

  • 方式二:通過configureWebpack修改webpack的配置
    可以是一個對象,直接會被合并;
    可以是一個函數(shù),會接收一個config,可以通過config來修改配置;

  • 方式三:通過chainWebpack修改webpack的配置
    是一個函數(shù),會接收一個基于 webpack-chain 的config對象,可以對配置進行修改;

const path = require('path')

module.exports = {
  // 1.配置方式一: CLI提供的屬性, 名稱不一定相同,但是和webpack里面的配置是對應(yīng)的
  outputDir: './build',
  publicPath: './',
  // 2.配置方式二: 和webpack屬性完全一致, 最后會進行合并
  // 對象方式
  configureWebpack: {
    resolve: {
      alias: {
        // 配置別名  默認情況下@就相當(dāng)于src,所以'@/components'就相當(dāng)于'src/components'
        // 配置別名之后,我們以前寫的import HelloWorld from './components/HelloWorld.vue'就可以寫成
        // import HelloWorld from '@/components/HelloWorld.vue' 甚至更簡,寫成:
        // import HelloWorld from 'components/HelloWorld.vue', 因為我們配置了別名components就相當(dāng)于@/components
        // 也就是'src/components'
        components: '@/components'
      }
    }
  },
  // 函數(shù)方式
  configureWebpack: (config) => {
    config.resolve.alias = {
      // 寫成函數(shù)就是把原來的alias給覆蓋掉,所以我們要重新指定@就是src,其實webpack默認配置@的別名就是這樣配置的
      '@': path.resolve(__dirname, 'src'),
      // 再配置別名
      components: '@/components'
    }
  }
  // 3.配置方式三:
  chainWebpack: (config) => {
    config.resolve.alias
      .set('@', path.resolve(__dirname, 'src'))
      .set('components', '@/components')
  }
}

這三種方式使用哪一種都可以,只要達到修改的目的就行。

2 - vue-router集成

剛開始創(chuàng)建項目的時候我們沒有選擇路由,現(xiàn)在我們手 動集成路由。

  1. 安裝vue-router的最新版本
npm install vue-router@next
  1. 創(chuàng)建router對象

創(chuàng)建router文件夾,router文件夾里面創(chuàng)建index.ts文件,代碼如下:

import { createRouter, createWebHashHistory } from 'vue-router'
// 導(dǎo)入類型注解,添加一個type代表我們導(dǎo)入的東西不是其他,而是一個類型,不加也沒事
import type { RouteRecordRaw } from 'vue-router'

// 使用類型注解,代表數(shù)組里面裝的都是RouteRecordRaw
const routes: RouteRecordRaw[] = [
  {
    path: '/',
    redirect: '/login'
  },
  {
    path: '/login',
    // 路由懶加載
    component: () => import('@/views/login/login.vue')
  },
  {
    path: '/main',
    component: () => import('@/views/main/main.vue')
  }
]

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

export default router
  1. 使用router

在main.ts里面使用router,代碼如下:

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

const app = createApp(App)
app.use(router)
app.mount('#app')
  1. 在App.vue中配置跳轉(zhuǎn)
<template>
  <div id="app">
    <router-link to="/login">登錄</router-link>
    <router-link to="/main">首頁</router-link>
    <router-view></router-view>
  </div>
</template>

3 - vuex集成

  1. 安裝vuex
npm install vuex@next
  1. 創(chuàng)建store對象

創(chuàng)建store文件夾,store文件夾里面創(chuàng)建index.js文件,代碼如下:

import { createStore } from 'vuex'

const store = createStore({
  state: () => {
    return {
      name: 'coderwhy'
    }
  },
  mutations: {},
  getters: {},
  actions: {}
})

export default store
  1. 使用store

在main.ts里面使用store,如下:

createApp(App).use(router).use(store).mount('#app')
  1. 在App.vue中使用
<h2>{{ $store.state.name }}</h2>

其實vuex對于TS的支持相對來說差一點,所以很多人使用第三方庫Pinia,第三方庫會好一點點。

4 - Element-Plus集成

相信很多同學(xué)在Vue2中都使用過Element-UI,Element-Plus是一套為開發(fā)者、設(shè)計師和產(chǎn)品經(jīng)理準(zhǔn)備的基于 Vue 3.0 的桌面端組件庫。它的使用方式和很多其他的組件庫是一樣的,所以學(xué)會Element-Plus,其他類似于VantUI、NaiveUI、ant-design-vue都是差不多的。

安裝element-plus:

npm install element-plus

1 - 全局引入

一種引入element-plus的方式是全局引入,代表的含義是所有的組件和插件都會被自動注冊。

優(yōu)點:集成簡單
缺點:全部會打包

// 1. 引入包
import ElementPlus from 'element-plus'
// 2. 引入樣式
import 'element-plus/lib/theme-chalk/index.css'

import router from './router'
import store from './store'

// 3. 掛載
createApp(App).use(router).use(store).use(ElementPlus).mount('#app')

在App.vue里面直接使用即可:

<el-button type="danger"> 哈哈哈哈  </el-button>

2 - 按需引入

按需引入也就是在開發(fā)中用到某個組件對某個組件進行引入。

優(yōu)點:包會小一些
缺點:集成起來麻煩一些

<template>
  <div id="app">
    <router-link to="/login">登錄</router-link>
    <router-link to="/main">首頁</router-link>
    <router-view></router-view>

    <h2>{{ $store.state.name }}</h2>

    // 使用組件
    <el-button>默認按鈕</el-button>
    <el-button type="primary">主要按鈕</el-button>
    <el-button type="success">成功按鈕</el-button>
    <el-button type="info">信息按鈕</el-button>
    <el-button type="warning">警告按鈕</el-button>
    <el-button type="danger">危險按鈕</el-button>
  </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue'
// 1. 引入組件
import { ElButton } from 'element-plus'

// 2. 注冊組件
export default defineComponent({
  name: 'App',
  components: {
    ElButton
  }
})
</script>

<style lang="less">
</style>

但是我們會發(fā)現(xiàn)是沒有對應(yīng)的樣式的,引入樣式有兩種方式:

  • 全局引用樣式(像之前做的那樣),不推薦,因為一些沒用到的樣式也會被打包進來
  • 局部引用樣式(通過babel的插件)
  1. 安裝babel的插件
npm install babel-plugin-import -D
  1. 配置babel.config.js
module.exports = {
  plugins: [
    [
      'import',
      {
        libraryName: 'element-plus',
        customStyleName: (name) => {
          return `element-plus/lib/theme-chalk/${name}.css`
        }
      }
    ]
  ],
  presets: ['@vue/cli-plugin-babel/preset']
}

這個插件只會在我們用到某個組件的時候同時給我們引用對應(yīng)的css,但是我們的base或者說一些icon圖標(biāo)是不會幫我們引用進去的,所以對于基本的東西,我們可以全局進行引用。

import 'element-plus/lib/theme-chalk/base.css'

但是這里依然有個弊端,這些組件我們在多個頁面或者組件中使用的時候,都需要導(dǎo)入并且在components中進行注冊,所以我們可以使用app.component進行全局注冊。

為了防止main.ts里面代碼太多,這里我們可以封裝一下。我們新建global文件夾,在里面新建register-element.ts文件和index.ts文件。

register-element.ts文件代碼如下:

import { App } from 'vue'
// 導(dǎo)入base
import 'element-plus/lib/theme-chalk/base.css'
import {
  ElButton,
  ElCheckbox,
  ElForm,
  ElFormItem,
  ElInput,
  ElLink,
  ElRadio,
  ElTabPane,
  ElTabs
} from 'element-plus'

const components = [
  ElButton,
  ElForm,
  ElFormItem,
  ElInput,
  ElRadio,
  ElTabs,
  ElTabPane,
  ElCheckbox,
  ElLink
]

export default function (app: App): void {
  for (const component of components) {
    app.component(component.name, component)
  }
}

index.ts文件代碼如下:

import { App } from 'vue'
import registerElement from './register-element'

export function registerApp(app: App): void {
  registerElement(app)
}

main.ts代碼如下:

import { createApp } from 'vue'
import { registerApp } from './global'
import App from './App.vue'

const app = createApp(App)
registerApp(app)
app.mount('#app')

如果我們想通過插件的方式,也就是使用app.use()的方式,那么如何寫代碼呢?
前面我們說過,app.use()如果傳入一個function,那么這個function會有個app參數(shù),如果傳入一個對象,那么默認會執(zhí)行這個對象的install方法,install方法也有一個app參數(shù)。所以,代碼修改如下:

index.ts代碼如下:

import { App } from 'vue'
import registerElement from './register-element'

export function globalRegister(app: App): void {
  // 調(diào)用registerElement, 并把app傳進去
  app.use(registerElement)
}

main.ts代碼如下:

import { createApp } from 'vue'
import { globalRegister } from './global'
import App from './App.vue'

const app = createApp(App)
// 調(diào)用globalRegister,并把app傳進去
app.use(globalRegister)
app.mount('#app')

三. 接口文檔

https://documenter.getpostman.com/view/12387168/TzsfmQvw

baseURL的值:

http://152.136.185.210:5000

設(shè)置全局token的方法:

const res = pm.response.json();
pm.globals.set("token", res.data.token);

接口文檔v2版本:(有部分更新)
https://documenter.getpostman.com/view/12387168/TzzDKb12

四. 其他補充

VSCode配置

{
  "workbench.iconTheme": "vscode-great-icons",
  "editor.fontSize": 17,
  "eslint.migration.2_x": "off",
  "[javascript]": {
    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
  },
  "files.autoSave": "afterDelay",
  "editor.tabSize": 2,
  "terminal.integrated.fontSize": 16,
  "editor.renderWhitespace": "all",
  "editor.quickSuggestions": {
    "strings": true
  },
  "debug.console.fontSize": 15,
  "window.zoomLevel": 1,
  "emmet.includeLanguages": {
    "javascript": "javascriptreact"
  },
  "explorer.confirmDragAndDrop": false,
  "workbench.tree.indent": 16,
  "javascript.updateImportsOnFileMove.enabled": "always",
  "editor.wordWrap": "on",
  "path-intellisense.mappings": {
    "@": "${workspaceRoot}/src"
  },
  "hediet.vscode-drawio.local-storage": "eyIuZHJhd2lvLWNvbmZpZyI6IntcImxhbmd1YWdlXCI6XCJcIixcImN1c3RvbUZvbnRzXCI6W10sXCJsaWJyYXJpZXNcIjpcImdlbmVyYWw7YmFzaWM7YXJyb3dzMjtmbG93Y2hhcnQ7ZXI7c2l0ZW1hcDt1bWw7YnBtbjt3ZWJpY29uc1wiLFwiY3VzdG9tTGlicmFyaWVzXCI6W1wiTC5zY3JhdGNocGFkXCJdLFwicGx1Z2luc1wiOltdLFwicmVjZW50Q29sb3JzXCI6W1wiRkYwMDAwXCIsXCIwMENDNjZcIixcIm5vbmVcIixcIkNDRTVGRlwiLFwiNTI1MjUyXCIsXCJGRjMzMzNcIixcIjMzMzMzM1wiLFwiMzMwMDAwXCIsXCIwMENDQ0NcIixcIkZGNjZCM1wiLFwiRkZGRkZGMDBcIl0sXCJmb3JtYXRXaWR0aFwiOjI0MCxcImNyZWF0ZVRhcmdldFwiOmZhbHNlLFwicGFnZUZvcm1hdFwiOntcInhcIjowLFwieVwiOjAsXCJ3aWR0aFwiOjExNjksXCJoZWlnaHRcIjoxNjU0fSxcInNlYXJjaFwiOnRydWUsXCJzaG93U3RhcnRTY3JlZW5cIjp0cnVlLFwiZ3JpZENvbG9yXCI6XCIjZDBkMGQwXCIsXCJkYXJrR3JpZENvbG9yXCI6XCIjNmU2ZTZlXCIsXCJhdXRvc2F2ZVwiOnRydWUsXCJyZXNpemVJbWFnZXNcIjpudWxsLFwib3BlbkNvdW50ZXJcIjowLFwidmVyc2lvblwiOjE4LFwidW5pdFwiOjEsXCJpc1J1bGVyT25cIjpmYWxzZSxcInVpXCI6XCJcIn0ifQ==",
  "hediet.vscode-drawio.theme": "Kennedy",
  "editor.fontFamily": "Source Code Pro, 'Courier New', monospace",
  "editor.smoothScrolling": true,
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "workbench.colorTheme": "Atom One Dark",
  "vetur.completion.autoImport": false,
  "security.workspace.trust.untrustedFiles": "open",
  "eslint.lintTask.enable": true,
  "eslint.alwaysShowStatus": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

.browserslistrc文件

這個文件是進行瀏覽器適配的。

> 1%   //適配市場份額大于1%的瀏覽器
last 2 versions  //適配主流瀏覽器最新的兩個版本
not dead  //適配沒有死的瀏覽器,如果12個月內(nèi)有更新,那就是沒有死

tsconfig.json文件

如果項目中有使用TS,就會有這個文件,用來做TS相關(guān)的配置。

{
  //編譯選項
  "compilerOptions": {
    // 目標(biāo)代碼(ts -> js(es5/6/7))
    "target": "esnext",
    // 目標(biāo)代碼需要使用的模塊化方案(commonjs require/module.exports/es module import/export)
    // 如果設(shè)置為umd就是支持多種模塊化
    "module": "esnext",
    // 打開一些嚴格的檢查
    "strict": true,
    // 對jsx進行怎么樣的處理 preserve保留,不轉(zhuǎn)換
    "jsx": "preserve",
    // 導(dǎo)入輔助功能
    "importHelpers": true,
    // 按照node的方式去解析模塊 import "/index.node"
    "moduleResolution": "node",
    // 跳過三方庫的類型檢測 (axios -> 類型/ lodash -> @types/lodash / 其他的第三方)
    // import { Person } from 'axios'
    "skipLibCheck": true,
    // es module 和 commonjs能不能混合來使用,下面?zhèn)z屬性一般是一起的
    // export default/module.exports = {}
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    // 要不要生成映射文件(ts -> js)
    "sourceMap": true,
    // 文件路徑在解析時的基本url, 默認是以當(dāng)前文件為準(zhǔn)
    "baseUrl": ".",
    // 指定具體要解析使用的類型
    "types": ["webpack-env"],
    // 路徑解析(類似于webpack alias)
    "paths": {
      "@/*": ["src/*"],
      "components/*": ["src/components/*"]
    },
    // 指定在項目中可以使用哪里庫的類型(Proxy/Window/Document)
    "lib": ["esnext", "dom", "dom.iterable", "scripthost"]
  },
  // 哪些ts代碼需要進行編譯解析
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "tests/**/*.ts",
    "tests/**/*.tsx"
  ],
  // 哪些ts代碼不需要進行編譯解析
  // 比如當(dāng)我們導(dǎo)入axios的時候,其實axios就是在node_modules里面的
  // 如果我們把它排除,就是引入的庫的在node_modules里面的代碼不進行解析,但是我們自己寫的關(guān)于axios的代碼還是會被解析
  "exclude": ["node_modules"]
}

這個文件的配置有個大概的了解就可以,因為最終我們都會通過Babel進行轉(zhuǎn)換的。

shims-vue.d.ts文件

當(dāng)我們加載一些比較特殊的文件,比如.vue文件、.png文件,其實默認TS是不認識這些文件的,就會報錯。但是我們在main.ts里面使用App.vue文件是不會報錯的, 這是因為當(dāng)前項目是通過腳手架創(chuàng)建的,也就是說這些配置默認都給我們配好了,其實這些文件的類型聲明就是在shims-vue.d.ts文件里面。

shims-vue.d.ts文件:

/* eslint-disable */
declare module '*.vue' {
  import type { DefineComponent } from 'vue'
  const component: DefineComponent<{}, {}, any>
  export default component
}

declare let $store: any

defineComponent()的作用

當(dāng)我們在.vue文件中使用TS,代碼如下:

<script lang="ts">
import { defineComponent } from 'vue'

export default defineComponent({
  name: 'App',
  props: {
    name: {
      type: String
    }
  }
})
</script>

和原來相比多了lang="ts",代表我們使用TS編寫代碼,還有多了defineComponent()函數(shù)進行包裹,其實defineComponent的作用就是類型限制和類型推導(dǎo)。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容