Add formatting test option

Question

Add formatting test option

brunocastroibarburu94 opened this issue a year ago · comments

brunocastroibarburu94 commented a year ago

I believe that JuliaFormatter can be used as part of the CICD pipeline of production code, we want to put a test indicating that the code submitted for a Merge Request satisfies a style guide.

Would it be possible to have a function that indicates if any file is going to be formatted and if it does it fails, or outputes the number of files that are going to be formatted without actually formatted. Ideally with links to the files and lines that may be affected by the automated formatting.

This is similar to what package black can do in Python.

Perhaps this is already out there but I coudn't find how to use JuliaFormatter or any other tool for that matter for this.

Cheers!

Dominique Luna · Answer 1 · Thu Jun 08 2023 01:28:53 GMT+0800 (China Standard Time)

there are some workflows already in a bunch of repos that do exactly this. Off the top of my head I think Trixi.jl folks have this setup

Dominique Luna · Answer 2 · Thu Jun 08 2023 01:29:08 GMT+0800 (China Standard Time)

also the SciML repos have this

brunocastroibarburu94 · Answer 3 · Thu Jun 08 2023 02:29:28 GMT+0800 (China Standard Time)

Superb, for future reference in case anyone else needs it I will leave the link to SciML workflow. Thanks @domluna!