Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

configure markdown lint #522

Merged
merged 5 commits into from
Mar 21, 2022
Merged

Conversation

BillWagner
Copy link
Member

First configuration of markdown lint. We can determine which warnings we want to enable or disable from a first test run.

We can adjust what's reported by adding items from the markdown lint rules.

First configuration of markdown lint. We can determine which warnings we want to enable or disable from a first test run.
@BillWagner BillWagner requested a review from jskeet March 18, 2022 20:24
@BillWagner BillWagner marked this pull request as draft March 18, 2022 20:24
- Disable long line lengths. (We use hard breaks for paragraphs)
- Disable inline HTML.
@BillWagner
Copy link
Member Author

@jskeet Here's a PR that turns on markdown lint in our repo.

Over time, it's probably a good idea to have it on with most warnings enable. I already turned off 2 by design:

  • Warning on inline HTML
  • Warning on long lines

We use both of those intentionally.

Take a look at the warnings. See which ones are most helpful to get our markdown source to work well with the word converter.

Then, we can figure out a plan.

jskeet
jskeet previously approved these changes Mar 19, 2022
Copy link
Contributor

@jskeet jskeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the current warnings look good to me - thanks!

@BillWagner
Copy link
Member Author

@jskeet

I'm think of this as a plan:

  • I'll update this PR to disable every current warning (due to the noise).
  • Once this is merged, I'll make PRs to re-enable each warning (or a set) and resolve each of those warnings.

@jskeet
Copy link
Contributor

jskeet commented Mar 19, 2022

Works for me :)

A couple note on this commit:

MD034 is for "raw URL link". The standard contains the link to the ECMA site, which is intentional. If it helps the word converter, that can be formatted using markdown's `[]()` syntax.

MD30 and MD31 will be the two biggest jobs.

Also, some of the warnings are generated from the markdown source in the test project. I think the right move will be to update those test sources once the associated rules are enabled.
@BillWagner BillWagner marked this pull request as ready for review March 19, 2022 18:34
@BillWagner BillWagner dismissed jskeet’s stale review March 19, 2022 18:35

I want to verify a couple assumptions.

@BillWagner
Copy link
Member Author

@jskeet This is ready for final review. I want you to take a look because of some of rules changes:

A couple note on the 4th commit:

MD034 is for "raw URL link". The standard contains the link to the ECMA site, which is intentional. If it helps the word converter, that can be formatted using markdown's []() syntax.

MD30 and MD31 will be the two biggest jobs.

Also, some of the warnings are generated from the markdown source in the test project. I think the right move will be to update those test sources once the associated rules are enabled.

@jskeet
Copy link
Contributor

jskeet commented Mar 19, 2022

I'll look at this on Monday if that's okay - my weekend is pretty busy.

Copy link
Contributor

@jskeet jskeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, this feels like a good approach to me.

@BillWagner BillWagner merged commit 30a22fd into dotnet:draft-v6 Mar 21, 2022
@BillWagner BillWagner deleted the run-markdown-lint branch March 21, 2022 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants