search

JuliaRheology / RHEOS.jl

RHEOS - Open Source Rheology data analysis software
MIT License
40 stars 9 forks source link

Consider adding linter/formatter action for consistent code style #89

Open moustachio-belvedere opened 4 years ago

moustachio-belvedere commented 4 years ago

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 commented 3 years ago

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

akabla commented 3 years ago

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