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

Indicate that content is auto-generated in marker comments #155

Merged
merged 1 commit into from Oct 21, 2022

Conversation

bmish
Copy link
Owner

@bmish bmish commented Oct 21, 2022

This will help decrease the chance that ESLint plugin contributors will try to manually edit the managed content. It should help them realize there's likely a command to run instead.

This is a breaking change in that consumers will need to find-and-replace to switch over to the new marker comments.

Before After
<!-- begin auto-generated rules list --> <!-- begin auto-generated rules list -->
<!-- end auto-generated rules list --> <!-- end auto-generated rules list -->
<!-- end auto-generated rule header --> <!-- end auto-generated rule header -->

Fixes #150.

@bmish bmish added the breaking label Oct 21, 2022
@bmish bmish merged commit 58f2269 into main Oct 21, 2022
@bmish bmish deleted the marker-auto-generated branch October 21, 2022 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider a warning comment to indicate the automatically generated doc sections managed by this tool
1 participant