[Upgrade] Exclude-like flag

Sigmanificient commented 1 year ago

Prerequisites

[x] I check that an issue does not already exists for the request I'd like.

Upgrade's location

The upgrade concerns the file(s) named ... coding-style.sh, coding-style.ps1

Upgrade's motivation

Every time you want to run the code style checker, you have to run make fclean to make sure the rule O-1 does not create an ouput that is hard to read. When using larger an larger code-bases, this force the user to recompile code that might take some time to compile and could be easily avoided. Yes it is possible to use grep to hide those but having a exclude-like flag wouldbe a qol for many students.

Upgrade's description

The flag would work by simply exluding targeted file/directory from the checker.

Example:

coding-style.sh repo logs --exclude repo/build repo/my_binary

Upgrade's type

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Xephi commented 1 year ago

The main purpose of this project is to allow you to test coding style against a delivery like directory. Automated Tests won't exclude these files.

Sigmanificient commented 1 year ago

The main purpose of this project is to allow you to test coding style against a delivery like directory. Automated Tests won't exclude these files.

Since delivery are github repository, .gitginore ensure that they wont be committed anyway. But unfortunately, this config isn't supported by the script, so this is why, i believe, some kind of way to add exclusion makes sense, if left to the user hand.

It is also pretty obvious that since this is a flag that the user have to manually set, he would be fully aware of the possible risk of having a file he excluded be caught by the automated tests. Adding the feature is transparent as it is optional, and the possible problems that it could lead to are fully in the user-responsibility.

I want also add that some student like myself already use they own script, just to have those kind of features, and even more, so they already going against that idea of having the perfect replica of the Automated tests.

Well i guess you still have the last word anyway.

Xephi commented 1 year ago

I let this issue open. Hopefully someone will have the time to provide a PR for this

Epitech / coding-style-checker