vite + vue3 + typescriptでgithub pagesにサイトを公開しよう #TypeScript

0 環境

Mac OS Catalina
node.js v14.15.1
yarn v1.22.10

1 プロジェクト作成

yarn create @vitejs/app プロジェクト名後にvue-tsを選択
プロジェクトに移動後、yarn install
yarn install vue-router@4
mkdir public/img
mkdir src/views
mkdir src/router
touch src/router/index.ts
touch src/views/Home.vue src/views/About.vue
touch public/.nojekyll
script一部書き換え(dev, buildにモード追加)
(viteはトランスパイルは行うけど、型チェックは行わないようのでtsc --noEmitを追加)

package.json

  ...
  "scripts": {
    "dev": "tsc --noEmit && vite --mode=development",
    "build": "tsc --noEmit && vite build --mode=production",
    "serve": "vite preview"
  },
 ...

ここまででこうなっていたらOK

2 routerの設定

基本的にvue-cliで作るvue3と変わりませんが、createWebHistoryに渡す引数だけwebpackとは別のものになります。

src/router/index.ts

import { createRouter, createWebHistory, RouteRecordRaw } from 'vue-router';
import Home from '../views/Home.vue';
import About from '../views/About.vue';

const routes: Array<RouteRecordRaw> = [
  {
    path: '/',
    name: 'Home',
    component: Home
  },
  {
    path: '/about',
    name: 'About',
    component: About
  }
];

const router = createRouter({
  // viteの環境変数 => (vite.config.tsのbase)
  history: createWebHistory(import.meta.env.BASE_URL),
  routes
});

export default router;

main.tsにrouterを追加します。

src/main.ts

import { createApp } from 'vue';
import App from './App.vue';
// 追加↓
import router from './router';
　　 
// use(router) 追加
createApp(App).use(router).mount('#app');

3 vite.config.ts設定

@/によるimportとbuild時の設定を行います。

※ processで型がないって言われた場合

yarn add @types/node --devをした後、
tsconfig.jsonのtypesに@types/nodeを追加

tsconfig.json

  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "lib": ["esnext", "dom"],
    "types": ["vite/client", "@types/node"]
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
}

vite.config.ts

import path from 'path';
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  // 本番時はgithubリポジトリをルートパスにする
  base: process.env.NODE_ENV === 'production' ? '/vite-sample/' : './',
  resolve: {
    // @/ によるimportをできるようにする。
    alias: {
      '@': path.resolve('__dirname', '/src')
    }
  },
  build: {
    outDir: 'docs'
  },
  plugins: [vue()]
});

4 viewをいじる

<HelloWorld msg="Hello Vue 3 + TypeScript + Vite" />を切り取って代わりに、ルーティング関連のものを入れます。

src/App.vue

<template>
 <img alt="Vue logo" src="./assets/logo.png" />
 <!--追加↓-->
 <div id="nav">
    <router-link to="/">Home</router-link> |
    <router-link to="/about">About</router-link>
 </div>
 <!--ctrl + X↓-->
 <HelloWorld msg="Hello Vue 3 + TypeScript + Vite" />
 <!--追加↓-->
 <router-view />
</template>

<script lang="ts">
import { defineComponent } from 'vue';
// ctrl + X↓
import HelloWorld from './components/HelloWorld.vue';

export default defineComponent({
  name: 'App',
　// ctrl + X↓
  components: {
    HelloWorld
  }
})
</script>

<style>
#app {
  font-family: Avenir, Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}

/* 追加 */
#nav {
  padding: 10px;
}

#nav a {
  font-weight: bold;
  color: #2c3e50;
}

#nav a.router-link-exact-active {
  color: #42b983;
}
</style>

切り取ったものをHome.vueに貼り付け

src/views/Home.vue

<template>
  <!--App.vueのものを貼り付け-->
  <HelloWorld msg="Hello Vue 3 + TypeScript + Vite" />
</template>

<script lang="ts">
import { defineComponent } from 'vue';
// App.vueのものを貼り付け(エリアス効くか試すのもアリ)
import HelloWorld from '@/components/HelloWorld.vue'

export default defineComponent({
  name: 'Home',
  // App.vueのものを貼り付け
  components: {
    HelloWorld
  }
});
</script>

<style scoped></style>

Aboutも最低限わかるようにh1を設定

src/views/About.vue

<template>
  <h1>About</h1>
</template>

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

export default defineComponent({
  name: 'About',
});
</script>

<style scoped></style>

これで下準備は完了です。

5 ローカルで確認

yarn dev後にhttp://localhost:3000を確認してください。

6 デプロイ

yarn build

build後に生成されるフォルダをdocsにしたので、あとはビルド、push後にgithab pagesの設定でdcosを指定することで、反映されます。

お疲れ様でした。

リポジトリ

※以降は通常のvue開発と変わりませんが
requireが、使えないので画像などはpublicに作ったimgフォルダに入れて、staticフォルダのように使う必要がありそうです。(ここら辺は調べ中)

おまけ

https://gist.github.com/taka1156/862cc1860c55d5c00a13efbc0e58fefd
<vue-ts>と入力するとdefineComponentとかが一瞬で出てくるスニペット