GithubHelp home page GithubHelp logo

Comments (4)

DavidAnson avatar DavidAnson commented on July 19, 2024

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.

gabriel-check24 avatar gabriel-check24 commented on July 19, 2024

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.

DavidAnson avatar DavidAnson commented on July 19, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.