TypeScript プロジェクト用のボイラープレート
node.js = "^16"
をインストール済みであること。VSCode で本フォルダを開いて、拡張機能タブを開き、@recommended
を入力して表示された推奨拡張機能を全てインストールします。
パッケージをインストールする際は、以下のコマンドを実行します。
npm install
このコマンドは以下の処理を実行します。
dependencies
と devDependencies
のパッケージをインストールします。TypeScript のコードから ECMAScript のコードを生成する際は、以下のコマンドを実行します。
npm run build
このコマンドは以下の処理を実行します。
テストを実行する際は、以下のコマンドを実行します。
npm test
このコマンドは以下の処理を実行します。
パッケージを生成するか生成したパッケージをレジストリにプッシュする際は、以下のコマンドを実行します。
# package を生成する
npm pack
# package を生成し、registry にpushする
npm publish
npm publish
コマンドは以下の処理を実行します。
files
に定義されたファイルを同梱するパッケージを生成します。git commit
実行時に自動的にテストを実行するように設定されています。
したがって、テストに失敗するソースコードはコミットできません。
パッケージ PACKAGE_NAME
を追加する際は、以下のコマンドを実行します。
# ソースコード用パッケージ追加
npm add PACKAGE_NAME
# 開発用パッケージ追加
npm add -D PACKAGE_NAME
バージョンを更新する際は、以下のコマンドを実行します。
npm run release
npm run push
このコマンドは以下の処理を実行します。
version
をインクリメントします。1.2.3
の頭に v
を付けたタグ v1.2.3
を作成します。