Zenn
🌟

tsconfig.jsonのtarget

2024/03/27に公開
Next.js
TypeScript
tech

まとめ

概要
TypeScript はトランスパイルされ JavaScript に変換されます。target の値を設定することで、どのバージョンの JavaScript に変換するかを指定できます。例えば利用者が古いバージョンのブラウザを使っている場合は、古いバージョンのブラウザで実行可能な JavaScript を指定します。

Next.js
create next-app で作成した Next.js プロジェクトには target が記載されていません。よって、デフォルト値である ES3 が指定されていると考えられます。Next.js では Babel/SWC が TypeScript からの JavaScript へトランスパイルします。Next.js が公式でサポートしているブラウザはこちらのとおりです。モダンブラウザのみ Babel/SWC がサポートしていると考えられます。Next.js の単体での利用の観点では target の設定は不要です。

Next.js とは関係なく、外部のパッケージを利用する際にず target の値によって動作しないケースがあります（例：Drizzle）。利用するパッケージを鑑みて適切に設定するのが良いです。1 つの指標として対象とする Node のバージョンを確認し、TypeScript が推奨している target の値を指定するのが良いでしょう。

https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
  },
}

補足
公式の説明はこちらです。

https://www.typescriptlang.org/ja/tsconfig#target

以下が作業リポジトリです。

https://github.com/hayato94087/tsconfig-target

https://github.com/hayato94087/next-tsconfig-target

この記事の内容
この記事では target の値を指定し動作を確認します。Node.js & TypeScript のプロジェクトと Next.js のプロジェクトで動作確認を行います。

Node.js & TypeScriptのプロジェクトで動作確認

TypeScript の簡易プロジェクトを作成し、アロー関数をサポートしている es2015 と、サポートしていない es5 を target で指定した場合のトランスパイルの違いについて確認します。

例えば、"target": "es2015" を指定した場合、ES2015 はアロー関数 () => {} が使えるためトランスパイルされた結果もアロー関数の記述はそのまま残ります。ES2015 より以前の ES5 ではアロー関数はサポートされていないためアロー関数 () => {} は ES5 でも動作できる function() {} に変換されます。

target が es5 の場合

ES5 ではアロー関数はサポートされていません。TypeScript で記述されたアロー関数 () => {} は ES5 でも動作できる function() {} に変換されます。

TypeScript の簡易プロジェクトを作成し動作確認をします。

まず、package.json を作成します。

$ mkdir -p tsconfig-target
$ cd tsconfig-target
$ pnpm init

下記で package.json を上書きします。ポイントは scripts に 3 つのスクリプトを追加しています。typecheck で型をチェックし、dev でローカルで動作確認、build でトランスパイルします。

