Libx Awesomeリスト

    このページの内容

    Awesome npm Scripts

    npm Scriptsを扱う資料や関連プロジェクトをまとめたAwesomeリストです。

    目次

    記事

    動画・講演

    タスクランナー

    複数のコマンドまたは npm スクリプトを並列・逐次に実行するツール。

    • script-runner - 簡潔な構文を備えたシンプルなタスクランナー。
    • npm-run-all2 - 多機能なタスクランナー。
    • redrun - package.json のスクリプトを展開して実行速度を改善する。

    ファイル監視ツール

    ソースファイルを監視し、いずれかのファイルが変更されるたびにビルドコマンドを実行するツール。

    • onchange - onchange <glob> -- <command>。
    • watch - watch <command> <directory>。

    開発サーバー

    • http-server - 設定不要のシンプルなコマンドライン HTTP サーバー。
    • live-server - ライブリロード機能を持つシンプルな開発用 HTTP サーバー。

    クロスプラットフォームユーティリティ

    クロスプラットフォーム互換性を気にせず、よく使うコマンドラインタスクを実行するためのユーティリティ。

    • rimraf - ファイルまたはディレクトリを削除する。rm -rf のようなもの。
    • del-cli - より安全にファイルとフォルダーを削除する。
    • mkdirp - 必要に応じて親ディレクトリも作成してディレクトリを作成する。mkdir -p のようなもの。
    • cpr - Node.js 用の cp -r。
    • cpy-cli - ファイル・ディレクトリのコピーと名前変更。
    • copyfiles - ファイルのリストをディレクトリへコピーする。
    • sync-files - 監視モードを備えた rsync 風のディレクトリ同期。
    • echo-cli - JS のエスケープシーケンスに対応するクロスプラットフォームの echo。
    • clear-cli - ターミナルをクリアする。
    • cross-env - Unix 形式でスクリプト用の環境変数を設定する。
    • cross-os - プラットフォーム固有の npm スクリプトを実行する。
    • ntee - 標準入力から読み取り、標準出力とファイルへ書き出すユーティリティ。Unix の tee のようなもの。
    • catw - オプションの監視モード付きでファイルを標準出力へ表示する。Unix の cat に少し似ている。

    ユーティリティパック

    • shx - Node.js で実装した一般的な Unix ユーティリティのコレクション。使用例: shx rm somefile。

    その他のユーティリティ

    • hashmark - ファイルの内容を受け取り、名前にハッシュを含む新しいファイルとして出力する。
    • gzip-size-cli - ファイルまたは標準入力の gzip 圧縮後サイズを取得する。
    • opn-cli - ユーザーの好みのアプリケーションで Web サイト、ファイル、実行ファイルなどを開く。
    • headr - ファイルにヘッダー・バナー情報を追加する。
    • Bower files CLI - メインの Bower ファイルをコマンドラインで取得する。
    • cli-error-notifier - npm スクリプトが失敗したときにネイティブのデスクトップ通知を送る。

    その他

    • screwy - npm scripts の GUI。
    • Forrest - npm scripts のデスクトップクライアント。
    • run-npm - ローカルにインストールされた node モジュールの実行ファイルを実行する。npm scripts のデバッグに便利。
    • npm-quick-run - 完全な名前を入力せず、接頭辞で npm scripts を素早く実行する。
    • edit-script - JSON のエスケープを気にせず、コマンドラインから npm scripts を編集する。
    • ntl - npm scripts を一覧表示・実行するための対話型 CLI メニュー。

    クロスプラットフォームシェルのリファレンス

    Unix と Windows で同じように動作するシェル演算子とコマンドのクイックリファレンス。

    • && はコマンドを順に実行するために使う。コマンドが失敗するとスクリプトは終了する。
    • | は、あるコマンドの標準出力を次のコマンドの標準入力へパイプするために使う。(do-something | something else)
    • > はコマンドの標準出力をファイルへ書き込むために使う。(do-something > file)
    • < はファイルの内容をコマンドの標準入力へ渡すために使う。(command < file)
    • cd <dir> は現在の作業ディレクトリを <dir> に変更するために使う。cd 単体は Windows では現在の作業ディレクトリを表示する一方、*nix では作業ディレクトリを ~ に変更する点に注意。

    npm run リファレンス

    npm run-script または npm run を使える。両者は同じことを行うが、npm run のほうが短い。

    • スクリプトの一覧を出力するには、npm run のみを実行する。
    • npm run script（script はスクリプト名）を実行すると、prescript、script、postscript がこの順序で実行される。
      • pre と post のフックを入れ子にはできない（例: preprescript は動作しない）。
    • スクリプトへ引数を渡すには、-- を npm run の後ろに置き、その後に引数を指定する。例: スクリプトが "mocha": "mocha" の場合、npm run mocha -- --reporter xunit を実行できる。これは実質的に mocha --reporter xunit を実行する。
    • npm test の実行は npm run test と同じである。npm start と npm stop についても同様。
    • npm run <script> -s を実行すると、デフォルトの npm 出力を抑制できる（別のスクリプト内からスクリプトを呼び出す場合に便利）。

    貢献

    CONTRIBUTING.md を参照。