nextjs - 💡(How to fix) Fix Docs: pageExtensions warning not on middleware documentation [5 comments, 4 participants]

Though the pageExtensions documentation does warn about changes to the middleware.js, nothing on the middleware page mentions it. The middleware page is confident that the file must be called "middleware.js" or "middleware.ts", and that's not always correct.

TL;DR

The documentation for middleware should be updated to include a warning about the potential impact of changing pageExtensions on the naming of middleware files.

Guidance

• Copy the warning from the pageExtensions documentation in the instrumentation documentation to the middleware documentation to ensure consistency and clarity.
• Review the examples used in the documentation to ensure they accurately reflect the potential naming conventions for middleware files based on pageExtensions.
• Consider adding a note to the middleware documentation to explain how the pageExtensions configuration affects the naming of middleware files.

Notes

The solution relies on updating the documentation to reflect the relationship between pageExtensions and middleware file naming, which may not address underlying technical issues but will improve the accuracy and helpfulness of the documentation.

Recommendation

Apply workaround: Update the middleware documentation to include the warning and clarify the relationship between pageExtensions and middleware file naming, as this will improve the user's understanding of the potential impact of configuration changes.