Comments (4)
The Ruby implementation added three rules for tables recently and what you see are the placeholders I added. You can read more at the bottom here: https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md. They immediately got issues which have not been addressed as far as I know.
What you propose here is likely to be a very big undertaking. Someone else recently added a rule and I spent about a week reviewing and two weeks polishing, so anything here isn't going to make the current release.
Please read the contributing guidelines first so you know what's expected. For things that rely on a parser, please use the micromark tokens as that's the new direction. Adhere to the GFM standard for table syntax. I'll warn you that I will be very picky on the review.
One consideration is whether this should be one overall rule or multiple individual rules. Historically, specific individual rules has been the practice. If you are implementing an identical rule, please use the same name and number. Otherwise, please take the next consecutive number.
I'll want very good test coverage to try to avoid surprises. I anticipate a lot of edge cases here.
from markdownlint.
Thanks for the info, I did not realize this linked to the ruby implementation.
They immediately got issues which have not been addressed as far as I know.
Could you please add MD055, MD056 and MD057 to the respective issue title? This would make searching for them easier.
I think MD55 corresponds to #93 and MD056 to #92.
My work so far was based on the GFM standard, so I should be able to reuse that.
I wasn't sure whether to make individual rules or one for table formatting, but that clears it up,
I'll split into MD055, MD056 and make #132 MD058 then.
Understandable, please do address any issues, I'll run my code against our codebase, too.
Some edge cases are already filtered out by the parser, anything not recognized as a table won't make it to the rule. For the rest, I'll try to add extensive tests.
from markdownlint.
I'll update the issue titles later today. But wanted to emphasize the last thing you said which is that sticking to scenarios the parser recognizes will make things much easier. Rules that try to infer intent outside of what parses successfully tend to be very tricky to get right.
from markdownlint.
Related Issues (20)
- MD007 when MD010 disabled HOT 5
- MD040: Add disallowed_languages HOT 2
- MD051 false positives for section titles with image in them HOT 2
- How to configure MD012 HOT 3
- Provide custom rules with other rule configurations HOT 2
- MD036 triggered right before a header HOT 1
- Set global defaults HOT 1
- [DEP0040] DeprecationWarning - punycode module is deprecated HOT 7
- False positive with link-image-style rule (MD054) and `{ url_inline: false }` HOT 2
- MD003 "consistent" doesn't allow "setext_with_atx" HOT 3
- MD049, MD050 conflicts with functional differences between underscores and asterisks HOT 5
- IntelliJ plugin HOT 1
- endlessschoes08
- MD030: incorrectly firing inside HTML comments that end with `--->` after switch to micromark HOT 3
- (MD033 - Inline HTML)
- SRockt HOT 1
- Ignore long lines in HTML comments HOT 3
- MD044: Proper name matched in Hugo-style relref links HOT 7
- MD025 Multiple top-level headings with`title` frontmatter HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markdownlint.