minder icon indicating copy to clipboard operation
minder copied to clipboard

Add consisent output for `mindev lint`

Open JAORMX opened this issue 2 years ago • 10 comments

Please describe the enhancement

mindev lint was done so we could quickly get some linting for minder rule types. However, not much thought was put on how these lint results would be displayed. It would be ideal to have a consistent output, or even configurable output types.

Solution Proposal

Let's have a standard table output (to start) for mindev lint. This should match and be consistent with the table that's currently used in minder itself.

Describe alternatives you've considered

No response

Additional context

No response

Acceptance Criteria

No response

JAORMX avatar Dec 20 '23 10:12 JAORMX

@JAORMX I want to start contributing to this project. Can I work on this issue? I have prior knowledge of GO and Docker. If you can guide through it than it will be very helpful.

Harsh4902 avatar Dec 21 '23 07:12 Harsh4902

@Harsh4902 of course! Thanks a lot for volunteering for this.

JAORMX avatar Dec 21 '23 07:12 JAORMX

@Harsh4902 the mindev source code is under /cmd/dev ( https://github.com/stacklok/minder/tree/main/cmd/dev ).

you probably want to start by building it via make build (this builds all the binaries, but they're fairly quick to build).

JAORMX avatar Dec 21 '23 07:12 JAORMX

Subsequently, the mindev lint piece is here: https://github.com/stacklok/minder/blob/main/cmd/dev/app/rule_type/lint.go

JAORMX avatar Dec 21 '23 07:12 JAORMX

you'd want to test mindev lint with some rules, so you'll need to fetch the examples. For that, you can do make init-examples which will clone the minder-rules-and-profiles under examples/rules-and-profiles, you'll find rules to test with under examples/rules-and-profiles/rule-types/github

JAORMX avatar Dec 21 '23 08:12 JAORMX

Let me know if you have any questions. I'm also logged in our Discord under the name Ozz.

JAORMX avatar Dec 21 '23 08:12 JAORMX

@JAORMX Thank you for guidance. I'm starting with this and if I have any questions, I'll ask.

Harsh4902 avatar Dec 21 '23 08:12 Harsh4902

@Harsh4902 do you need any help on this one?

JAORMX avatar Feb 07 '24 09:02 JAORMX

@JAORMX Sorry, I was not able to work on this due exams and all. I will get back to after couple of days.

Harsh4902 avatar Feb 07 '24 11:02 Harsh4902

Removing @Harsh4902 since there was no update since Feb, 7th.

rdimitrov avatar Oct 08 '24 13:10 rdimitrov

We'll do this if it causes us pain, but we probably won't go back to look for this.

evankanderson avatar Jan 28 '25 14:01 evankanderson