Skip to content

[nodes] Change or stop forcing camelCasing for unique names #369

@lorisleiva

Description

@lorisleiva

This is a proposal that needs further discussion before implementing.


When designing the Codama standard, we needed to agree on a string casing for named nodes in order to compare them by names and went with camelCase to match the casing of node attributes.

The slight issue with camelCase is that it contains slightly less information than other casing such as Title Case or snake_case mainly due to number positioning. For instance, with snake_case we can define something like token_2022_3rd_edition without any ambiguity on the numbers 2022 and 3. On the other hand, camelCase cannot keep up with this distinction as it results in token20223rdEdition which re-snake_cased would give you token20223rd_edition.

The bottom line is, casings with explicit separators like snake_case keep more information than casing like camelCase and thus, using the former instead of the latter as a naming convention might make more sense.

This is a breaking change on the standard itself and would need to be a major version bump.

Metadata

Metadata

Assignees

No one assigned

    Labels

    proposalSuggesting a change / new featurev2Something to look into when updating the Codama standard to v2

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions