Replies: 3 comments 4 replies
-
Also the |
Beta Was this translation helpful? Give feedback.
-
Those things seem like perfectly reasonable things for Totally up to you though. The other |
Beta Was this translation helpful? Give feedback.
-
Linters are supposed to make your life and that of future developers easier... in the long term. So if this is a nuisance, just scrap that check entirely or use the other tool you mention. Having said that, after reviewing the documentation I have the feeling you are mixing two things in this repo:
The second is excellent - to be honest, it is really, really good! - but I don't think it should be part of this repo as it does not relate to Virtual Rainforest. What I would do is to separate that and put it into another repo on training material only - public, so everyone can benefit from it - and leave in this only the stuff directly related to the Virtual Rainforest. You can then tweak the linters appropriately for both repos, probably more loose for the training one. |
Beta Was this translation helpful? Give feedback.
-
I have real reservations about having
markdownlint
in ourpre-commit
. We will have quite a variety of Markdown documents in our repo: plain markdown, but also Jupyter notebooks in Myst markdown (which might additionally be structured as slides, for example). Basically, I'm fighting it, rather than doing work:markdownlint
Me
So, the current
pre-commit
hook tool (using the original Ruby implementation:markdownlint/markdownlint
) is throwing errors that I want to ignore but it does not seem to be configurable at a line by line level in the same way that other tools are. You can create style files but you have to tellmarkdownlint
to use it explicitly and I think these rule exceptions should be case by case, not global.There is another derived implementation using Node.js at
DavidAnson/markdownlint
that seems to be popular and widely adopted. It supports these line by line rules:That seems preferable to me - the downside is that it uses Node.js, but is swapping a Ruby developer requirement for Node.JS a problem?
Beta Was this translation helpful? Give feedback.
All reactions