fix resolveConfig to work with Prettier 3 (#942)

Co-authored-by: Jonathan Rehm <[email protected]>
Co-authored-by: JounQin <[email protected]>

Author: 3 people

.all-contributorsrc

@@ -340,6 +340,13 @@
         "test",
         "tool"
       ]
+    },
+    {
+      "login": "jkrehm",
+      "name": "Jonathan Rehm",
+      "avatar_url": "https://avatars.githubusercontent.com/u/999845?v=4",
+      "profile": "https://jonathan.rehm.me/",
+      "contributions": ["bug", "code"]
     }
   ],
   "repoType": "github",

.changeset/great-cups-sparkle.md

@@ -0,0 +1,5 @@
+---
+'prettier-eslint': patch
+---
+
+fix: update `resolveConfig` to work with Prettier 3

README.md

@@ -307,6 +307,7 @@ Thanks goes to these people ([emoji key][emojis]):
       <td align="center" valign="top" width="14.28%"><a href="https://campcode.dev/"><img src="https://avatars.githubusercontent.com/u/10620169?v=4?s=100" width="100px;" alt="Rebecca Vest"/><br /><sub><b>Rebecca Vest</b></sub></a><br /><a href="https://github.com/prettier/prettier-eslint/commits?author=idahogurl" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/chrisbobbe"><img src="https://avatars.githubusercontent.com/u/22248748?v=4?s=100" width="100px;" alt="Chris Bobbe"/><br /><sub><b>Chris Bobbe</b></sub></a><br /><a href="https://github.com/prettier/prettier-eslint/issues?q=author%3Achrisbobbe" title="Bug reports">🐛</a> <a href="https://github.com/prettier/prettier-eslint/commits?author=chrisbobbe" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.1stg.me/"><img src="https://avatars.githubusercontent.com/u/8336744?v=4?s=100" width="100px;" alt="JounQin"/><br /><sub><b>JounQin</b></sub></a><br /><a href="#question-JounQin" title="Answering Questions">💬</a> <a href="https://github.com/prettier/prettier-eslint/commits?author=JounQin" title="Code">💻</a> <a href="#design-JounQin" title="Design">🎨</a> <a href="https://github.com/prettier/prettier-eslint/commits?author=JounQin" title="Documentation">📖</a> <a href="#ideas-JounQin" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JounQin" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JounQin" title="Maintenance">🚧</a> <a href="#plugin-JounQin" title="Plugin/utility libraries">🔌</a> <a href="#projectManagement-JounQin" title="Project Management">📆</a> <a href="https://github.com/prettier/prettier-eslint/pulls?q=is%3Apr+reviewed-by%3AJounQin" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/prettier/prettier-eslint/commits?author=JounQin" title="Tests">⚠️</a> <a href="#tool-JounQin" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://jonathan.rehm.me/"><img src="https://avatars.githubusercontent.com/u/999845?v=4?s=100" width="100px;" alt="Jonathan Rehm"/><br /><sub><b>Jonathan Rehm</b></sub></a><br /><a href="https://github.com/prettier/prettier-eslint/commits?author=jkrehm" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

src/__mocks__/prettier.js

