[TCE-912] Integrating ruff in a codacy-ruff

[valeriupredoi]

Hi folks - @lolgab we meet again, my friend - at a different Codacy repo 😁 - I was suggesting to the Ruff guys to see if they can get their linter integrated with Codacy, see astral-sh/ruff#10458 - would this be something you guys would be OK with, and if so, are there any pointers on how to do this, apart from using this package here? Cheerios 🍺

[github-actions]

Internal ticket created : TCE-912

[mrfyda]

hi @valeriupredoi, thanks for reaching out.

this is something we'd very much be interested in! 👀

the documentation in this repo is the best place to start, but I can share that we usually follow this recipe:

1. create a wrapper for the tool and have its docker published following Codacy’s expected inputs and outputs
2. create a script to extract the documentation from the official tool and generate the tool documentation
3. write integration tests (as described in the multiple section of the test-runner repo) for the most common cases: running the tool without any configuration, running the tool with a configuration file, running the tool with configuration from the Codacy UI

keep in mind that in addition to Scala, we also have seeds for Typescript and Golang. you can use the one that is most convenient to you.

feel free to ping us in this thread if you need assistance.

[valeriupredoi]

hi @mrfyda - many thanks, mate! I'll have a looksee at your pointers soon, cheers 🍺

[valeriupredoi]

Back onto this, folks - I trust everyone had good summer breaks! I have started with asking Ruff folks about codac-ruff (so that we are all clear about who does what, so there are no conflicts/issues) astral-sh/ruff#13391 Am gonna wait to see what they say before I start moving earth 😁 🍺

[valeriupredoi]

Hi @mrfyda and the Codacy folks, got a few things to report and ask, please:

• as per Integration of Ruff in Codacy astral-sh/ruff#13391 and what the Ruff folks told me ie it'd be good if I went ahead and start working on a codacy-ruff app myself, I built such an app https://github.com/valeriupredoi/codacy-ruff
• that is built resembling closely the Prospector one https://github.com/codacy/codacy-prospector and it runs fine, and the Docker container builds well, and it runs fine (calls ruff check with JSON output, though I am not 100% sure the patternID has correct values)
• my app is currently lacking a few key items:
  • it's got no doc dir with autobuilt docs - those should be Ruff docs, unfortunately we only started using Ruff recently, and don't have the expertise to build Ruff docs
  • Circle tests: it's got one basic test module to unit test the functionality, but not any Circle tests

What is the best approach to get this wee app sandbox tested, then deployed with you guys? I can link up with the Ruff folks in the above mentioned issue and ask them to produce documentation for it, I should guess. Many thanks in advance 🍺

[heliocodacy]

Hello @valeriupredoi 👋

Thanks a lok. Our tools team will take a look and queue this to our roadmap.

Amazing work, btw!

[valeriupredoi]

wonderful, very many thanks @heliocodacy 🍺 Shall wait for your team, and we'll take it from there 👍

[valeriupredoi]

hi @heliocodacy you folks managed to find some time to look at my tool, by any chance? Cheers muchly 🍺

[heliocodacy]

Hello @valeriupredoi 👋

We've started, yes, and it's on our roadmap to implement (ideally this quarter).

Cheers!

[valeriupredoi]

jolly! excellent news, many thanks @heliocodacy 🍺