feat: add comment in cbi config file

[heurtematte]

Allow comment in cbi config file:

Comment with #

  #"matrix-token": "syt_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "matrix-token": "syt_YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",

Comment with //

  //"matrix-token": "syt_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "matrix-token": "syt_YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",

Add comment before a property:

  //this is sonar token
  "sonar-token": "<sonar_token>", 

And after:

"sonar-token": "<sonar_token>", //sonar-token comment

One known issue: if you comment the last key.

 "github": {
     "access_token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  },
  // "test": "YYYYYYYYYYYYYYY"
}

[heurtematte]

For this modification to work properly all direct references must be change:

For example this code still fail with comment

"$(jq -r '."sonar-token"' < "${LOCAL_CONFIG}")"

must be replace with:

ACCESS_TOKEN="$("${CI_ADMIN_ROOT}/utils/local_config.sh" "get_var" "sonar-token")"

[fredg02]

I understand that missing comments in JSON files are painful, but at the same time I'd avoid custom tailored solutions that require special handling (e.g. jq cannot read the file anymore).

[heurtematte]

OK we can wait until jq 1.8 :-) jqlang/jq#2548

[mbarbero]

or read the json file with jsonnet first (a valid json file is a valid jsonnet file, and jsonnet supports comments ;))

[fredg02]

Or wait until comments in JSON files make it into the standard. 😛

[heurtematte]

unfortunately this will never happen! 😞 that's why json5 exist.