feat(devkit): add NX_SKIP_FORMAT environment variable to skip Prettier formatting #34336
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
…r formatting Add support for skipping Prettier formatting in generators and migrations via the `NX_SKIP_FORMAT` environment variable. This is useful for repositories that: - Use alternative formatters like Biome, dprint, or oxfmt - Have custom formatting requirements that conflict with Prettier defaults - Experience issues where Prettier reformatting breaks eslint-disable comments When `NX_SKIP_FORMAT=true`, the `formatFiles()` function and related formatting utilities will skip Prettier formatting but will still perform tsconfig path sorting if enabled via `sortRootTsconfigPaths` option or `NX_FORMAT_SORT_TSCONFIG_PATHS` environment variable. Usage: NX_SKIP_FORMAT=true nx migrate --run-migrations NX_SKIP_FORMAT=true nx g @nx/react:app my-app Also updates `formatChangedFilesWithPrettierIfAvailable` and `formatFilesWithPrettierIfAvailable` in the nx package to respect this environment variable. Related: nrwl#30403, nrwl#30426
👷 Deploy request for nx-docs pending review.Visit the deploys page to approve it
|
👷 Deploy request for nx-dev pending review.Visit the deploys page to approve it
|
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.
Current Behavior
When running generators or migrations, Nx automatically skips Prettier formatting if no root Prettier config is detected (added in #30426). However, there's no way to explicitly skip Prettier formatting when a config IS present but the user wants to bypass it for specific operations.
This can be needed when:
eslint-disablecomments)Expected Behavior
Users can set
NX_SKIP_FORMAT=trueto explicitly skip Prettier formatting in generators and migrations, regardless of whether Prettier is configured. TSConfig path sorting (controlled bysortRootTsconfigPathsorNX_FORMAT_SORT_TSCONFIG_PATHS) continues to work independently.Related Issue(s)
Related to #30403 and #30426. This enhancement adds explicit user control for cases where auto-detection of Prettier configuration isn't sufficient.