1812011 - Fluent linter: warn when a string has placeables but no comments

Status: RESOLVED FIXED

(Core :: Internationalization: Localization, enhancement)

Description

[Francesco Lodolo [:flod]]

Strings with placeables (e.g. { $somevar }) should have comments explaining what replaces the variables (comment can be either a group-level comment or individual comment).

The linter should warn when that's not the case.

A basic approach would be to just check for comments associated to the string, a more refined one to check for each placeable in the comment. The former is probably not as effective, as there might be even a file-level comment with no information.

Comment 1

[Francesco Lodolo [:flod]]

Attachment: Bug 1812011 - Add check for missing variable comments, r=gregtatum!

Comment 2

[Francesco Lodolo [:flod]]

Attachment: Bug 1812011 - Fix missing variable comments and consistency, r=#fluent-reviewers!

Depends on D167787

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3de1dd005c43
Add check for missing variable comments, r=gregtatum,eemeli
https://hg.mozilla.org/integration/autoland/rev/4a016b402eff
Fix missing variable comments and consistency, r=fluent-reviewers,Gijs

Comment 4

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/3de1dd005c43
https://hg.mozilla.org/mozilla-central/rev/4a016b402eff

Comment 5

[Francesco Lodolo [:flod]]

@rob
Heads up, I assume this will impact Thunderbird (I haven't looked at the FTL files though).

This expects any Fluent string with a variable to have a comment referencing the variable. Ideally, it should be in the form of

# Variables:
#   $somevar (type) - Description

So far, type has been something in: string, number, boolean, date.

Comment 6

[Rob Lemley [:rjl]]

Thanks Martin!