search

robotpy / robotpy-wpilib

Moved to https://github.com/robotpy/mostrobotpy
https://robotpy.github.io
Other
169 stars 59 forks source link

Add code formatters & linters #720

Closed jack60612 closed 10 months ago

jack60612 commented 1 year ago

Added black (code formatter), isort (import formatter) and flake8 a pep8 abiding code linter Also added gh actions workflows for everything above

jack60612 commented 1 year ago

@virtuald where would you want me to put the information on how to use the formatters & linters?

auscompgeek commented 1 year ago

We already run black in CI?

jack60612 commented 1 year ago

We already run black in CI?

oops, I must have missed it.

jack60612 commented 1 year ago

We already run black in CI?

oops, I must have missed it.

~Wait, why did it reformat things then?~ Line length.

jack60612 commented 1 year ago

What should i use as the standardize

We already run black in CI?

oops, I must have missed it.

~Wait, why did it reformat things then?~ Line length.

I set the line length to 120 because it seemed like that was what was being used, but i can change that back to 88 if thats whats wanted.

kaechele commented 1 year ago

Would it make sense to use pre-commit to front-load any formatting changes? Only being able to commit formatted code improves legibility of diffs commit to commit.

jack60612 commented 1 year ago

oops, i got distracted by the season, ill look at this again.

virtuald commented 1 year ago

Would it make sense to use pre-commit to front-load any formatting changes? Only being able to commit formatted code improves legibility of diffs commit to commit.

Just enable format on save in your editor?

kaechele commented 1 year ago

Just enable format on save in your editor?

I think that's pretty standard nowadays.

What I was suggesting is different from that though. Using pre-commit can help enforce repository-wide linting and style rules for all future contributions and allows contributors to catch any linting or formatting errors upon committing code locally and before they are pushed and subsequently fail in CI. Since the pre-commit hooks are installed by each contributor after checking out the repository people can choose whether they'd like that convenience or not. Configuring the linting and style rules for this purpose also creates explicit guidelines of how the project expects code to be formatted.

virtuald commented 10 months ago

If you want to go down this path again, we've moved everything to the mostwpilib repository.