rimraf を使って npm run 中にディレクトリを削除する

rimraf とは

TypeScript などコンパイルが必要な環境で開発していると、ファイルを削除して再コンパイルした際に、消したはずのファイルが残り続けることがあります。

これを防ぐために、ビルド前に一度ディレクトリを削除したくなります。なので、Linux を使ったことのある人たちはこのように指定します。

{
  "scripts": {
    "clean": "rm -rf dist"
  }
}

すると、ここで問題が発生します。

rm コマンドは Linux と macOS では使えますが、Windows では使えません。

そこで、どの OS でも rm と同じことができるように、rimraf を使うわけです。

使い方

インストール

npm に公開されているので、以下のコマンドでインストールできます。

開発環境でしか使わないので、--save-dev または -D オプションをつけて devDependencies へ入れましょう。

# npm
$ npm i --save-dev rimraf

# yarn
$ yarn add -D rimraf

# pnpm 
$ pnpm i --save-dev rimraf

scripts に組み込む

以下のように scripts へ組み込んでください。

この例では、dist ディレクトリを削除するようにしています。

build へ npm run clean && tsc のように付け加えてあげると完了です。

{
  "scripts": {
    "clean": "rimraf dist",
    "build": "npm run clean && tsc"
  }
}