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

chore: update markdownlint #36540

Merged
merged 1 commit into from
Dec 13, 2022
Merged

Conversation

dsanders11
Copy link
Member

@dsanders11 dsanders11 commented Dec 2, 2022

Description of Change

Updates markdownlint so we can use new linting rules, but disables most of them for now - I'll enable them and clean up violations in future PRs.

This will run clean once #36519 is merged.

Checklist

  • PR description included and stakeholders cc'd

Release Notes

Notes: none

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Dec 2, 2022
@dsanders11 dsanders11 marked this pull request as ready for review December 5, 2022 22:00
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Dec 6, 2022
@nornagon nornagon merged commit 4d9c84d into electron:main Dec 13, 2022
@release-clerk
Copy link

release-clerk bot commented Dec 13, 2022

No Release Notes

@dsanders11 dsanders11 deleted the update-markdownlint branch December 13, 2022 23:04
@DavidAnson
Copy link

FYI, based on the way this project appears to be using the markdownlint-cli package, it should NOT need to directly reference the markdownlint package in package.json because that's a dependency of the CLI.

Unrelated, you MAY find markdownlint-cli2 a little faster - if not, I'd love to know so I can look into why. :)

/cc @dsanders11

@dsanders11
Copy link
Member Author

Hi @DavidAnson, thanks for dropping by!

FYI, based on the way this project appears to be using the markdownlint-cli package, it should NOT need to directly reference the markdownlint package in package.json because that's a dependency of the CLI.

You're right, I noticed that was odd when doing this PR, but didn't have time to dig further into it. 🙂 I'm sure it's a mistake I made when I first added markdownlint-cli - I think originally I was toying with using it programmatically but went with markdownlint-cli instead and just didn't clean up package.json properly.

Unrelated, you MAY find markdownlint-cli2 a little faster - if not, I'd love to know so I can look into why. :)

On my machine it takes 1s to do the linting so I'm not sure I'd notice the speed up. 😅 If I get some time in the future I'll take a look at markdownlint-cli2, but I've got a roadmap of other things to do to help keep the Markdown files in this repo in good shape so it may be a bit. 🙂 Feel free to chime in on that issue if you have any insights, I know markdownlint-cli might be able to help with more of that in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants