Restructuring and extending the CCSL static analysis tool for Java

Abstract

Kodekonvensjoner er avgjørende i programvareutvikling, for å etablere retningslinjer for skriving og organisering av kode innenfor et programmeringsspråk. De forsikrer lesbarhet, vedlikehold, og håndheving av ikke-funksjonelle egenskaper som sikkerhet og ytelse. Forvaltningen og håndhevelsen av disse konvensjonene er utfordrende på grunn av deres kompleksitet, konstante utvikling og typiske naturlige språkprepresentasjon som ikke er maskinlesbar. For å håndtere disse utfordringene har et tidligere prosjekt utviklet Coding Conventions Specification Language (CCSL), et domenespesifikt språk som tillater maskinlesbar spesifikasjon av Java-kodingsregler. Det gjensto imidlertid potensial for forbedring. Dette prosjektet tar sikte på å forbedre CCSL ved å introdusere en tilleggstekstsyntaks, Conventions Specification Language Textual (CCSLT), for å motvirke vanskelighetene med å tolke XML Metadata Interchange (XMI) filer av ikke-modelleringseksperter. Det første målet av CCSLT er å gi et mer intuitivt, brukervennlig og forståelig middel å uttrykke kodekonvensjoner. Det andre målet er å forbedre programvareutvidelsen for håndtering av CCSL og CCSLT for å forbedre brukerinteraksjonen ved å tilby integrert tilbakemelding om regelbrudd. I tillegg, for å lette overgangen til CCSLT, ble en konverter utviklet for å sikre etablerte kodingsregler fra CCSL kan bli konvertert til CCSLT. Til slutt, blir det eksempler på å lage CCSLT-regler og deres praktiske bruk, noe som oppmuntrer til bruk ved å redusere ekspertisen som kreves for regeloppretting, og forenkling av prosessen med å definere og håndheve kodekonvensjoner.

Coding conventions are vital in software development to establish guidelines for writing and organizing code within a programming language. Ensuring readability, maintainability, and enforcing non-functional properties such as security and performance. The management and enforcement of these conventions are challenging because of their complexity, constant evolution, and typical natural language presentation, which is not machine-readable. To address these challenges, a previous project developed the Coding Conventions Specification Language (CCSL), a domain-specific language (DSL) that allows machine-readable specifications of Java coding rules. However, there is potential for enhancement. This project aims to enhance CCSL by introducing an adjunct textual syntax, the Conventions Specification Language Textual (CCSLT), to counter the difficulties faced by non-modeling experts in interpreting XML Metadata Interchange (XMI) files. The first goal of CCSLT is to provide a more intuitive, user-friendly, and comprehensible means of expressing coding conventions. The second goal was to improve the plugin for handling CCSL and CCSLT to enhance user interaction by providing integrated feedback regarding rule violations. Additionally, to ease the transition to CCSLT, a converter was developed to ensure that the established coding rules from CCSL could be converted to CCSLT. Finally, examples of creating CCSLT rules and their practical use are provided, encouraging adoption by lowering the expertise required for rule creation and simplifying the process of defining and enforcing coding conventions.