Support Prettier v3 by timdp · Pull Request #901 · prettier/prettier-eslint

timdp · 2023-07-07T09:19:01Z

Prettier v3.0.0 was released this week. I tried to run prettier-eslint against it, and ran into:

TypeError: Expected `input` to be a `string`, got `object`
    at module.exports (node_modules/@prettier/eslint/node_modules/indent-string/index.js:11:9)
    at prettify (node_modules/@prettier/eslint/dist/index.js:133:37)
    at format (node_modules/@prettier/eslint/dist/index.js:113:20)
    at async node_modules/prettier-eslint-cli/dist/format-files.js:255:26

The indentation happens merely in a logging statement, but commenting it out just propagates the unexpected input to another function. The underlying issue is that prettier.format(), called from prettify(), is now async. Hence, the mysterious object is actually a Promise.

As a quick fix for that particular API change, it's sufficient to treat prettify as async and add an await. It's also called in two other places, but those are a return from an async function, so adding an await would be redundant. (I personally prefer to do it for clarity, but the linter rules won't let me.)

This is only a fix for this particular incompatibility. It does not:

upgrade prettier to v3.0.0: I tried, but then, the tests crash;
take into account other API changes: no idea if there are any.

However, it makes formatting work in my projects, and it's backwards compatible with v2, because you can safely await a string. Hence, it should at least be a step in the right direction.

(Incidentally, only calling indentString if the logger is actually enabled would probably provide a nice performance boost.)

changeset-bot · 2023-07-07T09:19:04Z

🦋 Changeset detected

Latest commit: 6780f52

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Kreeg · 2023-07-20T08:17:30Z

When this will be merged?

timdp · 2023-07-25T09:44:33Z

For those wanting to experiment with this, I've published:

@timdp/prettier-eslint-cli@7.1.1-alpha.1
@timdp/prettier-eslint@^15.0.2-alpha.1

I was able to use the former as a drop-in replacement for the real prettier-eslint-cli while depending on prettier@3.0.0, but YMMV.

JounQin · 2023-07-25T09:45:23Z

upgrade prettier to v3.0.0: I tried, but then, the tests crash;

It seems this PR can not be merged as-is?

timdp · 2023-07-25T09:48:45Z

It seems this PR can not be merged as-is?

In the original PR, the logger was crashing. I didn't notice because I'd commented it out locally. I added an extra await and force-pushed 718e5f0. That one works for me; it's also the version I published under my npm scope.

JounQin · 2023-07-25T10:00:31Z

@timdp

prettier-eslint/package.json

Line 32 in 1c0bdbf

"prettier": "^2.5.1",

But the prettier version in package.json does not change at all?

timdp · 2023-07-25T10:08:49Z

But the prettier version in package.json does not change at all?

My project depends on prettier@3.0.0 directly, and this package contains complex logic that makes it prefer that over its own version.

As I mentioned in the issue description, upgrading the dependency makes the tests crash for an unknown reason:

node:internal/process/promises:289
            triggerUncaughtException(err, true /* fromPromise */);
            ^

TypeError: A dynamic import callback was not specified.
    at new NodeError (node:internal/errors:405:5)
    at importModuleDynamicallyCallback (node:internal/modules/esm/utils:91:9)
    at Object.<anonymous> (/Users/timdp/Code/prettier-eslint/node_modules/prettier/index.cjs:600:23)
    at Runtime._execModule (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:1205:24)
    at Runtime._loadModule (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:805:12)
    at Runtime.requireModule (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:662:10)
    at Runtime.requireActual (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:683:17)
    at Object.<anonymous> (/Users/timdp/Code/prettier-eslint/src/__mocks__/prettier.js:1:23)
    at Runtime._execModule (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:1205:24)
    at Runtime._loadModule (/Users/timdp/Code/prettier-eslint/node_modules/jest-runtime/build/index.js:805:12) {
  code: 'ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING'
}

Node.js v20.5.0

Jest gives me nightmares but I can do some more digging if the error doesn't ring a bell.

This fixes the testing issues for the PR to the upstream repo: prettier#901

seanCodes · 2023-08-04T20:56:31Z

@timdp @JounQin I've submitted a PR to Tim’s prettier-3 branch (timdp#1) that fixes the tests and includes the prettier 3 bump. Once it’s merged this PR should be good to go.

On a side note, it might be good to make prettier a peer dependency rather than a direct dependency. The prettier-eslint code actually supports prettier 2 and 3, so it could be nice for consumers to have the option to choose.

seanCodes · 2023-08-14T01:32:53Z

@JounQin This change should now be ready for review 🙂

mbergkvist · 2023-09-07T14:52:36Z

Any ideas when this will merged and released?

seanCodes · 2023-09-18T19:54:24Z

@JounQin @danielwerg Bumping this. This issue makes the eslint-prettier plugin for VSCode useless with Prettier v3, so it's impacting productivity quite a bit. Is anything else blocking release?

mrmarbury · 2023-09-28T12:30:19Z

Please merge this

monarchwadia · 2023-10-05T03:37:05Z

Just wanted to ask... When will this be merged?
Thank you for the great work you're doing for the community.

JounQin · 2023-10-14T03:58:44Z

Sorry for the delay, v16 has just been released! Before prettier-eslint-cli upgrade, you can install prettier-eslint@v16 manually with prettier-eslint-cli together, because prettier-eslint is an optional peer dependency for prettier-eslint-cli.

JounQin · 2023-10-14T06:02:00Z

prettier-eslint-cli@8.0.0 has just been released!

mattbrannon mentioned this pull request Jul 8, 2023

Prettier 3.0 idahogurl/vs-code-prettier-eslint#171

Closed

Support prettier@3

718e5f0

timdp force-pushed the prettier-3 branch from d94daa0 to 718e5f0 Compare July 25, 2023 09:38

seanCodes added a commit to seanCodes/prettier-eslint that referenced this pull request Aug 4, 2023

fix test setup; update dev dependencies; fix eslint warnings

a2decfc

This fixes the testing issues for the PR to the upstream repo: prettier#901

seanCodes mentioned this pull request Aug 4, 2023

Fix tests for prettier 3 timdp/prettier-eslint#1

Merged

Fix tests for prettier@3 (#1)

50a0452

Aitthi mentioned this pull request Aug 28, 2023

TypeError: Expected input to be a string, got object #920

Closed

danielwerg approved these changes Aug 31, 2023

View reviewed changes

Create nine-apricots-cough.md

6780f52

JounQin merged commit 65c8b57 into prettier:master Oct 14, 2023

github-actions Bot mentioned this pull request Oct 14, 2023

chore: release prettier-eslint #937

Merged

lthuong mentioned this pull request Nov 16, 2023

Fix Formatting Issue bei Prettier V.3 zentrumnawi/solid-frontend#2003

Closed

Uh oh!

Conversation

timdp commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Kreeg commented Jul 20, 2023

Uh oh!

timdp commented Jul 25, 2023

Uh oh!

JounQin commented Jul 25, 2023

Uh oh!

timdp commented Jul 25, 2023

Uh oh!

JounQin commented Jul 25, 2023

Uh oh!

timdp commented Jul 25, 2023

Uh oh!

seanCodes commented Aug 4, 2023

Uh oh!

seanCodes commented Aug 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbergkvist commented Sep 7, 2023

Uh oh!

seanCodes commented Sep 18, 2023

Uh oh!

mrmarbury commented Sep 28, 2023

Uh oh!

monarchwadia commented Oct 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JounQin commented Oct 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JounQin commented Oct 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

timdp commented Jul 7, 2023 •

edited

Loading

changeset-bot Bot commented Jul 7, 2023 •

edited

Loading

seanCodes commented Aug 14, 2023 •

edited

Loading

monarchwadia commented Oct 5, 2023 •

edited

Loading

JounQin commented Oct 14, 2023 •

edited

Loading