1601681 - Prettier formatting should specify Unix line endings

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, defect, P2)

Description

[Mark Banner (:standard8)]

Prior to Prettier we used to have the requirement for unix line endings in files controlled by ESLint:

"linebreak-style": ["error", "unix"],

With the switch to Prettier, we removed the configuration option as it conflicted with Prettier's control.

However, we didn't realise that Prettier defaults to automatic line-endings which means it will just make files consistent with itself.

We should set the endOfLine option to lf to restore the original intention. We've already got a few newish files in tree with Windows line endings.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

We have a lint for this in mozlint:
https://firefox-source-docs.mozilla.org/tools/lint/linters/file-whitespace.html

I just realized that js isn't in the list :|
https://searchfox.org/mozilla-central/source/tools/lint/file-whitespace.yml

Comment 2

[Mark Banner (:standard8)]

Nor are html etc...

I think we should just fix this in Prettier. Prettier has integrations into editors today, and so developers that are using the editor integrations will get notified earlier. Prettier will also be doing some checking regardless of what we do elsewhere, so I think just telling it to do the right thing shouldn't be costing us any more.

Comment 3

[Sylvestre Ledru [:Sylvestre]]

Sure, it was more a FYI :)

Comment 4

[Mark Banner (:standard8)]

There's about 14 files here, so I think we can just go with just fixing this asap. Try push:

https://treeherder.mozilla.org/#/jobs?repo=try&revision=7893e153689740d8b7c08a03891820b4fbe8df90

Comment 5

[Mark Banner (:standard8)]

Attachment: Bug 1601681 - Switch recently added files with Windows line endings to Unix. r?Mossop

Comment 6

[Mark Banner (:standard8)]

Attachment: Bug 1601681 - Re-enable unix-line endings on ESLint controlled files. r?Mossop

This was accidentally regressed to match existing line endings in the switch to prettier.

Depends on D55990

Comment 7

[BugBot [:suhaib / :marco/ :calixte]]

Bugbug thinks this bug is a defect, but please change it back in case of error.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/cce89a164ecb
Switch recently added files with Windows line endings to Unix. r=mossop
https://hg.mozilla.org/integration/autoland/rev/b145da421419
Re-enable unix-line endings on ESLint controlled files. r=mossop

Comment 9

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/cce89a164ecb
https://hg.mozilla.org/mozilla-central/rev/b145da421419