【設定方法】Next.js開発時にファイルimportでパスの alias(エイリアス)利用するためのサンプルコード

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。
Next.jsで作ったアプリケーションで開発を行う時に
ファイルimportでパスのエイリアスを利用するための設定を行なったので
手順としてやり方をメモします。
alias(エイリアス)について
aliasはパスを設定する際にわずらわしいパスの記述を
短縮して簡潔にかける仕組みになります。
alias(エイリアス)の例
alias(エイリアス)なし
../../
という形で相対パスで書かなければなりません。
JavaScript
import Hoge from '../../components/Hoge'
alias(エイリアス)あり
@
という形で簡潔に書けます。
JavaScriptimport Hoge from '@components/Hoge'
alias(エイリアス)のメリット
短縮して簡潔に
例のようにエイリアスがあることで
短縮して簡潔に書くことができる様になります。
リファクタリングしやすい
ファイル移動時に階層が変わる場合
通常はパスを書き直さなければなりませんが
エイリアスを設定することで書き直す必要がなくなります。
環境
- React 17.0.2
- Next.js 7.0
必要なパッケージのインストール
webpackをインストール
next.js
はwebpackが内包されているため
設定を変更する場合は別途インストールします。
※ npmでインストールする場合は適宜置き換えてください。
terminal$ yarn add -D webpack
ディレクトリ構成
terminal├── next.config.js
└── src
├── hoge
│ └── hoge.js
└── main.js
next.config.jsの設定
全体のコード
先に全体のコードを記載します。
解説はこの後に記載させていただいています。
javascript// next.config.js
const path = require("path");
const webpack = require("webpack");
module.exports = webpack(config, options) {
config.resolve.alias = {
"@": path.resolve(__dirname, "./src/"),
};
return config;
}
インストールしたパッケージの読み込み
requireでインストールしたパッケージを読み込みます。
javascript// next.config.js
const path = require("path");
const webpack = require("webpack");
webpackの設定に追加する
config
の引数からnext.js
で隠蔽されている設定が取得できるため
ここに alias
の設定を追記します。
javascript// next.config.js
webpack(config, options) {
console.log(config);
// webpackの設定が確認できる
}
aliasの設定を追加
next.config.js
が置いてある階層の src
ディレクトリを指定して
src/hoge
を@hoge
でimportできるように指定しています。
javascript// next.config.js
config.resolve.alias = {
"@": path.resolve(__dirname, "./src/"),
};
importの記述
javascript// src/main.js
import Hoge from "@hoge/hoge.js"
TypeScriptの場合
tsconfig.jsonの設定
TypeScriptの場合この設定を入れないと
ビルド時やエディタでエラーが発生するため追記します。
json// tsconfig.json
{
"compilerOptions": {
"paths": { "@/*": ["src/*"] },
}
}
再ビルド・起動して確認
本番用のビルド・起動を実行して確認します。
zsh$ yarn next build && yarn next start
ビルド・起動が完了したらアプリケーションを開いて
aliasが指定した通りに設定されていること確認します。
参考文献
- article
Next.js の Middleware 活用法:リクエスト制御・認証・リダイレクトの実践例
- article
【解決策】Next.js での CORS エラーの原因と対処方法まとめ
- article
Next.js で環境変数を安全に管理するベストプラクティス
- article
shadcn/ui × Next.js:モダンな UI を爆速構築する方法
- article
Next.js の Image コンポーネント徹底攻略:最適化・レスポンシブ・外部 CDN 対応
- article
NextJS で始める Web アプリケーションの多言語・国際化対応の方法
- article
【早見表】JavaScript でよく使う Math メソッドの一覧と活用事例
- article
JavaScript のオブジェクト操作まとめ:Object.keys/entries/values の使い方
- article
【実践編】JavaScript の正規表現活用術:効率的に文字列を処理する方法
- article
JavaScript の this キーワードを完全理解!初心者がつまずくポイント解説
- article
【徹底比較】JavaScript での null と undefined の違いと正しい使い分け
- article
JavaScript のクロージャ完全ガイド:スコープとメモリの仕組みを深掘り
- article
Remix の Mutation とサーバーアクション徹底活用
- article
【解決策】Codex API で「Rate Limit Exceeded」が出る原因と回避方法
- article
既存 React プロジェクトを Preact に移行する完全ロードマップ
- article
Astro × TypeScript:型安全な静的サイト開発入門
- article
Playwright × Docker:本番環境に近い E2E テストを構築
- article
useQuery から useLazyQuery まで - Apollo Hooks 活用パターン集
- 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 時代へ!『サピエンス全史 下巻』ユヴァル・ノア・ハラリが予見する人類の未来