Repository navigation
fix: Pass options to estree willPrintOwnComments - #494
Merged
Merged
Conversation
willPrintOwnComments delegated to Prettier's estree printer without passing options. The estree implementation reads options.semi, so a comment before a statement inside a template expression caused: `TypeError`: Cannot read properties of undefined (reading 'semi') Forward options as the second argument.
Add a regression fixture for passing options to estree's willPrintOwnComments. A comment before an expression statement inside a template expression made Prettier read options.semi, which threw before the fix: `TypeError`: Cannot read properties of undefined (reading 'semi')
🦋 Changeset detectedLatest commit: c870f42 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Add a patch changeset for the TypeError thrown when a comment appears before a statement inside a template expression.
Prettier's type declarations only list the path parameter for willPrintOwnComments, but the estree implementation also takes options and reads options.semi. Add options to the estree printer type so forwarding it type-checks.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes
willPrintOwnCommentsdelegated to Prettier's estree printer without passingoptions.The estree implementation reads
options.semiwhen an expression statement has a leading comment, so input like this threwTypeError: Cannot read properties of undefined (reading 'semi'):Forward
optionsas the second argument.Testing
other/comment-before-expression-statementfixture.TypeErrorabove without the fix and passes with it.pnpm testpasses.Docs
Bug fix only; no docs changes needed.