package.json
は JSON フォーマットのファイルであるため、コメントを書くことができません。package.json
に定義したスクリプトの説明を書いておくことは重要です。別のファイルに説明を書いたり、//
で始まるキーを使用してコメントを書くハックが生まれるなど、様々な方法が考案されていたのが思い出されます。
Bun v1.2 では package.json
は JSONC フォーマットとして解釈されるようになりました。この変更により、package.json
にコメントを書いたり、trailing comma が許可されるようになりました。
{
"scripts": {
// Start the server
"start": "node index.js" // trailing comma
}
}
しかしこの機能は JavaScript のエコシステムで広くサポートされていない点に注意してください。現状は Bun でのみ利用可能です。