davidvarga / davidvarga/MBeautifier

Use tool to block PR in a CI/CD pipeline

Open
#131 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MATLAB
Stars
519
Forks
80
PR merge metrics
No merged PRs in 30d

Description

I would like to use this tool in a CI/CD pipeline.
Specifically, I would like to block a Pull Request if there are any formatting violations.
For this purpose I would like to request a feature.
The feature requirements would be:

1. A function accepting a single string argument: path to a directory (e.g. `isConsistentWithFormatStyle(pathToDirectory)`)
2. The function inspects each M-file in the given directory (and recursively in each sub-directory)
3. The function returns a boolean (true if the formatting style is adhered to, false if the formatting style is violated).
4. Optionally (for bonus points): the function returns a list of violations.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing MATLAB formatting entry point and how it processes individual M-files. Determine where recursive directory traversal and a boolean result could fit, then check whether existing tests cover formatting violations. Done means a directory and its subdirectories can be checked for formatting, with a true or false result; violation details are optional.

Written by the indexing model from the issue text.

Assessment

Tech stack
matlab
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.