Prefer local Prettier when formatting files #905
Conversation
🦋 Changeset detectedLatest commit: cac4ff2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit cac4ff2:
|
| @@ -19,14 +19,25 @@ import prettier from "prettier"; | |||
| import versionPackage from "./version-package"; | |||
| import getChangelogEntry from "./get-changelog-entry"; | |||
|
|
|||
| function getPrettierInstance(): typeof prettier { | |||
| try { | |||
| return require("prettier"); | |||
There was a problem hiding this comment.
Could we use createRequire (or maybe something else that has the same behavior if we care about supporting Node versions that don't include createRequire) to resolve it from the repo root? Without that, this doesn't change anything, right?
There was a problem hiding this comment.
Looks like require.resolve("prettier", { paths: [projectDir] }) works on more versions so let's probably use that
There was a problem hiding this comment.
Ah, ye - this is totally what I had in mind when I started working on this and just forgot it in the rush 🤣
Andarist
force-pushed
the
prefer-local-prettier
branch
from
b5012c3
to
8e69b6b
Compare
packages/write/src/index.ts
Outdated
| @@ -4,6 +4,17 @@ import prettier from "prettier"; | |||
| import humanId from "human-id"; | |||
| import { Changeset } from "@changesets/types"; | |||
|
|
|||
| function getPrettierInstance(): typeof prettier { | |||
| try { | |||
| return require("prettier"); | |||
There was a problem hiding this comment.
This also needs to use require.resolve
# Conflicts: # packages/assemble-release-plan/src/index.ts # packages/cli/src/commands/add/index.ts
Andarist
force-pushed
the
prefer-local-prettier
branch
from
08b5c19
to
cac4ff2
Compare
Previously, weirdness would occur on release because of differences in the Prettier formatting for our CHANGELOG files between our auto-formatter and the formatting that Changesets itself tries to do. This was because Changesets had an old version of Prettier, but our repo had a newer version. We had a workaround for this where we deleted Changesets' version of Prettier, so that ours would be prefered. Now that changesets/changesets#905 has landed (fixing changesets/changesets#616), Changesets will prefer our version of Prettier. Plus the version they depend on is now up to date. So we can remove the workaround.
closes #616
it's the best to just take a look at the first commit (the one without formatting changes): 85fa889