Add pre-commit hooks #688
Add pre-commit hooks #688
Conversation
| - [ ] Update dates and make sure HackMD information is correct. | ||
| - [ ] Team members add agenda items. | ||
|
|
||
| - \[ \] Update dates and make sure HackMD information is correct. |
docs/feature-vote.md
Outdated
| # Feature voting board | ||
|
|
||
| You can help us to prioritise development of new features by leaving a [👍 reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) on the first comment of any `enhancement` issue. | ||
|
|
||
| Below is a list of all current enhancement issues from our core repositories,[^a] ordered by 👍 | ||
| Below is a list of all current enhancement issues from our core repositories,\[^a\] ordered by 👍 |
There was a problem hiding this comment.
argh - hmm what should we do about these? add exceptions in the mdformat config or something? If this is gonna cause headaches like this then I'd vote we just don't use mdformat 🤷
| @@ -1,10 +1,6 @@ | |||
| --- | |||
.pre-commit-config.yaml
Outdated
| - repo: https://github.com/executablebooks/mdformat | ||
| rev: 0.7.13 | ||
| hooks: | ||
| - id: mdformat |
There was a problem hiding this comment.
yeh so you need to use this with plugins 😉 e.g.
There was a problem hiding this comment.
ahh ok, I will try to give that a shot
There was a problem hiding this comment.
ahhhh, ok I will take a look and figure it out
There was a problem hiding this comment.
Meaning to circle back to mdformat-myst at some point and do some more testing/improvements.
Would be nice to advertise it on jupyter-book (but only when I'm certain it is properly working)
docs/index.md
Outdated
| @@ -7,54 +7,54 @@ computational narratives using the Jupyter ecosystem. | |||
|
|
|||
| We are the community behind [Jupyter Book](https://jupyterbook.org)--an open source project for building beautiful, publication-quality books and documents from computational material--as well as [MyST Markdown](https://myst-parser.readthedocs.io/en/latest/)--a rich and extensible flavor of Markdown meant for technical documentation and publishing. | |||
|
|
|||
| ::::{grid} 1 2 2 2 | |||
| ::::\{grid} 1 2 2 2 | |||
There was a problem hiding this comment.
I updated the PR to add those plugins to our hook.
Hmm - looks like it is not picking up the colon fence syntax, is there a way to tell the pre-commit hook to re-use the same plugins that are enabled in conf.py?
There was a problem hiding this comment.
executablebooks/mdformat-myst#13 and executablebooks/mdformat-myst#9
But no, not presently 😢
There was a problem hiding this comment.
ah bummer - ok I'll just comment out the lines about mdformat and we can re-enable if/when there is support for extra myst extensions.
|
OK latest commit comments out the mdformat hook, so we're just doing some basic code and file standardization stuff here |
|
closing this one as there are some conflicts and I don't have time to get it over the finish line |
This just adds a few pre-commit hooks and runs them. The biggest change is probably
mdformat- seems reasonable just to standardize our markdown structure, but I don't have a strong opinion if others don't want to use that.