LoginSignup
19
6

More than 3 years have passed since last update.

TypeScript の baseUrl について調べた事

Last updated at Posted at 2019-12-18

TypeScript の baseUrl とは何か?

module のインポート時に起点となるディレクトリを指定できる設定です。
詳細は公式ドキュメントを参照してください。

baseUrl を設定する

tsconfig.json の compilerOptions で設定します。
インポート時に起点となるディレクトリを tsconfig.json を配置しているディレクトリから相対パスで指定します。

tsconfig.json
{
  "compilerOptions": {
    "baseUrl": "./src"
  }
}

baseUrl を設定した場合のモジュールのインポート

こちらのようなディレクトリ構成の場合...

.
├── dist
├── src
│   ├── components
│   │   └── index.ts
│   └── modules
│       └── module.ts
└── tsconfig.json

src/components/index.ts から src/modules/module.ts をインポートする時、通常は相対パスで指定すると思います。

src/components/index.ts
import moduleDemo from '../modules/module'

moduleDemo()

tsconfig.json で baseUrl./src を指定しておくことで ./src を起点にモジュール解決をする事ができるので、こちらのように書く事ができます。

src/components/index.ts
import moduleDemo from 'modules/module'

moduleDemo()

まとめ

create-react-app で React + TypeScript を書いている時に、コンポーネントのインポートを相対パスで書くの面倒くさいな...と思っていたらこの設定を見つける事ができました。
これでコンポーネントのインポートがちょっとは楽になるかなと思います。

19
6
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
19
6