1691751 - Add comment whitespace check to Fluent linter

Status: RESOLVED FIXED

(Core :: Internationalization: Localization, enhancement)

Description

[Dan Minor [:dminor]]

The preferred style is to have an empty line following group level (##) and file level (###) comments.

Comment 1

[Greg Tatum [:gregtatum]]

How strict should we be here?

I could see checking the following as well:

• That the resource-level comment (###) should be at the top of the file, immediately after the license comment.
• There should be an empty line before group level (##) and file level (###) comments.
• Only 1 ### comment per file.
• A ## comment must be followed by a message. So two ## in a row will be an error.

Comment 2

[Francesco Lodolo [:flod]]

There should be an empty line before group level (##) and file level (###) comments.

I would amend this: there should an empty line before and after. I think the empty line before is useful for readability.
It might look a bit weird when you have an empty comment ##, to reset it, but I think that's OK.

A ## comment must be followed by a message. So two ## in a row will be an error.

We might have files where we still reset the comment at the end with ##. I think it's still good to have this though, end just fix those files.

Having said that, the list looks great to me 👍

Comment 3

[Greg Tatum [:gregtatum]]

Attachment: Bug 1691751 - Add whitespace rules for the Fluent linter; r?dminor!,flod

Comment 4

[Greg Tatum [:gregtatum]]

Attachment: Bug 1691751 - Fix Fluent linting whitespace issues; r?dminor,flod

Depends on D105369

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d3ef456529ee
Add whitespace rules for the Fluent linter; r=flod,dminor,fluent-reviewers
https://hg.mozilla.org/integration/autoland/rev/af581d99dc49
Fix Fluent linting whitespace issues; r=dminor,flod

Comment 6

[Cristian Brindusan [:cbrindusan]]

https://hg.mozilla.org/mozilla-central/rev/d3ef456529ee
https://hg.mozilla.org/mozilla-central/rev/af581d99dc49