Ignore symlinks in style checks #97
Merged
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
Our style checks were adding problems when adding symlinks to directories: * `prettier` will error out if told to format a directory that doesn't contain any files it can format. * `git` will report new symlinks to directories as new files. * `prettier` will interpret symlinks to directories as directories. * Therefore, if adding a symlink to a directory that doesn't have any `prettier`-relevant files, `prettier` will error out. We avoid this (and any other symlink confusion) by excluding symlinks from style checks. By definition they'll point to a real file or directory that will be getting formatted anyway.
onelxj
approved these changes
Sep 15, 2025
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.
Our style checks were adding problems when adding symlinks to directories:
prettierwill error out if told to format a directory that doesn't contain any files it can format.gitwill report new symlinks to directories as new files.prettierwill interpret symlinks to directories as directories.prettier-relevant files,prettierwill error out.We avoid this (and any other symlink confusion) by excluding symlinks from style checks. By definition they'll point to a real file or directory that will be getting formatted anyway.