Zenn
🐳

tsconfig.json の exclude

2024/04/08に公開
Next.js
TypeScript
tech

概要

exclude は TypeScript のコンパイル対象から除外するファイルを指定します。tsconfig.json ファイルを含んでいるディレクトリからの相対パスとして指定します。exclude は include の結果に対して適用されます。

exclude は正規表現を利用してファイルを指定できます。正規表現は以下のようなものを指します。

  • * ゼロ個以上の文字列にマッチ（ディレクトリセパレータは除く）
  • ? 任意の 1 文字にマッチ（ディレクトリセパレータは除く）
  • ** 任意階層の任意ディレクトリにマッチ

簡易例

こちらは exclude を利用し include されたファイルから node_modules ディレクトリを除外する例です。

tsconfig.json
{
  "include": [
    "**/*.ts",
    "**/*.tsx",
    "**/*.cjs",
    "**/*.mjs",
  ],
  "exclude": ["node_modules"]
}

Next.js の設定考察

create next-app で作成した Next.js プロジェクトで exclude が設定されています。必要に応じて変更しましょう。

こちらの例では、2 つのディレクトリを TypeScript のコンパイル対象から除外しています。

パス 説明
node_modules プロジェクトの依存関係がインストールされているディレクトリ
outDir TypeScript のコンパイル結果が出力されるディレクトリ
tsconfig.json
{
  "compilerOptions": {
    "outDir": "./dist",
  },
  "include": [
    "**/*.ts",
    "**/*.tsx",
    "**/*.cjs",
    "**/*.js",
  ],
  "exclude": ["node_modules", "dist"]
}

参考

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

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

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

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

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

この記事の内容

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

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

TypeScript の簡易プロジェクトを作成します。exclude の値を変更しコンパイル範囲外のファイルが型チェックされるか、コンパイル範囲内のファイルが型チェックされるかを確認します。

事前環境の構築

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

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

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

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

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

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

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

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

$ pnpm install -D typescript ts-node

tsconfig.json を作成します。

$ npx tsc --init

tsconfig.json を作成します。

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

git を初期化します。

$ git init

.gitignore を作成します。

$ touch .gitignore
.gitignore
node_modules

コミットします。

$ git add .
$ git commit -m "feat:初期コミット"

exclude に解析対象から除外するファイルを指定する

exclude の値を変更し、範囲外のファイルが型チェックされないことを確認します。

まずコードを作成します。exclude の動作確認するために divide と multiply 関数を作成します。見て分かる通り、num2 の型は本来 number とすべきですが string になっています。

$ mkdir -p lib/
$ touch lib/multiply.ts
$ touch lib/divide.ts
lib/mutiply.ts
export const mutiply = (num1:number, num2:string) => {
  return num1*num2
}
lib/divide.ts
export const divide = (num1:number, num2:string) => {
  return num1/num2
}

exclude を更新します。lib/multiply.ts と lib/divide.ts を型チェック対象外とします。

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

型チェックします。コンパイル対象のファイルが何もためその趣旨のエラーが出ます。が、lib/multiply.ts と lib/divide.ts はコンパイル対象外のため、そのファイルに関するエラーは出ません。

$ pnpm run typecheck

error TS18003: No inputs were found in config file '/Users/hayato94087/Private/tsconfig-exclude/tsconfig.json'. Specified 'include' paths were '["**/*.ts","**/*.js"]' and 'exclude' paths were '["node_modules","dist","lib/multiply.ts","lib/divide.ts"]'.

Found 1 error.

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しエラーを含むファイルを型チェック対象外にする"

exclude に解析対象から除外するファイルを指定しない

exclude の値を変更し、lib/divide.ts と lib/multiply.ts を型チェック対象とします。

exclude の値を更新し、lib/divide.ts をコンパイル対象とします。

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

型チェックします。lib/divide.ts はコンパイル対象のため、型エラーが出ます。lib/multiply.ts はコンパイル対象外のため、そのファイルに関するエラーは出ません。

$ pnpm run typecheck

lib/divide.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1/num2
                ~~~~

Found 1 error in lib/divide.ts:2

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しlib/divide.tsを型チェック対象にする"

exclude の値を更新し、lib/multiply.ts をコンパイル対象とします。

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

型チェックします。lib/multiply.ts と lib/divide.ts はコンパイル対象のため、型エラーが出ます。

$ pnpm run typecheck

lib/divide.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1/num2
                ~~~~

lib/multiply.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1*num2
                ~~~~

Found 2 errors in 2 files.

Errors  Files
     1  lib/divide.ts:2
     1  lib/multiply.ts:2

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しlib/multiply.tsを型チェック対象にする"

型エラーを修正します。

