TypeScript サポート

静的型付けは、とりわけアプリケーションが大きく成長したするにつれて、多くの潜在的なランタイムエラーを防ぐのに役立ちます。

それこそが Nuxt の新しい @nuxt/typescript パッケージがビルトインで TypeScript ツールをサポートする理由です:

  • Nuxt 公式の型定義
  • IDE でのオートコンプリート
  • すべてを TypeScript で記述できること(layouts, pages, components, plugins, store
  • ランタイム TS サポート(nuxt.config.ts, modules, serverMiddlewares
  • TSX サポート

はじめる

プロジェクトで TypeScript を利用するためには @nuxt/typescript をインストールする必要があります。

npm i -D @nuxt/typescript
npm i ts-node
# または
yarn add -D @nuxt/typescript
yarn add ts-node

@nuxt/typescript は TypeScript ファイルのコンパイルと型チェックを別のプロセスで行うのに必要な TypeScript 関連の依存関係を持っています。

ts-nodenuxt.config.tsserverMiddlewares をサポートする TypeScript ランタイムを有効化するため Nuxt のコアを拡張します。

また、コードエディタかコマンドラインを使って、プロジェクトのルートフォルダに空の tsconfig.json ファイルを作成する必要があります:

touch tsconfig.json

情報: tsconfig.jsonnuxt コマンドを初回実行時に自動的にデフォルト値で更新されます。

JavaScript から TypeScript へ

設定ファイル

設定ファイル内で TypeScript と使えるようにするために必要なことは nuxt.config.js ファイルを nuxt.config.ts へリネームするだけです。

Nuxt.js はオートコンプリートと型チェックを行うための型定義を提供します:

import NuxtConfiguration from '@nuxt/config'

const config: NuxtConfiguration = {
  // タイプするか `Ctrl + Space` を押すとオートコンプリートできます
}

export default config

コンポーネント

コンポーネントのために vue-property-decorator を利用することを強くお薦めします。なおこれは vue-class-component に依存しています。

下記は Nuxt の asyncData で取得したデータを表示するための、再利用可能な componentpage を組み合わせた基本的な例です。

/* models/Post.ts */
export default interface Post {
  id: number
  title: string
  description: string
}
<!-- components/PostPreview.vue -->
<template>
  <div>
    <h2>{{ post.title }}</h2>
    <p>{{ post.description }}</p>
  </div>
</template>

<script lang="ts">
import { Component, Vue, Prop } from 'vue-property-decorator'
import Post from '~/models/Post'

@Component
export default class PostPreview extends Vue {
  @Prop({ type: Object, required: true }) post!: Post
}
</script>
<!-- pages/feed.vue -->
<template>
  <div>
    <PostPreview v-for="post in posts" :key="post.id" :post="post" />
  </div>
</template>

<script lang="ts">
import axios from 'axios'
import { Component, Vue } from 'vue-property-decorator'
import Post from '~/models/Post'

@Component({
  components: {
    PostPreview: () => import('~/components/PostPreview.vue')
  },
  async asyncData () {
    let { data } = await axios.get(`https://my-api/posts`)
    return {
      posts: data
    }
  }
})
export default class FeedPage extends Vue {
  posts: Post[] = []
}
</script>

同様のロジックを layouts でも使うことができます。

ESLint を使った Linting

プロジェクトを Lint するために ESLint を使っているのであれば、下記のように ESLint で TypeScript ファイルを Lint できます。

重要: 既に nuxt/eslint-config を設定しているという想定です。

まず、typescript-eslint プラグインをインストールする必要があります。

npm install -D @typescript-eslint/eslint-plugin
# または
yarn add -D @typescript-eslint/eslint-plugin

それから ESLint の設定(.eslintrc.js)において、@typescript-eslint プラグインを追加し、@typescript-eslint/parser をデフォルトパーサーに指定するよう編集します。

最小限の設定は下記のようになります:

module.exports = {
  plugins: ['@typescript-eslint'],
  parserOptions: {
    parser: '@typescript-eslint/parser'
  },
  extends: [
    '@nuxtjs'
  ],
  rules: {
    '@typescript-eslint/no-unused-vars': 'error'
  }
}

最後に package.json 内に lint スクリプトを追加または編集します。

"lint": "eslint --ext .ts,.js,.vue --ignore-path .gitignore ."

--ignore-path オプションを使って、node_modules.nuxt あるいは Lint したくないどんなファイルもしくはディレクトリも ESLint の Lint 対象から除外できます。

これで npm run lint(または yarn lint)を実行することで TypeScript を Lint できるようになりました。

間違いを見つけた、またはドキュメントに貢献したいですか? GitHub でこのページを編集する