feat: add express.static dotfiles codemod#142
Open
singhvishalkr wants to merge 1 commit into
Open
Conversation
Add a codemod that explicitly sets dotfiles: 'allow' on express.static() calls to preserve Express 4 behavior where dotfiles were served by default. In Express 5, the dotfiles option defaults to 'ignore', which can break functionality that depends on serving dot-directories like .well-known (used by Android App Links and Apple Universal Links). Closes expressjs#116
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
1 participant
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.
In Express 5, the
express.staticmiddleware'sdotfilesoption defaults to"ignore"instead of serving them. This breaks functionality that depends on serving dot-directories like.well-known(used for Android App Links, Apple Universal Links, Let's Encrypt verification, etc.).This PR adds a new codemod that explicitly sets
dotfiles: 'allow'onexpress.static()calls that don't already specify adotfilesoption. A comment is included to flag the change for manual review.The codemod:
express.static('public')toexpress.static('public', { dotfiles: 'allow' /* Express 5: preserve v4 behavior */ })dotfilessettingThe README includes a security note encouraging developers to review each call and consider whether serving dotfiles is actually necessary.
Also added the new codemod to the v5-migration-recipe workflow.
Closes #116