package.json
{
  "name": "tsconfig-sample",
  "version": "1.0.0",
  "description": "",
  "main": "index.ts",
  "scripts": {
    "typecheck": "tsc --noEmit",
    "dev": "ts-node index.ts",
    "timecheck": "tsc --noEmit --extendedDiagnostics",
    "build": "tsc"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

TypeScript をインストールします。

$ pnpm install -D typescript ts-node

tsconfig.json を作成します。

$ npx tsc --init

tsconfig.json を作成します。target は es2015 を指定しています。

tsconfig.json
{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./dist",
    "strict": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
  },
  "include": ["**/*.ts"],
  "exclude": ["node_modules", "dist"]
}

git を初期化します。

$ git init

.gitignore を作成します。

$ touch .gitignore

git の管理対象外にするファイルを追加します。

.gitignore
node_modules

アロー関数を含む簡易コードを作成します。

$ touch index.ts
index.ts
const message = () => {
    console.log("hello world");
}

message();

型をチェックします。特に問題ありません。

$ pnpm run typecheck

ローカルで動作確認します。

$ pnpm run dev

hello world

トランスパイルすると、index.js が作成されます。

$ pnpm run build

トランスパイルした結果はこちらです。

$ tree dist

dist
├── index.js
└── index.js.map

トランスパイルされた index.js を確認します。ES5 はアロー関数 () => {} をサポートしていません。TypeScript で記述されたアロー関数 () => {} は ES5 でも動作できる function() {} に変換されます。

dist/index.js
"use strict";
var message = function () {
    console.log("hello world");
};
message();
//# sourceMappingURL=index.js.map

コミットします。

$ git add .
$ git commit -m "feat: es5を指定"

target が es2015 の場合

ES2015 はアロー関数をサポートしています。target が es2015 の場合、TypeScript で記述されたアロー関数 () => {} はそのままトランスパイルされます。

tsconfig.json
{
  "compilerOptions": {
-   "target": "es5",
+   "target": "es2015",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./dist",
    "strict": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
  },
  "include": ["**/*.ts"],
  "exclude": ["node_modules", "dist"]
}

型をチェックします。特に問題ありません。

$ pnpm run typecheck

ローカルで動作確認します。

$ pnpm run dev

hello world

トランスパイルした結果を確認します。

$ pnpm run build

トランスパイルされた index.js を確認します。es2015 はアロー関数をサポートしているため、index.js はアロー関数のままです。

dist/index.js
"use strict";
-const message = () => {
+var message = function () {  
    console.log("hello world");
};
message();
//# sourceMappingURL=index.js.map

コミットします。

$ git add .
$ git commit -m "feat: es2015を指定"

Next.jsのプロジェクトで動作確認

Next.js は、Babel/SWC を使っており、TypeScript からの JavaScript へのトランスパイルは Babel/SWC が実施します。Next.js が公式でサポートしているブラウザはこちらのとおりです。モダンブラウザのみ Babel/SWC がサポートしていると考えられます。

ここでは Next.js のプロジェクトにて、target を指定せず動作するか確認します。

動作を作業するための Next.js プロジェクトを作成します。長いので、折り畳んでおきます。

新規プロジェクト作成と初期環境構築の手順詳細

プロジェクトを作成

create next-app@latestでプロジェクトを作成します。

$ pnpm create next-app@latest next-tsconfig-target --typescript --eslint --import-alias "@/*" --src-dir --use-pnpm --tailwind --app
$ cd next-tsconfig-target
Peer Dependenciesの警告を解消

Peer dependenciesの警告が出ている場合は、pnpm installを実行し、警告を解消します。

 WARN  Issues with peer dependencies found
.
├─┬ autoprefixer 10.0.1
│ └── ✕ unmet peer postcss@^8.1.0: found 8.0.0
├─┬ tailwindcss 3.3.0
│ ├── ✕ unmet peer postcss@^8.0.9: found 8.0.0
│ ├─┬ postcss-js 4.0.1
│ │ └── ✕ unmet peer postcss@^8.4.21: found 8.0.0
│ ├─┬ postcss-load-config 3.1.4
│ │ └── ✕ unmet peer postcss@>=8.0.9: found 8.0.0
│ └─┬ postcss-nested 6.0.0
│   └── ✕ unmet peer postcss@^8.2.14: found 8.0.0
└─┬ next 14.0.4
  ├── ✕ unmet peer react@^18.2.0: found 18.0.0
  └── ✕ unmet peer react-dom@^18.2.0: found 18.0.0

以下を実行することで警告が解消されます。

$ pnpm i -D postcss@latest react@^18.2.0 react-dom@^18.2.0

不要な設定を削除し、プロジェクトを初期化します。

styles

CSSなどを管理するstylesディレクトリを作成します。globals.cssを移動します。

$ mkdir -p src/styles
$ mv src/app/globals.css src/styles/globals.css

globals.cssの内容を以下のように上書きします。

src/styles/globals.css
@tailwind base;
@tailwind components;
@tailwind utilities;
初期ページ

app/page.tsxを上書きします。

src/app/page.tsx
import { type FC } from "react";

const Home: FC = () => {
  return (
    <div className="">
      <div className="text-lg font-bold">Home</div>
      <div>
        <span className="text-blue-500">Hello</span>
        <span className="text-red-500">World</span>
      </div>
    </div>
  );
};

export default Home;
レイアウト

app/layout.tsxを上書きします。

src/app/layout.tsx
import "@/styles/globals.css";
import { type FC } from "react";
type RootLayoutProps = {
  children: React.ReactNode;
};

export const metadata = {
  title: "Sample",
  description: "Generated by create next app",
};

const RootLayout: FC<RootLayoutProps> = (props) => {
  return (
    <html lang="ja">
      <body className="">{props.children}</body>
    </html>
  );
};

export default RootLayout;
TailwindCSSの設定

TailwindCSSの設定（tailwind.config.ts）を上書きします。

tailwind.config.ts
import type { Config } from 'tailwindcss'

const config: Config = {
  content: [
    './src/pages/**/*.{js,ts,jsx,tsx,mdx}',
    './src/components/**/*.{js,ts,jsx,tsx,mdx}',
    './src/app/**/*.{js,ts,jsx,tsx,mdx}',
  ],
  plugins: [],
}
export default config
スクリプトを追加

型チェックのスクリプトを追加します。

package.json
{
  "name": "next-tsconfig-strict",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint",
+   "typecheck": "tsc --noEmit",
+   "timecheck": "tsc --noEmit --extendedDiagnostics"
  },
  "dependencies": {
    "next": "14.1.4"
  },
  "devDependencies": {
    "@types/node": "^20",
    "@types/react": "^18",
    "@types/react-dom": "^18",
    "autoprefixer": "^10.0.1",
    "eslint": "^8",
    "eslint-config-next": "14.1.4",
    "postcss": "^8.4.37",
    "react": "^18.2.0",
    "react-dom": "^18.2.0",
    "tailwindcss": "^3.3.0",
    "typescript": "^5"
  }
}
動作確認

ローカルで動作確認します。

$ pnpm run dev

コミットして作業結果を保存しておきます。

$ git add .
$ git commit -m "feat:新規にプロジェクトを作成し, 作業環境を構築"

以下が create-next-app@latest で作成された tsconfig.json です。

tsconfig.json
{
  "compilerOptions": {
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": true,
    "noEmit": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "bundler",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "preserve",
    "incremental": true,
    "plugins": [
      {
        "name": "next"
      }
    ],
    "paths": {
      "@/*": ["./src/*"]
    }
  },
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
  "exclude": ["node_modules"]
}

型をチェックします。特に問題はありません。

$ pnpm run typecheck

開発環境で動作確認します。問題なく動作します。

$ pnpm run dev

ビルドします。特に問題はありません。

$ pnpm run build

この観点から、target を指定せずに動作することが確認できました。

$ git add .
$ git commit -m "feat: targetを指定せずに動作することを確認"

Next.jsの設定考察

create next-app で作成した Next.js プロジェクトには target が記載されていません。よって、デフォルト値である ES3 が指定されていると考えられます。Next.js では、Babel/SWC が TypeScript からの JavaScript へのトランスパイルを実施します。Next.js が公式でサポートしているブラウザはこちらのとおりです。モダンブラウザのみ Babel/SWC がサポートしていると考えられます。Next.js の利用の観点では target の設定は不要です。

Next.js とは関係なく、外部のパッケージを利用する際にず target の値によって動作しないケースがあります（例：Drizzle）。利用するパッケージを鑑みて適切に設定するのが良いです。1 つの指標として対象とする Node のバージョンを確認し、TypeScript が推奨している target の値を指定するのが良いでしょう。

https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
  },
}

さいごに

target の値を指定し動作を確認しました。Node.js & TypeScript のプロジェクトと Next.js のプロジェクトで動作確認を行いました。Next.js は、Babel/SWC が TypeScript からの JavaScript へのトランスパイルを実施します。Next.js が公式でサポートしているブラウザはこちらのとおりです。モダンブラウザのみ Babel/SWC がサポートしていると考えられます。Next.js の利用の観点では target の設定は不要です。

一方で、外部のパッケージを利用する際にず target の値によって動作しないケースがあります。利用するパッケージを鑑みて適切に設定するのが良いです。1 つの指標として対象とする Node のバージョンを確認し、TypeScript が推奨している target の値を指定するのが良いでしょう。

https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping

Discussion