Voeg naming-conventions toe aan standaard

[TimvdLippe]

De naming-conventions zijn ontwikkeld als onderdeel van
het kennisplatform APIs als aparte module. Deze commit
integreert de conventions in de standaard als rules
om overhead te voorkomen en alle rules verplicht te
maken (in tegenstelling tot een module die niet altijd
nodig is).

[TimvdLippe]

Preview is te zien op https://logius-standaarden.github.io/Publicatie-Preview/API-Design-Rules/pr/timvdlippe/naming-conventions/

[TimvdLippe]

@bwbroersma FYI dit is de wijziging wat betreft naming conventions

[bwbroersma]

@TimvdLippe: Is this for the current version 2.0.x that is in procedure at the Netherlands Standardisation Forum, or a later 2.1.x version?

BTW ^[a-z0-9]+([A-Z][a-z0-9]+)*$ does allow single letter first parts, but not single letter in later (uppercased) parts, so aLabel is allowed, while labelA is not. Maybe only a lower case first letter can be enforced, so e.g. ^[a-z0-9]+[A-Za-z0-9]*$.

[TimvdLippe]

@bwbroersma This is for a future version of ADR, unrelated to the ongoing 2.0.x procedure.

Yes good point. I wanted to be clear about multiple consecutive uppercase characters which aren't allowed in camelCase. I updated the regex to handle that edge case. You can test it out here: https://regex101.com/r/7nmJmc/2

[bwbroersma]

Unrelated to the ongoing 2.0.x procedure.

Great!

Counter example of the new regex ^[a-z0-9]+([A-Z][a-z0-9]+)*([A-Z])?$ is labelACount, single letter parts are allowed at the start and end, but not in the middle (you can think of 'A' of energy efficiency, nutrition, letter grading, etc.).

[TimvdLippe]

De huidige linter (toegevoegd in #174) vereist kebab-case al voor paths. Voor query keys kunnen we nog een validatie schrijven. De afkortingen regel is niet te automatiseren helaas, maar zou manueel moeten worden gecheckt.

[github-actions]

Preview link voor pull request
Diff met W3CDiff