pluginArchive
ビルド時に圧縮ファイルを生成するプラグイン。
導入手順と使用例はガイドを参照してください。このページは設定値と制約をまとめています。
Table of Contents
オプション
pluginArchive({
archives: [
{
outName: "dist",
},
],
})archives
生成パターンを配列で設定します。ユーザー側で配列を入力するとデフォルトの配列と差し替えられます。
archives[].srcDir
- 型:
string
圧縮対象のディレクトリをプロジェクトルート相対または絶対パスで指定します。省略時は解決済みのbuild.outDirを使用します。outNameの既定値は引き続きdistです。
アーカイブ内のパスはプロジェクトルート相対のディレクトリ名を含みます。例えばbuild.outDir: "output"ならoutput/index.htmlになります。プロジェクト外の入力では入力ディレクトリ名から始まります。
archives[].outName
- 型:
string
出力先のbuild.outDirからの相対パスで、拡張子を除いた名前を指定します。例えばdownloads/siteなら<outDir>/downloads/site.zipになります。
同じpluginArchiveのarchivesに設定された全出力パスは、圧縮対象から自動除外します。emptyOutDir: falseで保持された前回の同名アーカイブも取り込みません。設定から削除・改名した過去のアーカイブや、配布用として置いた別のZIP／TARは自動除外の対象外です。必要に応じてignoreで除外してください。
archives[].ignore
- 型:
string | string[] - デフォルト:
[]
プロジェクトルート相対のパス（プロジェクト外入力は入力ディレクトリの親からの相対パス）に対して、除外ファイルをminimatchのglob形式で指定します。
- 例:
"dist/**/*.map"
archives[].format
- 型:
"zip" | "tar" - デフォルト:
"zip"
archiverの圧縮形式 zip または tar を指定します。
archives[].options
- 型:
ZipOptions | TarOptions - デフォルト:
{ zlib: { level: 9 } }
archiverの圧縮オプションを指定します。
診断
MINISTA_ARCHIVE_SOURCE_NOT_FOUND：入力ディレクトリが存在しないMINISTA_ARCHIVE_SOURCE_NOT_DIRECTORY：入力がディレクトリではない
存在する空ディレクトリは圧縮できます。