🤖

TypeScriptプロジェクトにtsconfig.jsonを生成する方法

2024/08/10に公開

TypeScriptプロジェクトにtsconfig.jsonを生成する方法

TypeScriptプロジェクトを始める際に、TypeScriptコンパイラの設定を行うためのtsconfig.jsonファイルが必要です。このファイルは、プロジェクトのコンパイル設定やエクスポートするJavaScriptのバージョンなどを定義します。この記事では、tsconfig.jsonファイルを簡単に生成する方法を説明します。

TypeScriptをプロジェクトにインストールする

まず最初に、プロジェクトにTypeScriptをインストールする必要があります。TypeScriptはtypescriptというパッケージとして提供されており、npmを使ってインストールします。開発環境用の依存関係としてインストールするため、以下のコマンドを実行してください。

$ npm install typescript --save-dev

これで、プロジェクトにTypeScriptがインストールされ、node_modulesフォルダ内にtscコマンドが利用可能になります。

package.jsontscスクリプトを追加する

次に、tscコマンドを簡単に実行できるようにするため、package.jsonファイルにtscスクリプトを追加します。これにより、プロジェクト内でnpm run tscを実行するだけで、TypeScriptのコンパイラを使用できるようになります。

package.jsonscriptsセクションに以下の行を追加します。

"scripts": {
  "tsc": "tsc"
}

この設定により、npm run tscコマンドが、プロジェクト内でTypeScriptコンパイラを実行するためのスクリプトとして機能します。

tsconfig.jsonファイルを生成する

最後に、tsconfig.jsonファイルを生成します。これには、npmを使って以下のコマンドを実行します。

$ npm run tsc -- --init

コマンド内の--は、npmに対して、続く引数をtscコマンドに渡すよう指示するために使用します。これにより、--inittscコマンドに渡され、tsconfig.jsonファイルが生成されます。

生成されたtsconfig.jsonファイルは、多くのコメントと共に設定オプションが記載されたファイルとなります。初期状態では、ほとんどのオプションがコメントアウトされていますが、プロジェクトのニーズに応じてこれらのオプションを有効にすることができます。

{
  "compilerOptions": {
    /* このファイルについて詳しくは https://www.typescriptlang.org/tsconfig/ を参照してください */

    /* プロジェクト設定 */
    // "incremental": true, /* プロジェクトのインクリメンタルコンパイルを可能にするため、.tsbuildinfoファイルを保存します。 */
    /* ... */

    /* 言語と環境設定 */
    "target": "es2020", /* 出力されるJavaScriptのバージョンを設定し、対応するライブラリの宣言を含めます。 */
    /* ... */
  }
}

以上で、tsconfig.jsonファイルの初期設定が完了しました。これで、プロジェクトでのTypeScriptの使用が可能になり、必要に応じて設定をカスタマイズすることができます。

フリーランスエンジニア必見!

最後に、フリーランスエンジニアの方にご案内です。
あなたに今だけご紹介できる”エンド直”・”高単価”の案件があります!

気になる方は公式ラインの追加をお願いします👇
https://s.lmes.jp/landing-qr/2005758918-ADDegZkx?uLand=tau44P

Discussion