Precommit: formatting and creation of notebooks/markdown #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Mar 26, 2024
APJansen
force-pushed
the
precommit
branch
5 times, most recently
from
90051e0 to
9815494
Compare
|
I had to run the formatter in the CI manually as well (i.e. without using the official action), but now it works fine. here is an example of what you see on failed formatting: all the changes it made. |
|
I rebased this on main and squashed everything. The only thing that's not working is that it considers also the files in examples/coupling_functions as notebooks, but that's probably best fixed in a separate PR changing the file structure. |
|
sorry one sec, didn't actually rebase on latest main. |
SCiarella
approved these changes
Mar 26, 2024
|
Can you both check if you can set up pre-commit following the instructions in CONTRIBUTING.md, and if when you run |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds precommit hooks for
JuliaFormatterand notebook creation, as well as a check on the formatting in the CI.See here for instructions on how to set it up.
JuliaFormatter hook
I have used the "official"
JuliaFormatterhook following this.It is not as nice as what I'm used to in python with black, in that a. it checks all files rather than only those that have been modified, and b. it doesn't list the files it had to format.
Not a big issue, as long as everyone uses it the only files that it has to modify should be ones you changed, and if you want to see exactly which, you can just do a
git status.notebooks hook
I didn't find any existing hook for this, so I created one that just calls the julia script (changing the the overwrite setting to true). It seems to work fine for me.
JuliaFormatter CI
Here I also used the official one. It seems overly complicated to me, going through some code checker service reviewdog. Also it doesn't seem to be working, in that it passed on this PR before I applied any formatting.
Remaining issues