Allow formatting untitled files when requireConfig is enabled#3946
Open
Allow formatting untitled files when requireConfig is enabled#3946
Conversation
bfca2f7 to
8e17ac9
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes formatting of untitled files when prettier.requireConfig is enabled. Previously, untitled documents couldn't be formatted in this mode because the extension tried to resolve Prettier config files starting from the document's non-existent file path (e.g., "Untitled-1").
Changes:
- Modified
getResolvedConfiginModuleResolverNode.tsto detect untitled documents and use the first workspace folder's path for config resolution - Updated CHANGELOG.md to document the fix
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/ModuleResolverNode.ts | Added logic to detect untitled documents via URI scheme and substitute the workspace folder path for config file resolution |
| CHANGELOG.md | Documented the fix for untitled file formatting with requireConfig enabled |
Comments suppressed due to low confidence (1)
src/ModuleResolverNode.ts:238
- Consider adding test coverage for the untitled file formatting scenario with requireConfig enabled. The repository has comprehensive test coverage for other formatting scenarios (see test/suite/config.test.ts, format.test.ts), but this new behavior isn't tested. A test should verify that an untitled document can be formatted when requireConfig is true and a Prettier config exists in the workspace folder.
(await getBundledPrettier());
return this.resolveConfig(prettier, fileName, vscodeConfig, isUntitled);
}
public async clearModuleCache(filePath: string): Promise<void> {
const prettier =
(await this.getPrettierInstance(filePath)) ??
(await getBundledPrettier());
For untitled files (unsaved documents), the requireConfig setting now does not apply. Untitled files will be formatted using VS Code settings since they are not part of any workspace. Fixes #3885 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
8e17ac9 to
86581ea
Compare
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
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.
Summary
prettier.requireConfigis enabled.prettierrcor other Prettier config in the workspaceProblem
When
prettier.requireConfigis enabled, untitled files couldn't be formatted because:fileNamefileNamelike "Untitled-1", which is not a real file pathresolveConfigFilecouldn't find any config, so formatting was disabledSolution
Modified
getResolvedConfiginModuleResolverNode.tsto detect when a document has theuntitledURI scheme and use the first workspace folder's path instead of the document's fileName for config resolution.Test plan
.prettierrcfileprettier.requireConfigin settingsCmd/Ctrl + N)Cmd/Ctrl + Shift + For use Format Document command)Fixes #3885
🤖 Generated with Claude Code