lib/divide.ts
-export const divide = (num1:number, num2:string) => {
+export const divide = (num1:number, num2:number) => {
  return num1/num2
}
lib/multiply.ts
-export const mutiply = (num1:number, num2:string) => {
+export const mutiply = (num1:number, num2:number) => {
  return num1*num2
}

型チェックします。エラーは出ません。

$ pnpm run typecheck

コミットします。

$ git add .
$ git commit -m "feat: 型エラーを修正"

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

Next.js のプロジェクトを作成し、exclude の値を指定し動作確認します。

事前環境の構築

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

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

プロジェクトを作成

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

$ pnpm create next-app@latest next-tsconfig-exclude --typescript --eslint --import-alias "@/*" --src-dir --use-pnpm --tailwind --app
$ cd next-tsconfig-exclude

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

TypeScriptの設定

TypeScriptの初期設定はこちらです。

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"]
}

スクリプトを追加

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

package.json
{
  "name": "next-tsconfig-include",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint",
+   "typecheck": "tsc"
  },
  "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.38",
    "react": "^18.2.0",
    "react-dom": "^18.2.0",
    "tailwindcss": "^3.3.0",
    "typescript": "^5"
  }
}

動作確認

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

$ pnpm run dev

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

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

exclude に解析対象から除外するファイルを指定する

exclude の値を変更し範囲外のファイルが型チェックされないことを確認します。

まずコードを作成します。exclude の動作確認するために divide と multiply 関数を作成します。見て分かる通り、num2 の型は本来 number とすべきですが string になっています。

$ mkdir -p src/lib/
$ touch src/lib/multiply.ts
$ touch src/lib/divide.ts
src/lib/mutiply.ts
export const mutiply = (num1:number, num2:string) => {
  return num1*num2
}
src/lib/divide.ts
export const divide = (num1:number, num2:string) => {
  return num1/num2
}

exclude を更新します。src/lib/multiply.ts と src/lib/divide.ts を型チェック対象外とします。

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"]
+ "exclude": ["node_modules", "src/lib/multiply.ts", "src/lib/divide.ts"]
}

型チェックします。src/lib/multiply.ts と src/lib/divide.ts はコンパイル対象外のため、エラーは出ません。

$ pnpm run typecheck

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しエラーを含むファイルを型チェック対象外にする"

exclude に解析対象から除外するファイルを指定しない

exclude の値を変更し、src/lib/divide.ts と src/lib/multiply.ts を型チェック対象とします。

exclude の値を更新し、src/lib/divide.ts をコンパイル対象とします。

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", "src/lib/multiply.ts", "src/lib/divide.ts"]
+ "exclude": ["node_modules", "src/lib/multiply.ts"]
}

型チェックします。src/lib/divide.ts はコンパイル対象のため、型エラーが出ます。src/lib/multiply.ts はコンパイル対象外のため、そのファイルに関するエラーは出ません。

$ pnpm run typecheck

src/lib/divide.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1/num2
                ~~~~

Found 1 error in src/lib/divide.ts:2

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しlib/divide.tsを型チェック対象にする"

exclude の値を更新し、lib/multiply.ts をコンパイル対象とします。

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", "src/lib/multiply.ts"]
+ "exclude": ["node_modules"]
}

型チェックします。lib/multiply.ts と lib/divide.ts はコンパイル対象のため、型エラーが出ます。

$ pnpm run typecheck

src/lib/divide.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1/num2
                ~~~~

src/lib/multiply.ts:2:15 - error TS2363: The right-hand side of an arithmetic operation must be of type 'any', 'number', 'bigint' or an enum type.

2   return num1*num2
                ~~~~

Found 2 errors in 2 files.

Errors  Files
     1  src/lib/divide.ts:2
     1  src/lib/multiply.ts:2

コミットします。

$ git add .
$ git commit -m "feat: excludeを更新しlib/multiply.tsを型チェック対象にする"

型エラーを修正します。

lib/divide.ts
-export const divide = (num1:number, num2:string) => {
+export const divide = (num1:number, num2:number) => {
  return num1/num2
}
lib/multiply.ts
-export const mutiply = (num1:number, num2:string) => {
+export const mutiply = (num1:number, num2:number) => {
  return num1*num2
}

型チェックします。エラーは出ません。

$ pnpm run typecheck

コミットします。

$ git add .
$ git commit -m "feat: 型エラーを修正"

Next.jsの設定考察

create next-app で作成した Next.js プロジェクトで exclude が設定されています。必要に応じて変更しましょう。

こちらの例では、2 つのディレクトリを TypeScript のコンパイル対象から除外しています。

パス 説明
node_modules プロジェクトの依存関係がインストールされているディレクトリ
outDir TypeScript のコンパイル結果が出力されるディレクトリ
tsconfig.json
{
  "compilerOptions": {
    "outDir": "./dist",
  },
  "include": [
    "**/*.ts",
    "**/*.tsx",
    "**/*.cjs",
    "**/*.js",
  ],
  "exclude": ["node_modules", "dist"]
}

まとめ

この記事では、exclude の値を変更し、範囲外のファイルが型チェックされるか、範囲内のファイルが型チェックされるかを確認します。Node.js & TypeScript のプロジェクトと Next.js のプロジェクトで動作確認を行いました。

Discussion