【筆記】使用Vite搭建Vue3(TypeScript版本)項(xiàng)目

前提條件:

  1. 已安裝nodejs環(huán)境(Tips:Vite 需要 Node.js 版本 >= 12.0.0)
  2. 已安裝yarn

使用Vite搭建Vue的TypeScript版本的時(shí)候,可以使用Vite自帶的模板預(yù)設(shè)——vue-ts

Tips:在Vue3的單文件組件(SFC)中粱挡,<script>已經(jīng)很好的支持TypeScript,只需要把標(biāo)簽的lang屬性設(shè)置為ts即可(<script lang="ts">...</script>(原文))智听。

1. 搭建Vue3(ts)基礎(chǔ)環(huán)境

執(zhí)行命令行

# npm 6.x
npm init vite@latest PROJECT_NAME --template vue-ts

# npm 7+, 需要額外的雙橫線:
npm init vite@latest PROJECT_NAME -- --template vue-ts

# yarn
yarn create vite PROJECT_NAME --template vue-ts

2. 安裝Vue-Router

執(zhí)行命令行(安裝最新版本):

# npm
npm install vue-router@next
# yarn
yarn add vue-router@next

Tips:

  1. 在Vue3版本下绢片,建議使用Vue-Router4原文)语泽。
  2. 如需要自定義相應(yīng)版本焦履,將@后next改為對(duì)應(yīng)版本號(hào)即可拓劝。

2.1 創(chuàng)建相應(yīng)文件

router.ts

import { createRouter, createWebHistory } from 'vue-router'

export default createRouter({
  history: createWebHistory(),
  routes: [
    {
      path: '/',
      component: () => import('./views/Home.vue')
    },
    // ...其他路由配置
  ]
});

3. 安裝Vuex

執(zhí)行命令行(安裝最新版本):

# npm
npm install vuex@next
# yarn
yarn add vuex@next

Tips:

  1. 在Vue3版本下,需要使用Vuex4才能夠正常使用原文)裁良。
  2. 如需要自定義相應(yīng)版本凿将,將@后next改為對(duì)應(yīng)版本號(hào)即可校套。

3.1 創(chuàng)建相應(yīng)文件:關(guān)于this.$store

Vuex 沒(méi)有為 this.$store 屬性提供開(kāi)箱即用的類(lèi)型聲明价脾。如果你要使用 TypeScript,首先需要聲明自定義的模塊補(bǔ)充(module augmentation)笛匙。

為此侨把,需要在項(xiàng)目文件夾中添加一個(gè)聲明文件來(lái)聲明 Vue 的自定義類(lèi)型 ComponentCustomProperties

vuex.d.ts

// vuex.d.ts
import { ComponentCustomProperties } from 'vue'
import { Store } from 'vuex'

declare module '@vue/runtime-core' {
  // 聲明自己的 store state
  interface State {
    count: number
  }

  // 為 `this.$store` 提供類(lèi)型聲明
  interface ComponentCustomProperties {
    $store: Store<State>
  }
}

當(dāng)使用組合式 API 編寫(xiě) Vue 組件時(shí)妹孙,您可能希望 useStore 返回類(lèi)型化的 store秋柄。為了 useStore 能正確返回類(lèi)型化的 store,必須執(zhí)行以下步驟:

  1. 定義類(lèi)型化的 InjectionKey蠢正。
  2. 將 store 安裝到 Vue 應(yīng)用時(shí)提供類(lèi)型化的 InjectionKey 骇笔。
  3. 將類(lèi)型化的 InjectionKey 傳給 useStore 方法。

store.ts

// store.ts
import { InjectionKey } from 'vue'
import { createStore, useStore as baseUseStore, Store } from 'vuex'

// 為 store state 聲明類(lèi)型
export interface State {
  count: number
}

// 定義 injection key
export const key: InjectionKey<Store<State>> = Symbol()

export const store = createStore<State>({
  state: {
    count: 0
  }
})

// 定義自己的 `useStore` 組合式函數(shù)
export function useStore() {
  return baseUseStore(key)
}

4. main.ts文件配置

main.ts

