AssemblyScript/binaryen.js：README に基づく導入ガイド

AssemblyScript/binaryen.js の README はプロジェクトを「A buildbot for browser & Node.js builds of Binaryen, a compiler infrastructure and toolchain library for WebAssembly.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。binaryen.js is a port of Binaryen using a JavaScript API.。これは範囲の説明であり、本番検証の結果ではありません。

README の「Module manipulation」にある内容から、用途が合うかを先に判断できます。Module#getFunction(name: string): FunctionRef。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Module#addFunction(name: string, params: Type, results: Type, vars: Type[], body: ExpressionRef): FunctionRef。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「README」など複数の箇所に分かれています。確認できる情報は次の通りです。or you can use one of the previous versions instead if necessary.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 $> npm install binaryen 実行可能なコマンドがない場合は手順を作らず、「Command line」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「Usage with a CDN」にはReplace VERSION with a specific version to use main/latest.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはModule#getFunctionByIndex(index: number): FunctionRefともあります。

制約も確認が必要です。現在の資料からは、AssemblyScript/binaryen.js の互換表、性能基準、サービス保証、長期サポートを確認できません。README の記載は「The package includes Node.js builds of Binaryen's command line tools: wasm-shell, wasm-opt, wasm-metadce, wasm2js, wasm-as, wasm-dis, wasm-ctor-eval, wasm-reduce and wasm-merge.」です。不明点は採用記録の検証項目として残し、断定に変えないでください。