Place DO NOT EDIT comment on top of generated fourslash tests #2142
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a "DO NOT EDIT" header comment to all generated fourslash test files to indicate they are auto-generated. The comment follows Go conventions by including Code generated by <tool>; DO NOT EDIT which is recognized by tooling like gopls to warn users and by tools like Copilot to avoid suggesting edits.
Key Changes:
- Added generation comment header to all generated fourslash test files
- Updated the makeManual script to strip the header when converting generated tests to manual tests
Reviewed Changes
Copilot reviewed 300 out of 2584 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
internal/fourslash/_scripts/convertFourslash.mts |
Added "DO NOT EDIT" header comment to the test file template |
internal/fourslash/_scripts/makeManual.mts |
Added logic to remove the generated header when converting tests to manual |
internal/fourslash/tests/gen/*_test.go |
All generated test files now include the header comment |
gabritto
approved these changes
Nov 21, 2025
Member
|
Did the conversion script fail to format? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These files are not meant to be edited by hand. Placing this special string at the top tells all Go-knowing tooling that these are generated and should be ignored, hides their diffs in GitHub diffs, tells
goplsto issue a warning when you touch these files, and probably helps Copilot know it shouldn't touch these files in general.