CodeInspector: Automating Custom Code Validation

Hi everyone,

In this article, I’m excited to introduce CodeInspector, a tool designed to simplify code validation by applying custom rules tailored to your development requirements. Whether you're managing a large codebase or working in an agile environment, CodeInspector helps ensure code quality by offering flexibility and adaptability to specific project needs.

Motivation

The idea behind CodeInspector was to build a tool that is both easy to implement and adaptable to different business contexts. By allowing teams to define their own validation rules, CodeInspector empowers developers to meet specific code quality standards without sacrificing flexibility. Its simplicity ensures that any team member can quickly configure and start using the tool to enforce consistent coding practices.

Features

• Package and Class Validation: CodeInspector analyzes and validates packages and classes based on predefined custom rules.
• Detailed Reports: It generates comprehensive issue reports that can be viewed directly in the console or returned as structured JSON for further processing.

First Steps

1. Installation: The tool is available on the InterSystems Open Exchange as CodeInspector.
2. Running the Application: Follow the instructions in the README file to build and start the Docker container. The application runs seamlessly inside a Docker container.
3. Sample and Rules:
   • In the project folder, you'll find a sample directory with an example class.
   • Additionally, in the codeInspector.rules.examples folder, you’ll find two example validation rules:
     • Example Rule 1: Validates if a class does not exist in the environment.
     • Example Rule 2: Validates if a method exceeds 50 lines of code.
4. Postman Project: The Postman collection for testing the API has been added to the /iris-dev-codeinspector/collectionPostman/CodeInspector.postman_collection.json folder.

Rest API - CodeInspector JSON Report

API Parameters

The API is available at http://localhost:9091/codeinspector/ and accepts the following parameters:

• namespace: (required) Specifies the namespace in which the validation will be executed.
• packages: (required) This parameter must include the names of the packages to be analyzed, separated by commas.
• ignored: Allows you to provide a comma-separated list of package names to be excluded from the validation process.

Postman Collection

You can find the Postman Collection export in the /iris-dev-codeinspector/collectionPostman/ folder. Import CodeInspector.postman_collection.json into Postman to run API tests.

Console Report

To run a validation check from the console, open a terminal and execute:

Do ##class(codeInspector.Main).Execute("sample")

This will trigger the sample validation against the specified class and display the results in the console.

Thank you for exploring CodeInspector. At the end of the README document, you’ll find some ideas for future improvements, and I’m always open to new suggestions. I look forward to your feedback and any contributions you’d like to make!