typesync まとめ

概要

• typesyncというプラグインの存在を知ったので調べたことをまとめる

参考資料：TypeScriptの@typesパッケージをtypesyncで自動管理する

typesyncとは

• package.jsonを参照し、不足しているTypeScriptの型定義ファイルを自動で追加してくれるツール

使い方

1. インストール

yarn add -D typesync
#または
npm install -D typesync

2. preinstallの設定

• インストールコマンドを実行する前にtypesyncが走るようにする
• こうしないとインストールしてもtypesyncが走っていないのでTypeScriptの型情報が入ってこない
• コマンドを打ってもいいが面倒くさいので自動で走るように設定する
• package.json内のscriptにpreinstallとして設定する

package.json

 "scripts": {
    ...
     // 初回インストール時にはtypesyncがないので || : を付け加えてエラーを無視します。
+    "preinstall": "typesync || :"
  }

流れ

1. 必要なパッケージを追加する

yarn add axios

2. インストールする

• インストールが実行される前にscriptsに登録していたpreinstallに設定しているtypesyncが走って型情報を取得
• 型情報がpackage.jsonに追加されるので、それを元にyarnでインストールが実行される

yarn install

まとめ

• プロジェクトにTypeScriptを採用する場合には導入するパッケージに付随する型情報も必要になる
• その型情報を自動でインストールするために有用なツールということが分かった
• これからJavaScriptを使用するプロジェクトではTypeScriptは必須となるため、それに付随する作業を少しでも減らせるようにできたと思うのでよかった