Add support for formatters locally installed via yarn 2+ pnp mode #200

edslocomb · 2023-07-22T22:50:31Z

This adds support for formatters installed locally in project directories via yarn 2's "zero install" pnp mode.

It's quite similar to the support for formatters installed locally in a project's node_modules via npm, and leverages the npx symbol, so existing formatter definitions should work without modification.

This checks for a .pnp.cjs file (expected in the project root for yarn pnp projects), then looks for a yarn executable, and checks the version of yarn to make sure it supports pnp. If that works, we just push "yarn" onto the front of command.

I've only tested this with a locally installed prettier.js. It's very much a works-for-me draft, I'm putting in a PR to make sure this is a workable approach before going any further with it.

…tps://yarnpkg.com/features/pnp)

zarybnicky · 2023-07-29T09:30:52Z

Trying this out, I see that the yarn --version invocation takes more than half a second - which, compared to the actual prettier runtime, takes inexcusably long. (Testing with Yarn 4rc45 and Yarn 3.2.0 both.)

In my experience, the existence of .pnp.cjs marks the current project as a Yarn 2+ project pretty much without exception and the version check can be skipped - is your experience different?

edslocomb · 2023-07-29T17:56:50Z

I added the version check because I ran into a problem with emacs invoking an outdated system version of yarn instead of the project local version, but I'm fine with leaving it to the developer to make sure they've got their external toolchain in order :)

apheleia-core.el

raxod502 · 2023-09-16T01:59:37Z

Sorry it took so long, but take a look at the latest commits I pushed to your branch. This introduces a new approach which provides full PNP compatibility while adding essentially no overhead (PNP-installed Prettier runs in 148ms with my version, versus 285ms when running via Yarn, versus 115ms when invoking the binary directly).

raxod502 · 2023-09-16T02:08:30Z

And CI is broken, because of packaging bullshit. I guess I'll have to fix that too, will do either today or later...

edslocomb · 2023-09-19T19:42:39Z

Excellent! I was noodling around with a special case of this that would call node directly instead of through yarn, but only for prettier. The more general approach here is very nice.

I've also pondered spinning up a node process with prettier loaded, and then calling the api to do the formatting, thus sparing the user the overhead of loading node every time... but that's a project for another day ;)

edslocomb · 2023-09-20T01:29:51Z

Currently working on getting this running in a project with a .pnp.cjs and .pnp.loader.mjs, not a .pnp.js.

raxod502 · 2023-09-23T01:30:39Z

Filed prettier/plugin-ruby#1392 upstream about the remaining CI error.

…ages

Merge upstream

edslocomb · 2023-10-05T00:44:07Z

Getting back to this, with a few notes:

This won't work in Windows emacs, not sure if there would be affected users
No idea if it works with tramp mode
Was puzzled by apheleia-npx looking for a .pnp.js rather than a .pnp.cjs, changed it but should be easy to make it work with both

…e.g. Gemfile)

…with other formatters

edslocomb · 2023-10-10T18:08:27Z

I needed to add minor fixes to apheleia-ft.el to get CI working; will extract those into a separate PR if the yarn-pnp stuff needs more work after review

raxod502 · 2023-10-13T02:09:28Z

Hmm, dunno about .js versus .cjs, when I ran yarn pnp locally it generated .pnp.js so maybe this is a version thing.

raxod502 · 2023-10-13T02:10:29Z

pnp-bin/.yarn/cache/@types-emscripten-npm-1.39.8-b45eeffa86-adccdfcec3.zip

Was it intended to include these files?

Yes, those zip files are where the dependencies live

...or did you just mean the @types/emscripten dependency, specifically? I haven't tried removing that

raxod502

Makes sense to me to write this in JavaScript if it is more robust, however having dependencies is not so nice - what leads to the requirement to find formatters in zip files? When would that be usable?

raxod502 · 2023-10-13T02:15:06Z

~~Also, prettier/plugin-ruby#1392 was closed, so applying the suggested fix from there here.~~ I see you did that already, thanks.

