VSCodeで開発時のインポート補完(TypeScript)を相対パスからエイリアスにする設定

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。
Visual Studio CodeでTypeScriptファイルのimport補完をエイリアスを使用して相対パスではなく行う設定は、主に以下のステップで行います。これにより、コードの可読性が向上し、ディレクトリ構造が変更された場合でも影響を受けにくくなります。
tsconfig.json でのエイリアス設定
プロジェクトのルートにある tsconfig.json
ファイルを開きます。ファイルが存在しない場合は、新しく作成してください。
compilerOptions
セクションに baseUrl
と paths
を追加して、エイリアスを設定します。例えば、src
フォルダを基点としてエイリアスを設定したい場合、以下のように記述します。
json# tsconfig.json
{
"compilerOptions": {
"baseUrl": "./", // プロジェクトのルートを基点に設定
"paths": {
"@/components/*": ["src/components/*"], // @/componentsエイリアスをsrc/components/にマッピング
"@/utils/*": ["src/utils/*"] // @/utilsエイリアスをsrc/utils/にマッピング
}
}
}
VSCode の設定
VSCodeはtsconfig.json
の設定を自動的に認識し、TypeScriptファイル内でのimport時にエイリアスに基づいた補完を提供します。特別なVSCodeの設定は必要ありません。ただし、エイリアスを設定した後にVSCodeを再起動することで、変更が正しく認識されるようになる場合があります。
エイリアスを使用したimport例
上記の設定後、以下のようにエイリアスを使用してモジュールをimportできるようになります。
typescriptimport { MyComponent } from "@components/MyComponent";
import { utilityFunction } from "@utils/utilityFunction";
その他
- エイリアスを使用すると、ビルドツールや他のツールがエイリアスを正しく解決できない場合があります。WebpackやBabelなどを使用している場合は、これらのツールにも同様のエイリアス設定を行う必要があります。
- この設定はTypeScriptプロジェクトに特有のものです。JavaScriptプロジェクトで同様の機能を実現するには、Babelのmodule-resolverプラグインなどを使用する必要があります。
- article
VSCode 拡張との比較でわかる!Cursor を選ぶべき開発スタイル
- article
Cline × VSCode:最強の AI ペアプログラミング環境構築
- article
GitHub Copilot の設定大全:VS Code で精度を最大化する最適化手順
- article
Copilot×Cursorでプラグインがぶつかる!VSCode拡張競合エラーの見分け方と対策集
- article
VSCode で快適に使う ESLint 拡張機能ガイド
- article
VSCodeで開発時のインポート補完(TypeScript)を相対パスからエイリアスにする設定
- article
Pinia × TypeScript:型安全なストア設計入門
- article
TypeScript で実現するクリーンアーキテクチャ:層分離と依存性逆転の実践
- article
TypeScript × GitHub Copilot:型情報を活かした高精度コーディング
- article
TypeScript による型安全なエラーハンドリング:Result 型と Neverthrow の活用
- article
TypeScript と RxJS を組み合わせたリアクティブプログラミング完全ガイド
- article
Remix × TypeScript:型安全なフルスタック開発
- article
React 開発を加速する GitHub Copilot 活用レシピ 20 選
- article
Prisma の公式ドキュメントを使い倒すためのコツ
- article
GitHub Actions × Node.js:テストとデプロイを自動化する
- article
Pinia × TypeScript:型安全なストア設計入門
- article
Obsidian デイリーノート活用術:毎日の思考ログを資産に変える方法
- article
Git で特定のコミットを打ち消す!git revert の正しい使い方
- blog
iPhone 17シリーズの発表!全モデルiPhone 16から進化したポイントを見やすく整理
- blog
Googleストアから訂正案内!Pixel 10ポイント有効期限「1年」表示は誤りだった
- blog
【2025年8月】Googleストア「ストアポイント」は1年表記はミス?2年ルールとの整合性を検証
- blog
Googleストアの注文キャンセルはなぜ起きる?Pixel 10購入前に知るべき注意点
- blog
Pixcel 10シリーズの発表!全モデル Pixcel 9 から進化したポイントを見やすく整理
- blog
フロントエンドエンジニアの成長戦略:コーチングで最速スキルアップする方法
- review
今の自分に満足していますか?『持たざる者の逆襲 まだ何者でもない君へ』溝口勇児
- review
ついに語られた業界の裏側!『フジテレビの正体』堀江貴文が描くテレビ局の本当の姿
- review
愛する勇気を持てば人生が変わる!『幸せになる勇気』岸見一郎・古賀史健のアドラー実践編で真の幸福を手に入れる
- review
週末を変えれば年収も変わる!『世界の一流は「休日」に何をしているのか』越川慎司の一流週末メソッド
- review
新しい自分に会いに行こう!『自分の変え方』村岡大樹の認知科学コーチングで人生リセット
- review
科学革命から AI 時代へ!『サピエンス全史 下巻』ユヴァル・ノア・ハラリが予見する人類の未来