@@ -7,9 +7,7 @@ const mockFormatSpy = jest.fn(mockFormat);
 
 Object.assign(prettier, {
   format: mockFormatSpy,
-  resolveConfig: {
-    sync: jest.fn(prettier.resolveConfig.sync)
-  }
+  resolveConfig: jest.fn()
 });
 
 function mockFormat(...args) {

src/__tests__/index.js

@@ -235,7 +235,7 @@ beforeEach(() => {
   eslintMock.mock.lintText.mockClear();
   eslintMock.mock.calculateConfigForFile.mockClear();
   prettierMock.format.mockClear();
-  prettierMock.resolveConfig.sync.mockClear();
+  prettierMock.resolveConfig.mockClear();
   fsMock.readFileSync.mockClear();
   loglevelMock.mock.clearAll();
   global.__PRETTIER_ESLINT_TEST_STATE__ = {};
@@ -376,33 +376,15 @@ test('logs error if it cannot read the file from the filePath', async () => {
   fsMock.readFileSync = originalMock;
 });
 
-test('calls prettier.resolveConfig.sync with the file path', async () => {
+test('calls prettier.resolveConfig with the file path', async () => {
   const filePath = require.resolve('../../tests/fixtures/paths/foo.js');
   await format({
     filePath,
     text: defaultInputText(),
     eslintConfig: getESLintConfigWithDefaultRules()
   });
-  expect(prettierMock.resolveConfig.sync).toHaveBeenCalledTimes(1);
-  expect(prettierMock.resolveConfig.sync).toHaveBeenCalledWith(filePath);
-});
-
-test('does not raise an error if prettier.resolveConfig.sync is not defined', () => {
-  const filePath = require.resolve('../../tests/fixtures/paths/foo.js');
-  const originalPrettierMockResolveConfigSync = prettierMock.resolveConfig.sync;
-  prettierMock.resolveConfig.sync = undefined;
-
-  function callingFormat() {
-    return format({
-      filePath,
-      text: defaultInputText(),
-      eslintConfig: getESLintConfigWithDefaultRules()
-    });
-  }
-
-  expect(callingFormat).not.toThrowError();
-
-  prettierMock.resolveConfig.sync = originalPrettierMockResolveConfigSync;
+  expect(prettierMock.resolveConfig).toHaveBeenCalledTimes(1);
+  expect(prettierMock.resolveConfig).toHaveBeenCalledWith(filePath);
 });
 
 test('does not raise an error if prettier.resolveConfig is not defined', async () => {

src/__tests__/utils.js

@@ -190,8 +190,7 @@ getPrettierOptionsFromESLintRulesTests.forEach(
       const { prettier } = getOptionsForFormatting(
         { rules },
         prettierOptions,
-        fallbackPrettierOptions,
-        eslintPath
+        fallbackPrettierOptions
       );
       expect(prettier).toMatchObject(options);
     });
@@ -221,8 +220,7 @@ test('if fallbacks are provided, those are preferred over disabled eslint rules'
     {},
     {
       singleQuote: true
-    },
-    eslintPath
+    }
   );
   expect(prettier).toMatchObject({ singleQuote: true });
 });
@@ -233,8 +231,7 @@ test('if fallbacks are provided, those are used if not found in eslint', () => {
     undefined,
     {
       singleQuote: false
-    },
-    eslintPath
+    }
   );
   expect(prettier).toMatchObject({ singleQuote: false });
 });
@@ -253,8 +250,7 @@ test('eslint max-len.tabWidth value should be used for tabWidth when tabs are us
       }
     },
     undefined,
-    undefined,
-    eslintPath
+    undefined
   );
 
   expect(prettier).toMatchObject({
@@ -270,8 +266,7 @@ test('eslint config has only necessary properties', () => {
       rules: { 'no-with': 'error', quotes: [2, 'single'] }
     },
     undefined,
-    undefined,
-    eslintPath
+    undefined
   );
   expect(eslint).toMatchObject({
     fix: true,
@@ -284,8 +279,7 @@ test('useEslintrc is set to the given config value', () => {
   const { eslint } = getOptionsForFormatting(
     { useEslintrc: true, rules: {} },
     undefined,
-    undefined,
-    eslintPath
+    undefined
   );
   expect(eslint).toMatchObject({ fix: true, useEslintrc: true });
 });
@@ -299,8 +293,7 @@ test('Turn off unfixable rules', () => {
       }
     },
     undefined,
-    undefined,
-    eslintPath
+    undefined
   );
 
   expect(eslint).toMatchObject({

src/index.js

@@ -65,7 +65,7 @@ async function format(options) {
     // Let prettier infer the parser using the filepath, if present. Otherwise
     // assume the file is JS and default to the babel parser.
     filePath ? { filepath: filePath } : { parser: 'babel' },
-    getPrettierConfig(filePath, prettierPath),
+    await getPrettierConfig(filePath, prettierPath),
     options.prettierOptions
   );
 
@@ -298,12 +298,7 @@ async function getESLintConfig(filePath, eslintPath, eslintOptions) {
 
 function getPrettierConfig(filePath, prettierPath) {
   const prettier = requireModule(prettierPath, 'prettier');
-  return (
-    (prettier.resolveConfig &&
-      prettier.resolveConfig.sync &&
-      prettier.resolveConfig.sync(filePath)) ||
-    {}
-  );
+  return prettier.resolveConfig && prettier.resolveConfig(filePath);
 }
 
 function getModulePath(filePath = __filename, moduleName) {