JavaScript、Node.js、Gulp でフラグを使ったタスク実行

2024-04-02

Gulp タスクにフラグを渡して実行方法を変える

フラグを渡す方法

Gulp タスクにフラグを渡す方法はいくつかあります。

コマンドライン引数
Gulp タスクのオプション
環境変数

Gulp タスクを実行する際に、コマンドライン引数としてフラグを渡すことができます。

gulp task --flag

例

gulp build --prod

この例では、build タスクを実行し、--prod フラグを渡すことで、本番環境用のビルドを実行します。

Gulp タスクのオプションとしてフラグを渡すこともできます。

gulp.task('task', function(done) {
  // フラグを取得
  const flag = gulp.option('flag');

  // フラグに応じて処理を変える
  if (flag === 'prod') {
    // 本番環境用の処理
  } else {
    // 開発環境用の処理
  }

  done();
});

gulp task --flag=prod

環境変数を使ってフラグを設定することもできます。

export FLAG=prod

gulp task

この例では、FLAG 環境変数を prod に設定し、task タスクを実行することで、本番環境用の処理を実行します。

フラグの使用例

フラグは、さまざまな状況で役立ちます。

異なる環境で異なる設定でタスクを実行する
特定のタスクのみを実行する
タスクの動作を変える

リンターの厳格さを変える

Gulp タスクにフラグを渡すことで、実行方法を変えることができます。これは、さまざまな状況で役立ちます。

const gulp = require('gulp');

// タスク
gulp.task('task', function(done) {
  // フラグを取得
  const flag = gulp.option('flag');

  // フラグに応じて処理を変える
  if (flag === 'prod') {
    console.log('本番環境用の処理');
  } else {
    console.log('開発環境用の処理');
  }

  done();
});

// コマンドライン引数でフラグを渡す
gulp.task('default', function() {
  gulp.start('task', '--flag=prod');
});

--flag=prod の場合: 本番環境用の処理を実行
その他の場合: 開発環境用の処理を実行

default タスクは、task タスクを --flag=prod フラグ付きで実行します。

実行例

gulp

このコマンドを実行すると、開発環境用の処理が実行されます。

gulp --flag=prod

補足

このサンプルコードは、基本的な例です。実際のユースケースに合わせて、コードを修正する必要があります。

複数のフラグをサポートしたい場合は、gulp.option を使って複数のオプションを取得できます。
フラグに基づいて異なるタスクを実行したい場合は、gulp.if を使って条件分岐できます。

Gulp タスクにフラグを渡すその他の方法

Gulp プラグインを使う

Gulp には、フラグを処理するためのプラグインがいくつかあります。

これらのプラグインを使うことで、より簡単にフラグを処理することができます。

自作の関数を使う

上記の方法以外にも、自作の関数を使ってフラグを処理することができます。

function getFlags() {
  // コマンドライン引数からフラグを取得
  const args = process.argv.slice(2);
  const flags = {};

  args.forEach(arg => {
    const [key, value] = arg.split('=');
    flags[key] = value;
  });

  return flags;
}

// タスク
gulp.task('task', function(done) {
  // フラグを取得
  const flags = getFlags();

  // フラグに応じて処理を変える
  if (flags.flag === 'prod') {
    console.log('本番環境用の処理');
  } else {
    console.log('開発環境用の処理');
  }

  done();
});