edslocomb · 2023-10-13T17:30:52Z

Yarn's pnp mode caches package zip files and reads them as needed instead of caching the unzipped files.

A package can suggest that it should be unplugged (unzipped) via the "preferUnplugged": true in package.json (prettier does this), but it is not not required for packages that export binaries/executables (e.g. eslint does not).

edslocomb · 2023-10-13T17:46:50Z

Hmm, dunno about .js versus .cjs, when I ran yarn pnp locally it generated .pnp.js so maybe this is a version thing.

What does yarn --version say? If I can repo the behavior I think making this work with a .pnp.js as well will be pretty straightforward

edslocomb · 2023-10-20T20:46:00Z

I've extracted and cleaned up the pnp-bin js script; it's set up to build a minified standalone nodejs executable.

The minified standalone is ~290k and targets node 8 or higher. Would it be better to use that here?

raxod502 · 2023-10-21T18:00:11Z

Okay, yeah, that makes sense to me. If we at least have a standalone script, it's still not terribly nice, but at least the vendoring is restricted to a plaintext file. Thank you for doing this! I don't have any other major concerns about the PR.

…t in Apheleia

…ution

* When searching for an executable in node_modules, iterate through node's list of possible node_modules paths, provided by require.resolve.paths('') * Decide whether to use pnp or npm resolution based on the closest parent directory containing a .pnp.cjs file or node_modules directory, with a tie going to npm

edslocomb · 2023-10-31T00:44:16Z

Commit ef82e42 should fix #217

raxod502

✨

raxod502 · 2023-11-04T19:19:15Z

You think we should merge this for now and then iterate from there? There are getting to be a fair number of issues fixed here but not on main. (I've given you admin permissions on the repository so you can merge things yourself)

edslocomb · 2023-11-05T00:49:43Z

Sounds good to me, there's definitely been some creep in this PR (I don't see a PR merge button on my end btw)