import { createApp } from 'vue'
import router from './router'
import { store, key } from './store'
import App from './App.vue'

const app = createApp(App)

app.use(router)
app.use(store, key)
app.mount('#app')

5. Vuex和Vue-Router的使用

main.ts已經(jīng)聲明配置過(guò)Vuex和Vue-Router之后,在<script setup lang="ts">或者<script lang="ts">中按需導(dǎo)入storerouter即可使用其屬性和方法笨触。

6. 補(bǔ)充

6.1 Vue-Router路由自動(dòng)處理

參考:https://github.com/pohunchn/vite-ts-quick

router.ts

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

function getRoutes() {
    const { routes } = loadRouters();
    /**
     * routes處理部分
     */
    return routes;
}

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

export default router;

/** 自動(dòng)化處理view目錄下的文件生成為路由 */
function loadRouters() {
    const context = import.meta.globEager("../views/**/*.vue");
    const routes: RouteRecordRaw[] = [];

    Object.keys(context).forEach((key: any) => {
        if (key === "./index.ts") return;
        let name = key.replace(/(\.\.\/views\/|\.vue)/g, '');
        let path = "/" + name.toLowerCase();
        if (name === "Index") path = "/";
        routes.push({
            path: path,
            name: name,
            component: () => import(`../views/${name}.vue`)
        })
    });

    return { context, routes }
}

7. 相關(guān)鏈接

  • 官方相關(guān)ts項(xiàng)目示例:vite-ts-quick - Vue 3 + Vuex + Vue-router + TypeScript Quick Template.
  • 官方相關(guān)項(xiàng)目示例:Awesome Vite.js
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末懦傍,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子芦劣,更是在濱河造成了極大的恐慌粗俱,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,968評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件虚吟,死亡現(xiàn)場(chǎng)離奇詭異寸认,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)串慰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén)偏塞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人邦鲫,你說(shuō)我怎么就攤上這事烛愧。” “怎么了掂碱?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,220評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵怜姿,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我疼燥,道長(zhǎng)沧卢,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,416評(píng)論 1 279
  • 正文 為了忘掉前任醉者,我火速辦了婚禮但狭,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘撬即。我一直安慰自己立磁,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,425評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布剥槐。 她就那樣靜靜地躺著唱歧,像睡著了一般。 火紅的嫁衣襯著肌膚如雪粒竖。 梳的紋絲不亂的頭發(fā)上颅崩,一...
    開(kāi)封第一講書(shū)人閱讀 49,144評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音蕊苗,去河邊找鬼沿后。 笑死,一個(gè)胖子當(dāng)著我的面吹牛朽砰,可吹牛的內(nèi)容都是我干的尖滚。 我是一名探鬼主播喉刘,決...
    沈念sama閱讀 38,432評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼漆弄!你這毒婦竟也來(lái)了饱搏?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,088評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤置逻,失蹤者是張志新(化名)和其女友劉穎推沸,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體券坞,經(jīng)...
    沈念sama閱讀 43,586評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡鬓催,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,028評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了恨锚。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宇驾。...
    茶點(diǎn)故事閱讀 38,137評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖猴伶,靈堂內(nèi)的尸體忽然破棺而出课舍,到底是詐尸還是另有隱情,我是刑警寧澤他挎,帶...
    沈念sama閱讀 33,783評(píng)論 4 324
  • 正文 年R本政府宣布筝尾,位于F島的核電站,受9級(jí)特大地震影響办桨,放射性物質(zhì)發(fā)生泄漏筹淫。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,343評(píng)論 3 307
  • 文/蒙蒙 一呢撞、第九天 我趴在偏房一處隱蔽的房頂上張望损姜。 院中可真熱鬧,春花似錦殊霞、人聲如沸摧阅。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,333評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)棒卷。三九已至,卻和暖如春瘸右,著一層夾襖步出監(jiān)牢的瞬間娇跟,已是汗流浹背岩齿。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,559評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工太颤, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人盹沈。 一個(gè)月前我還...
    沈念sama閱讀 45,595評(píng)論 2 355
  • 正文 我出身青樓龄章,卻偏偏與公主長(zhǎng)得像吃谣,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子做裙,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,901評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容