The Clean Code and Design Educational Tool (Clean CaDET) is a platform dedicated to the study of clean code. It presents a conglomerate of AI-powered tools for educators, learners, practitioners, and researchers studying clean code. The repository for the platform with which this plugin interacts can be found here.
This repository hosts the code for the Visual Studio plugin capable of interacting with the platform, enabling the following use cases:
- Studying clean code challenges, where the learner loads a predefined C# project focused around some aspect of clean code (e.g., meaningful names, focused methods) and is tasked with refactoring the code in some way. How our platform resolves these challenge submissions is described here.
- Analyzing a project's code quality, where an engineering can submit any C# project (or some subset, such as a folder or class) to the platform for analysis. The platform detects code issues using AI detectors, and selects appropriate learning objects to display to the engineer and help them resolve the identified issues. This data flow is described in more detail here.
This plugin is used to access educational content and send challenge solutions to the Clean CaDET platform. Users need to connect to an existing platform or setup a local instance of it.
To setup the platform:
- Download the platform and setup its database of initial educational content.
This extension contributes the following settings:
platform.tutorUrl: Specifies the base URL for the Smart Tutor endpoints.
Initial release of plugin used for a controlled experiment with university students.