ensure --list-different + --write reports status code 0

[outofambit]

closes #4144

let me know if i missed anything! 💖

• I’ve added modified tests to confirm my change works.
• (If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory)
• I’ve read the contributing guidelines.

✨Try the playground for this PR✨

[j-f1]

LGTM!

[j-f1]

Thanks for contributing @outofambit!

[felixfbecker]

This is a breaking change and should have been in a major version. We rely on --list-different to check files are formatted in CI and break the build if they are not. There is no mention in the changelog of what different flags need to be provided to maintain this behaviour. I noticed this because files would constantly get reformatted despite us checking in CI with --list-different.

[felixfbecker]

There actually doesn't even seem to be any way to achieve this now because --check is not released yet

[j-f1]

If you don’t pass --write, Prettier will still exit with 1.

[felixfbecker]

Yey. I have more than 25 repositories with an npm script that does both --write and --list-different and is used in CI.

[j-f1]

Why are you using both in CI?

[felixfbecker]

Because I defined an npm script called prettier that can be used both in CI and locally, to have a single point where the file pattern is defined.

See https://sourcegraph.com/search?q=r:%5Egithub.com/sourcegraph/+%22prettier%5C%22:+%5C%22prettier%22+f:package.json

[j-f1]

You could set it up with just --list-different and have a format script that runs yarn prettier --write.

[felixfbecker]

Yes, but I would have to define the glob twice, or have one script call into the other. I'm not saying it's not possible, I'm just saying this requires me to update all these repositories and is therefor clearly a breaking change that should not have been introduced in a patch release (and reverted, tbh).

[j-f1]

cc @prettier/core

[outofambit]

@felixfbecker there was some discussion of this in #4144. I believe we determined this to be a bug, so fixing it would not constitute a breaking change.

[felixfbecker]

The workaround I am using now is

    "prettier": "prettier --list-different --write \"**/{*.{js?(on),ts,md,yml},.*.yml}\"",
    "prettier-check": "npm run prettier -- --write=false",