有没有办法评论或更好地组织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":。