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

Add settings for enforced styles to presets #282

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jablko
Copy link
Contributor

@jablko jablko commented Feb 23, 2022

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

What I did was, for each preset rule with remark-stringify options in that rule's "fix" documentation, I added that option to the preset's settings.

What this does is, you can apply the preset's remark-stringify options with, e.g.

remark --output --use remark-preset-lint-markdown-style-guide input.md

For example:

@github-actions github-actions bot added the 👋 phase/new Post is being triaged automatically label Feb 23, 2022
@github-actions

This comment has been minimized.

@codecov-commenter

This comment was marked as resolved.

@jablko jablko mentioned this pull request Feb 23, 2022
5 tasks
@github-actions github-actions bot added 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Feb 23, 2022
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Probably a good idea!
This should be included in the docs at least.
It’s a breaking change. I’m open to working towards new majors (I’d also want to improve some error messages, which could be considered a major change as well), though that should probably come after by the work on improving markdown formatting which I mentioned in #281 (comment)

@wooorm wooorm changed the title Add settings -> presets Add settings for enforced styles to presets Feb 25, 2022
@ChristianMurphy ChristianMurphy added the 🧑 semver/major This is a change label Feb 25, 2022
@wooorm
Copy link
Member

wooorm commented Mar 8, 2022

Do you have ideas on how to test and document these additions?
What are your thoughts on the order in which your PRs should land?
And, how about the breaking changes? I guess that if we’re doing this one, we can break other things too?

@jablko jablko force-pushed the patch-4 branch 6 times, most recently from 9b4f501 to 875a137 Compare March 21, 2022 23:36
@jablko
Copy link
Contributor Author

jablko commented Mar 30, 2022

  • I've added Settings sections to each of the presets' readmes.

Thanks for merging #284 (comment)! Ideally I'd like to land #286 and this one (#282 (comment)), then rebase #279 (review)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤞 phase/open Post is being triaged manually 🧑 semver/major This is a change
Development

Successfully merging this pull request may close these issues.

None yet

4 participants