-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Markdown linter #386
Add Markdown linter #386
Conversation
Codecov Report
@@ Coverage Diff @@
## main #386 +/- ##
=======================================
Coverage 49.28% 49.28%
=======================================
Files 114 114
Lines 5440 5440
=======================================
Hits 2681 2681
Misses 2323 2323
Partials 436 436 Continue to review full report at Codecov.
|
Please click the CLA button to sign our CLA. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A great start!
* Add more metrics by @AlekSi in https://github.com/FerretDB/FerretDB/pull/298 | ||
* Implement `$size` query operator by @taaraora in https://github.com/FerretDB/FerretDB/pull/296 | ||
|
||
* Support projections by @ekalinin in <https://github.com/FerretDB/FerretDB/pull/212> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is generated automatically: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
Is it possible to automatically fix it with --fix
flag? If not, can we skip it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Flag --fix
automatic fixing of some problems. But not everyone.
Without it, we will get a list of warnings for self-correction.
It is also possible to add configuration and disable some rules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you chnage this file manually, or --fix
did everything? If yes, great! If not, we should skip that file,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is changed automatically when flag --fix
We do not need to skip file, we can disable individual rules
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can configure according to our rules.
for example
# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
MD022:
# Blank lines above heading
lines_above: 1
# Blank lines below heading
lines_below: 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds useful, but what about those changes with URLs (added <
and >
)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now this rule is disabled in the configuration
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! |
Closes #64.