Decidim: More flexible settings for Markdownlint

Created on 24 Nov 2018  路  4Comments  路  Source: decidim/decidim

Is your feature request related to a problem? Please describe.
I would like to appoint 2 problems:

  1. While markdown has a very flexible syntax that accepts may variants, as you may have found, Markdownlint rules are getting stricter and stricter. Resulting in having an only one way to write markdown.

We've arrived to a point that by applying Markdonlint's dictated rules (and ironically being 100%) compliant markdown files have become hard to read. Mainly because how the new "max 80 chars per line" rule has been implemented.

Now when one navigates over the files it is really hard to read.

2) We loose a lot of resources (developers' time and ci resources) because of silly breaking of linter rules. I don't think it's worth it having so many rules.

Describe the solution you'd like
I would prefer to stay with more flexible rules, but have perfectly readable documents.

When new rules apply that require refactoring all documents it may be worth thinking a little bit what's the rule adding to the formatting of documents and deciding if it's better to disable it.
(for example, most people use "-" for markdown lists, it is stupid to have to use "*" just because the author of the linter has set this rule)(the same for forcing 80chars per line, etc.)

Describe alternatives you've considered

Additional context

Does this issue could impact on users private data?
No

wontfix

Most helpful comment

Hello linter guy :wave: :wave: :smile:
I did not saw your answer :(
I'll look for some time to check the configuration!

All 4 comments

It turns out that the new "max 80 chars per line" rule has been correctly applied but as I have a "big" font now texts have unexpected new line breaks:

image

This was not happening before this rule existed

Linter guy here taking the chance to say hello to everyone! :wave: :wave: :smiley:

When I added the markdown linter, I explicitly disabled the line length check. So, I'm not sure where your problem lies, but it's not intentional. Maybe the problem is that codeclimate is not applying our configuration :man_shrugging:.

Regarding the markdown list bullet style, I have absolutely no idea about which style is more common but I wouldn't say enforcing the default linter style is stupid just because I don't like it or because I think it's less common. In any case, the author of the linter does not even seem to have an opinion here because markdownlint only enforces per document consistency by default. For example, decidim uses dashes in some documents.

If you think it's better to enforce dashes everywhere, you can propose and justify changing the configuration. You even have a well known style guide in your favor!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. @carolromero & @xabier feel free to chime in.

Hello linter guy :wave: :wave: :smile:
I did not saw your answer :(
I'll look for some time to check the configuration!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

carolromero picture carolromero  路  3Comments

Xfolchf picture Xfolchf  路  3Comments

josanFFiG picture josanFFiG  路  3Comments

andreslucena picture andreslucena  路  4Comments

xabier picture xabier  路  5Comments