…mode (radian-software#200)" This reverts commit 54a192c.

radian-software/apheleia#200 seems to have broken prettier formatting

edslocomb added 3 commits July 22, 2023 15:09

add basic support for formatters installed locally via yarn 3 pnp (ht…

24f785f

…tps://yarnpkg.com/features/pnp)

pnp was introduced in yarn 2, not yarn 3!

52b12db

limit line length

8ba34dd

omit yarn version check

740bf0c

raxod502 reviewed Aug 2, 2023

View reviewed changes

apheleia-core.el Outdated Show resolved Hide resolved

apheleia-core.el Outdated Show resolved Hide resolved

raxod502 added 3 commits September 15, 2023 18:51

Use a more efficient approach

73ea68d

Merge branch 'main' into yarn-pnp

7cfd1ec

oops missed this

14c13d5

raxod502 added 2 commits September 22, 2023 18:18

fix part of ci

c5c437b

remove dupes

81ccc6e

edslocomb added 2 commits October 4, 2023 17:34

rework apheleia-npx to use the pnp api to find formatters in pnp pack…

415c4c3

…ages

Merge branch 'yarn-pnp' of github.com:edslocomb/apheleia into yarn-pnp

a0c7455

Merge upstream

edslocomb added 6 commits October 4, 2023 20:39

resolve merge conflict

b77dd9d

fix long lines, ignore line-length checks on autogenerated pnp files

3adb30c

fix tests, fix prettier options

f36fe05

Merge upstream

2341678

fix prettier-ruby formatter when editing files without an extension (…

b7616a2

…e.g. Gemfile)

fix apheleia-ft.el, make definitions for html-tidy and jq consistent …

9c46cc0

…with other formatters

ensure formatter definition is a list before calling member on it

156f320

raxod502 reviewed Oct 13, 2023

View reviewed changes

raxod502 mentioned this pull request Oct 29, 2023

Apheleia does not format buffer with prettier when installed locally (npx prettier ...) #217

Open

edslocomb added 4 commits October 30, 2023 09:38

resolve merge conflicts

e4bdaf9

Extract pnp-bin to its own repo, use a standalone minified build of i…

3166f24

…t in Apheleia

reintroduce prettier option fixes/simplifications lost in merge resol…

ef82e42

…ution

edslocomb added 2 commits October 31, 2023 10:36

merge main

96093c2

Fix nodejs install by using new universal installer

bfa8692

edslocomb mentioned this pull request Nov 4, 2023

Fixes for test installers #237

Closed

raxod502 approved these changes Nov 4, 2023

View reviewed changes

edslocomb merged commit 54a192c into radian-software:main Nov 5, 2023
4 checks passed

alternateved added a commit to alternateved/apheleia that referenced this pull request Nov 6, 2023

Revert "Add support for formatters locally installed via yarn 2+ pnp …

9d48c14

…mode (radian-software#200)" This reverts commit 54a192c.

ItsHoff added a commit to ItsHoff/Dotfiles that referenced this pull request Feb 5, 2024

Update to latest working apheleia

f4d8ddf

radian-software/apheleia#200 seems to have broken prettier formatting

zeorin mentioned this pull request May 1, 2024

Fix apheleia-npx in Yarn PnP projects #301

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for formatters locally installed via yarn 2+ pnp mode #200

Add support for formatters locally installed via yarn 2+ pnp mode #200

edslocomb commented Jul 22, 2023

zarybnicky commented Jul 29, 2023

edslocomb commented Jul 29, 2023

raxod502 commented Sep 16, 2023

raxod502 commented Sep 16, 2023

edslocomb commented Sep 19, 2023

edslocomb commented Sep 20, 2023

raxod502 commented Sep 23, 2023

edslocomb commented Oct 5, 2023

edslocomb commented Oct 10, 2023 •

edited

Loading

raxod502 commented Oct 13, 2023

raxod502 Oct 13, 2023

edslocomb Oct 13, 2023 •

edited

Loading

raxod502 left a comment

raxod502 commented Oct 13, 2023 •

edited

Loading

edslocomb commented Oct 13, 2023

edslocomb commented Oct 13, 2023 •

edited

Loading

edslocomb commented Oct 20, 2023

raxod502 commented Oct 21, 2023

edslocomb commented Oct 31, 2023

raxod502 left a comment

raxod502 commented Nov 4, 2023

edslocomb commented Nov 5, 2023 •

edited

Loading

Add support for formatters locally installed via yarn 2+ pnp mode #200

Add support for formatters locally installed via yarn 2+ pnp mode #200

Conversation

edslocomb commented Jul 22, 2023

zarybnicky commented Jul 29, 2023

edslocomb commented Jul 29, 2023

raxod502 commented Sep 16, 2023

raxod502 commented Sep 16, 2023

edslocomb commented Sep 19, 2023

edslocomb commented Sep 20, 2023

raxod502 commented Sep 23, 2023

edslocomb commented Oct 5, 2023

edslocomb commented Oct 10, 2023 • edited Loading

raxod502 commented Oct 13, 2023

raxod502 Oct 13, 2023

Choose a reason for hiding this comment

edslocomb Oct 13, 2023 • edited Loading

Choose a reason for hiding this comment

raxod502 left a comment

Choose a reason for hiding this comment

raxod502 commented Oct 13, 2023 • edited Loading

edslocomb commented Oct 13, 2023

edslocomb commented Oct 13, 2023 • edited Loading

edslocomb commented Oct 20, 2023

raxod502 commented Oct 21, 2023

edslocomb commented Oct 31, 2023

raxod502 left a comment

Choose a reason for hiding this comment

raxod502 commented Nov 4, 2023

edslocomb commented Nov 5, 2023 • edited Loading

edslocomb commented Oct 10, 2023 •

edited

Loading

edslocomb Oct 13, 2023 •

edited

Loading

raxod502 commented Oct 13, 2023 •

edited

Loading

edslocomb commented Oct 13, 2023 •

edited

Loading

edslocomb commented Nov 5, 2023 •

edited

Loading