JSON formatting - camelCase? about gsd-tools

[joshbuker]

I say we go with Google's style guide for now, and if for some reason there's a disagreement with the guide we can revisit the discussion then. It will provide a clear answer for how to style things, and we can potentially validate against it for consistency.

That said, the only thing that's important to me is to be consistent, and to as much as possible follow industry best practices on formatting.

[raphaelahrens]

The Google guide makes some good general points, but in some parts is very google specific.
For example the section "Top-Level Reserved Property Names".

Regarding the casing of the keys, I would say it doesn't matter just pick one and stay with it.
Preferable is the decisions which requires the least changes to make it consistent.

Here is a list of all keys from GSD, so the norm is to use snake case
keys.txt
.

'.GSD.affected'
'.GSD.affected_component'
'.GSD.affects.ranges'
'.GSD.alias'
'.GSD.attack_vector'
'.GSD.credit'
'.GSD.data_format'
'.GSD.data_type'
'.GSD.data_version'
'.GSD.description'
'.GSD.details'
'.GSD.duplicate'
'.GSD.extended_references'
'.GSD.id'
'.GSD.impact'
'.GSD.impact.cvss.attackComplexity'
'.GSD.impact.cvss.attackVector'
'.GSD.impact.cvss.availabilityImpact'
'.GSD.impact.cvss.baseScore'
'.GSD.impact.cvss.baseSeverity'
'.GSD.impact.cvss.confidentialityImpact'
'.GSD.impact.cvss.exploitCodeMaturity'
'.GSD.impact.cvss.integrityImpact'
'.GSD.impact.cvss.privilegesRequired'
'.GSD.impact.cvss.remediationLevel
'.GSD.impact.cvss.reportConfidence'
'.GSD.impact.cvss.scope'
'.GSD.impact.cvss.temporalScore'
'.GSD.impact.cvss.temporalSeverity'
'.GSD.impact.cvss.userInteraction'
'.GSD.impact.cvss.vectorString'
'.GSD.impact.cvss.version'
'.GSD.modified'
'.GSD.notes'
'.GSD.product_name'
'.GSD.product_version'
'.GSD.published'
'.GSD.references'
'.GSD.reporter'
'.GSD.reporter_id'
'.GSD.summary'
'.GSD.vendor_name'
'.GSD.vulnerability_type'
'.GSD.withdrawn'

[joshbuker]

I agree that the important thing is consistency. I'd be fine using either snake_case or camelCase, as I use both frequently between Ruby and JavaScript respectively.

With the style guide, if there's a community sourced guide similar to the Ruby Style Guide, that would be preferable. I don't know of any currently, and the Google style guide was handily available (and I think is what OSV follows).

[joshbuker]

@kurtseifried, let's use Google's style guide as discussed, and if someone wants us to switch to something else, we can explore it further.