RHEOS.jl icon indicating copy to clipboard operation
RHEOS.jl copied to clipboard

Consider adding linter/formatter action for consistent code style

Open moustachio-belvedere opened this issue 4 years ago • 2 comments

We may want to consider adding this Github linter action once Julia formatting becomes available, to increase the style consistency of the repo:

https://github.blog/2020-06-18-introducing-github-super-linter-one-linter-to-rule-them-all/

Could be part of the longer term plan to move docs building to Github actions.

moustachio-belvedere avatar Jun 18 '20 21:06 moustachio-belvedere

Adding some links here in case any others want to play around with this.

Link below seems like a pretty useful GitHub action which creates a PR for suggested formatting code changed automatically:

https://github.com/julia-vscode/DocumentFormat.jl/blob/master/.github/workflows/jlpkgbutler-codeformat-pr-workflow.yml

Though the most popular Julia formatter (by github stars) appears to be this one:

https://github.com/domluna/JuliaFormatter.jl

I'm also experimenting with this linter:

https://github.com/julia-vscode/StaticLint.jl

moustachio-belvedere avatar Jan 04 '21 18:01 moustachio-belvedere

@moustachio-belvedere I like JuliaFormatter.jl. Could be useful, especially with the Vim plugin!

akabla avatar Aug 18 '21 21:08 akabla