Resolves config by default in getFileInfo() (#14108)

This commit is contained in:
fisker Cheung authored and GitHub committed 2023-01-30 09:59:19 +08:00
1 parent d65a88af3d
commit a26e8ace46
4 files changed
+7 -4

No files matched your search

+3
View File
@@ -0,0 +1,3 @@
#### [BREAKING] `getFileInfo()` resolves config by default (#14108 by @fisker)
`options.resolveConfig` default to `true` now, see the [documentation](https://prettier.io/docs/en/api.html#prettiergetfileinfofilepath--options).
+1 -1
View File
@@ -96,7 +96,7 @@ If the given `filePath` is ignored, the `inferredParser` is always `null`.
Providing [plugin](plugins.md) paths in `options.plugins` (`string[]`) helps extract `inferredParser` for files that are not supported by Prettier core.
When setting `options.resolveConfig` (`boolean`, default `false`), Prettier will resolve the configuration for the given `filePath`. This is useful, for example, when the `inferredParser` might be overridden for a subset of files.
When setting `options.resolveConfig` (`boolean`, default `true`) to `false`, Prettier will not search for configuration file. This can be useful if this function is only used to check if file is ignored.
## `prettier.getSupportInfo()`
+1 -1
View File
@@ -39,7 +39,7 @@ async function getFileInfo(filePath, options) {
async function getParser(filePath, options) {
let config;
if (options.resolveConfig) {
if (options.resolveConfig !== false) {
config = await resolveConfig(filePath);
}
+2 -2
View File
@@ -159,11 +159,11 @@ describe("API getFileInfo resolveConfig", () => {
test("{resolveConfig: undefined}", async () => {
await expect(prettier.getFileInfo(files.foo)).resolves.toMatchObject({
ignored: false,
inferredParser: null,
inferredParser: "foo-parser",
});
await expect(prettier.getFileInfo(files.js)).resolves.toMatchObject({
ignored: false,
inferredParser: "babel",
inferredParser: "override-js-parser",
});
await expect(prettier.getFileInfo(files.bar)).resolves.toMatchObject({
ignored: false,