Voeg naming-conventions toe aan standaard #158
Conversation
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
added
Scope: Klein
Hiermee zorgen we ervoor dat een API wel een standaard afkorting mag gebruiken, maar dat ook voor een leek duidelijk is op basis van de documentatie waar die afkorting voor staat.
|
@bwbroersma FYI dit is de wijziging wat betreft naming conventions |
|
@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 |
Zodat enkele letters aan het einde van een naam ook zijn toegestaan.
|
@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 |
Great! Counter example of the new regex |
De regex is als voorbeeld bedoeld en kan niet alle edge cases af vangen waar semantisch wel of niet camelCase moet worden toegepast. Om verwarring te voorkomen is de regex permissive en wordt er vanuit gegaan dat bij een code review gekeken wordt of de intentie van camelCase correct wordt nageleefd.
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).