Technologie
Houd de code uniform met CodeMaid
Snel sorteren, reorganiseren en navigeren van codebases
Als developers willen we ons werk zo efficiënt, overzichtelijk en eenvoudig mogelijk maken. Veel processen en handelingen automatiseren we zelf, maar voor een groot aantal standaard handelingen heeft het natuurlijk weinig zin zelf opnieuw het wiel uit te vinden. Binnen Garansys helpt CodeMaid ons hierbij.
CodeMaid is een open source extensie voor Visual Studio, onze ontwikkelomgeving van voorkeur. CodeMaid helpt de developer met het uit handen nemen van een aantal standaard zaken waar tijdens development rekening mee gehouden moet worden. Zo kan het helpen met het snel sorteren, reorganiseren en navigeren van de codebases waarin wij werken. Ook ruimt het volgens zelf geconfigureerde regels de code (automatisch) op. Zo kan de developer zich focussen op hetgeen waar deze het beste in is: nieuwe functionaliteiten ontwerpen en bouwen voor onze klanten.
Bij het opstarten of in beheer nemen van een project, stellen we voor het gehele project in hoe volgens ons de structuur van de code moet zijn. Denk hierbij aan het sorteren van imports, in welke volgorde de verschillende componenten van een klasse zouden moeten staan, hoe commentaar eruit zou moeten zien, waar witregels en whitespaces zouden moeten staan en waar juist niet, enzovoort…
In te richten valt dat, wanneer een file wordt opgeslagen, deze automatisch geformatteerd wordt door CodeMaid. Deze setting zorgt ervoor dat alle nieuwe code en gewijzigde code dus geformatteerd wordt naar de gevoerde standaarden. Ook bestaat de optie om alle files uit een codebase in één keer te formatteren. Deze operatie duurt extreem lang en de Pull Request welke eruit volgt is waarschijnlijk onbeheersbaar, dus dat valt niet aan te raden.
Alle developers van Garansys gebruiken Codemaid met dezelfde instellingen en configuratie, waarmee deze opgestelde regels bij het bewerken van een bestand automatisch worden toegepast. Zo zorgen we ervoor dat de uniformiteit van de code zo hoog mogelijk blijft, ondanks de verschillende stijlen welke verschillende developers met zich meebrengen. Dat is niet alleen prettig voor de developers die op dat moment aan een project werken, maar ook voor de developers zie jaren later met de code te maken krijgen.
Doordat we over alle projecten onze standaard Garansys configuratie kunnen inrichten, zorgen we er ook voor dat iedereen snel op een willekeurig project kan instappen. Zo kunnen we sneller schakelen en onze klanten nog beter en sneller van dienst zijn.
Meer weten? Neem contact op.
Patrick Severijns
Business Unit Manager
06-51150885
p.severijns@garansys.nl