Czy istnieje sposób, aby skomentować lub lepiej zorganizować plik bower.json?

Question

Mam bardzo duży projekt z licznymi zależnościami bower. W wielu przypadkach nie jest jasne, czy te zależności są nadal używane w aplikacji, czy też wybrana wersja została wybrana z jakiegoś powodu. Idealnie, chciałbym móc umieścić komentarz dla każdej zależności do stanu, dla której części aplikacji jest ona wymagana, aby usunąć funkcjonalność aplikacji, możemy również usunąć niepotrzebne pakiety z komponentów bower_. Coś jak:

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

Niestety, json nie obsługuje komentowanie, ale czy są jakieś możliwe rozwiązania dla adnotacji lub lepsze zorganizowanie plik bower.json aby uczynić go bardziej zrozumiałe?

Answer 1

Nie można umieszczać komentarzy w pliku JSON. JSON jest dla danych i nic więcej.

Aby udokumentować swoje zależności, należy rozważyć dodanie sekcji do pliku README zawierającego wszystkie informacje istotne dla zależności.

Answer 2

Klasyczne podejście do komentowania plików JSON jest dodanie fałszywych wpisów, które mamy nadzieję będą ignorowane przez konsumenta, takie jak:

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

na dłuższe komentarze, korzystać z tablic:

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

Oczywiście będziesz musiał umieścić je gdzieś, gdzie ktoś nie będzie próbował ich przeanalizować. Na przykład nie mogli wejść W CIĄGU "dependencies":.