プロトタイプ汚染脆弱性(CVE-2024-6783)およびReDoS脆弱性(CVE-2024-9506)を修正するための、セキュリティパッチ適用版のvue-template-compilerです。
[email protected]をベースにしています。開発とイシューはvue-patchedで管理されています。
Vueのフルビルド(ランタイム+コンパイラ)やCDNのvue.jsを使用している場合は、vueもvue-patchedに置き換えてください。
このパッケージは、Vue 2.0のテンプレートをレンダー関数に事前コンパイルし、ランタイムコンパイルのオーバーヘッドやCSP制限を回避するために使用できます。ほとんどの場合、vue-loaderと組み合わせて使用するため、非常に特殊なニーズでビルドツールを作成する場合にのみ、単独で必要になります。
最適なインストール方法を選択してください。
パッチ適用済みのコンパイラを元のvue-template-compilerという名前でインストールするため、ピア依存関係が満たされたままになり、既存のパッケージ参照(例:@vue/test-utils内)も引き続き解決されます。
npm install vue-template-compiler@npm:vue-template-compiler-patched@^2.7.16-patch.3 --save-dev
pnpm add vue-template-compiler@npm:vue-template-compiler-patched@^2.7.16-patch.3 --save-dev
yarn add vue-template-compiler@npm:vue-template-compiler-patched@^2.7.16-patch.3 --dev
コンパイラを vue-template-compiler-patched としてインストールします。パッチ適用済みビルドに直接アクセスするだけでよい場合は、この方法を使用してください。パッケージ名で vue-template-compiler を解決するツールは、これを検出しません。
npm install vue-template-compiler-patched --save-dev
pnpm add vue-template-compiler-patched --save-dev
yarn add vue-template-compiler-patched --dev
import compiler from 'vue-template-compiler-patched'
// or: const compiler = require('vue-template-compiler-patched')
テンプレート文字列をコンパイルし、コンパイル済みの JavaScript コードを返します。返される結果は次の形式のオブジェクトです:
{
ast: ?ASTElement, // parsed template elements to AST
render: string, // main render function code
staticRenderFns: Array<string>, // render code for static sub trees, if any
errors: Array<string> // template syntax errors, if any
}
返される関数コードは with を使用しているため、strict モードのコードでは使用できないことに注意してください。
outputSourceRange 2.6 で新規追加
booleanfalseこれを true に設定すると、コンパイル結果で返される errors が { msg, start, end } の形式のオブジェクトになります。start と end プロパティは、テンプレート内のエラーソースのコード範囲を示す数値です。これは compiler.generateCodeFrame API に渡して、エラーのコードフレームを生成できます。
whitespace
string'preserve' | 'condense''preserve'デフォルト値 'preserve' は、空白を次のように処理します:
'condense' に設定した場合:
condense モードを使用すると、コンパイル後のコードサイズが小さくなり、パフォーマンスがわずかに向上します。ただし、特定のケースでは、プレーンな HTML と比較して軽微な視覚的レイアウトの差異が生じます。
このオプションは <pre> タグには影響しません。
例:
<!-- source -->
<div>
<span>
foo
</span> <span>bar</span>
</div>
<!-- whitespace: 'preserve' -->
<div> <span>
foo
</span> <span>bar</span> </div>
<!-- whitespace: 'condense' -->
<div><span> foo </span> <span>bar</span></div>
modules
コンパイルプロセスにフックして、カスタムテンプレート機能をサポートすることができます。ただし、カスタムのコンパイル時モジュールを注入すると、テンプレートは標準の組み込みモジュール上に構築された他のビルドツール(例: vue-loader や vueify)では動作しなくなることに注意してください。
コンパイラモジュールの配列です。コンパイラモジュールの詳細については、flow declarations の ModuleOptions 型と組み込みモジュールを参照してください。
directives
キーがディレクティブ名、値がテンプレートの AST ノードを変換する関数であるオブジェクトです。例:
compiler.compile('<div v-test></div>', {
directives: {
test (node, directiveMeta) {
// transform node based on directiveMeta
}
}
})
デフォルトでは、コンパイル時ディレクティブはそのディレクティブを抽出し、実行時にはディレクティブは存在しません。ディレクティブを実行時の定義でも処理したい場合は、transform 関数で true を返してください。
いくつかの組み込みコンパイル時ディレクティブの実装を参照してください。
preserveWhitespace 2.6 以降非推奨
booleantrueデフォルトでは、コンパイルされたレンダー関数は HTML タグ間のすべての空白文字を保持します。false に設定すると、タグ間の空白は無視されます。これによりパフォーマンスがわずかに向上する可能性がありますが、インライン要素のレイアウトに影響を与える可能性があります。
compiler.compile と似ていますが、インスタンス化された関数を直接返します:
{
render: Function,
staticRenderFns: Array<Function>
}
これは事前設定済みのビルドでの実行時にのみ有用であるため、コンパイル時のオプションは一切受け付けません。さらに、このメソッドは new Function() を使用するため、CSP に準拠していません。
2.4.0+
compiler.compile と同じですが、SSR のパフォーマンスを向上させるためにテンプレートの一部を文字列連結に最適化することで、SSR 専用のレンダー関数コードを生成します。
これは vue-loader@>=12 でデフォルトで使用されており、optimizeSSR オプションを使用して無効にできます。
2.4.0+
compiler.compileToFunction と同じですが、SSR のパフォーマンスを向上させるためにテンプレートの一部を文字列連結に最適化することで、SSR 専用のレンダー関数コードを生成します。
SFC(単一ファイルコンポーネント、または *.vue ファイル)をディスクリプタにパースします(flow declarations の SFCDescriptor 型を参照してください)。これは vue-loader や vueify などの SFC ビルドツールで使用されます。
start と end で定義された template 内の部分をハイライトするコードフレームを生成します。高レベルのツールでのエラー報告に役立ちます。
padpad は、抽出されたコンテンツを他のプリプロセッサにパイプする際に、構文エラーがある場合に正しい行番号や文字インデックスを取得できるため便利です。
{ pad: "line" } の場合、各ブロックの抽出コンテンツには、元のファイルの先頭コンテンツの各行に対して 1 つの改行がプレフィックスとして付加され、行番号が元のファイルと一致するようになります。{ pad: "space" } の場合、各ブロックの抽出コンテンツには、元のファイルの先頭コンテンツの各文字に対して 1 つのスペースがプレフィックスとして付加され、文字数が元のファイルと同じになるようになります。