コンテンツへスキップ

ビルド時の共有プラグイン

フィードバック

環境APIフィードバックディスカッションでフィードバックをお寄せください

ビルド時の共有プラグインを参照してください。

影響範囲: Vite プラグイン作者

将来のデフォルト変更

builder.sharedConfigBuildv6.0で初めて導入されました。これをtrueに設定することで、共有設定でプラグインがどのように動作するかを確認できます。プラグインのエコシステムが準備でき次第、将来のメジャーリリースでデフォルトを変更することについてフィードバックを求めています。

動機

開発とビルドのプラグインパイプラインを合わせる。

移行ガイド

プラグインを複数の環境で共有できるようにするには、プラグインの状態を現在の環境でキー付けする必要があります。次の形式のプラグインは、すべての環境で変換されたモジュールの数を数えます。

js
function CountTransformedModulesPlugin() {
  let transformedModules
  return {
    name: 'count-transformed-modules',
    buildStart() {
      transformedModules = 0
    },
    transform(id) {
      transformedModules++
    },
    buildEnd() {
      console.log(transformedModules)
    },
  }
}

代わりに各環境で変換されたモジュールの数を数えたい場合は、マップを保持する必要があります。

js
function PerEnvironmentCountTransformedModulesPlugin() {
  const state = new Map<Environment, { count: number }>()
  return {
    name: 'count-transformed-modules',
    perEnvironmentStartEndDuringDev: true,
    buildStart() {
      state.set(this.environment, { count: 0 })
    }
    transform(id) {
      state.get(this.environment).count++
    },
    buildEnd() {
      console.log(this.environment.name, state.get(this.environment).count)
    }
  }
}

このパターンを簡素化するために、ViteはperEnvironmentStateヘルパーをエクスポートしています。

js
function PerEnvironmentCountTransformedModulesPlugin() {
  const state = perEnvironmentState<{ count: number }>(() => ({ count: 0 }))
  return {
    name: 'count-transformed-modules',
    perEnvironmentStartEndDuringDev: true,
    buildStart() {
      state(this).count = 0
    }
    transform(id) {
      state(this).count++
    },
    buildEnd() {
      console.log(this.environment.name, state(this).count)
    }
  }
}

MIT ライセンスで公開。(083ff36d)