Skip to content

Conversation

@despairblue
Copy link
Contributor

fix #60

@wooorm
Copy link
Member

wooorm commented May 18, 2016

Looks clean, simple, and good! Was there anything you struggled with, or other suggestions for this project?

@despairblue
Copy link
Contributor Author

Nope. Your comment told me what rule is responsible for that test. After that it was just

  1. finding the correct file (easy because the file names are the rule names)
  2. finding the the part that creates the warning
  3. understanding a little bit more about the file (very clean, understandable code 👍 )
  4. changing the output.

So maybe the linter could prepend error/warning with the rule's name (like eslint does). I'm not sure if it already does that in a terminal, I only interacted with it through Atom.

@wooorm
Copy link
Member

wooorm commented May 18, 2016

Great, thanks for the feedback!

What you’re talking about is called a ruleId (both in ESLint and in VFile’s, which are used here), and those are populated by the main remark-lint library. The standard reporter displays those at the end of a message.

As you’re using Atom, displaying the ruleId should be enabled in that library. If you’re using linter-markdown, it should be supported already, though. If not, please raise an issue. Or, if using another library, raise an issue over there.

Does that help?

@despairblue
Copy link
Contributor Author

You're right, I must have overseen it. My bad. Then everything is alright from my side.

@despairblue
Copy link
Contributor Author

On another note, why is it necessary that lists containing wrapped items must be loose? That adds a p and br tags to each item in that list and thus changes the rendering, at least the github renderer does it.

This seems to make it impossible to have a free flowing list item while still adhering to the 80 character line limit.

Example

  • Wrapped item Dolor quas fugiat saepe qui. Aperiam eveniet autem ab et ab
    temporibus vero quo. Dolor quas fugiat saepe qui. Aperiam eveniet autem ab
    et ab temporibus vero quo.
  • item 2
  • item 3

  • Wrapped item Dolor quas fugiat saepe qui. Aperiam eveniet autem ab et ab
    temporibus vero quo. Dolor quas fugiat saepe qui. Aperiam eveniet autem ab
    et ab temporibus vero quo.
  • item 2
  • item 3

@wooorm
Copy link
Member

wooorm commented May 21, 2016

Yes, that’s right. It’s from the markdown-style-guide, which is the source of inspiration and rules for this library. I personally prefer it too, as it makes reading the source easier, although indeed rendering on GitHub is less beautiful.

Note that you can always turn it off!

@wooorm wooorm closed this in d562d6e Jun 6, 2016
@wooorm
Copy link
Member

wooorm commented Jun 6, 2016

Thanks @despairblue for working on this! 👍

@wooorm wooorm added ⛵️ status/released 🐛 type/bug This is a problem 👶 semver/patch This is a backwards-compatible fix 🗄 area/interface This affects the public interface labels Aug 15, 2019
@wooorm wooorm added the 💪 phase/solved Post is done label Aug 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🗄 area/interface This affects the public interface 💪 phase/solved Post is done 👶 semver/patch This is a backwards-compatible fix 🐛 type/bug This is a problem

Development

Successfully merging this pull request may close these issues.

Clarify list-item-spacing message

2 participants