sindresorhus/awesome-lint

Add support for ignoring blocks of the readme #54

jthegedus posted onGitHub

I am using all-contributors-cli which generates the contributors section oy my readme. The generated code throws this error:

Titles should use ' as a quote               link-title-style

I could move the contributors to it's own file, but I would like to keep it front and center in the readme.

If we could get ignores (preferably range ignores) <!-- awesome-lint-ignore-start --> like prettier then I could use awesome-lint alongside all-contributors.


posted by sindresorhus about 6 years ago

@issuehunt has funded $40.00 to this issue.


posted by IssueHuntBot about 6 years ago

Good news is that we have already used remark-lint, which introduced remark-message-control.

Bad news is that our ruleIds, i.e. awesome/badge, contain a slash, which is invalid as parameter. See mdast-comment-marker. So we can't specify ruleIds. Followings do not work.

<!--lint disable awesome/list-item-->
- [foo](https://foo.com) - an invalid description.

@sindresorhus @transitive-bullshit What if we rename ruleIds i.e. awesome-badge? It may affect something.

posted by chinesedfan about 6 years ago

I would rather fix remark's ability to recognize eslint-style rule names and keep our current rule naming convention than change our naming convention due to an unnecessary constraint within remark.

@wooorm what are your thoughts on allowing this style of lint rule naming within the remark / unified ecosystem?

posted by transitive-bullshit about 6 years ago

Message-control and comment-marker conform to HTML, it's like attributes, which I think makes sense for markdown. Note that we also use colons throughout the ecosystem. To differentiate between the 'source' (in this case awesome) and the ruled. That's the reasoning here, but feel free to open an issue!

posted by wooorm about 6 years ago
posted by chinesedfan about 6 years ago

I'm happy to switch to colons. The rule naming doesn't matter much and following the eslint-style rule naming is not import. @transitive-bullshit ?

posted by sindresorhus almost 6 years ago

Sounds good to me.

posted by transitive-bullshit almost 6 years ago

@sindresorhus has rewarded $36.00 to @chinesedfan. See it on IssueHunt

  • :moneybag: Total deposit: $40.00
  • :tada: Repository reward(0%): $0.00
  • :wrench: Service fee(10%): $4.00
posted by issuehunt-app[bot] over 5 years ago

Fund this Issue

$40.00
Rewarded

Rewarded pull request

Recent activities

chinesedfan was rewarded by sindresorhus for sindresorhus/awesome-lint# 54
over 5 years ago
chinesedfan submitted an output to  sindresorhus/ awesome-lint# 54
almost 6 years ago