有什么方法可以评论或更好地组织 bower.json 文件吗？

Question

我有一个非常大的项目，其中有许多 Bower 依赖项。在许多情况下，不清楚这些依赖项是否仍在应用程序中使用，或者是否出于某种原因选择了指定的版本。理想情况下，我希望能够为每个依赖项添加注释，以说明应用程序的哪一部分需要它，这样随着应用程序中的功能被删除，我们也可以从 bower_components 中删除不必要的包。类似于：

// videojs plug-in for adding navigable waveforms; used by the video component
"videojs-wavesurfer": "^1.2.2"

不幸的是，json 不支持评论，但是是否有任何可能的解决方案来注释或更好地组织 bower.json 文件以使其更易于理解？

Answer 1

您不能在 JSON 文件中添加评论。 JSON 用于数据，仅此而已。

如果您想记录您的依赖项，请考虑在您的 README 文件中添加一个部分，其中包含与依赖项相关的所有信息。

Answer 2

评论 JSON 文件的经典方法是添加虚假条目，希望这些条目会被消费者忽略，例如：

"video-wavesurfer-comment": 
  "videojs plug-in for adding navigable waveforms; used by the video component"

对于较长的注释，使用数组：

"video-wavesurfer-comment": [
  "videojs plug-in for adding navigable waveforms; used by the video component",
  "Remove this for the non-video version."
]

当然，您必须将它们放在别人不会尝试解析它们的地方。例如，他们不能在 "dependencies":.

内

有什么方法可以评论或更好地组织 bower.json 文件吗？

Is there any way to comment in or better organize a bower.json file?

javascript

json

bower