Bug 197597 – Web Inspector: replace UIString key with comment

• Status: NEW
• Component: Web Inspector

[Devin Rousso]

<https://bugs.webkit.org/show_bug.cgi?id=195132#c28> :P

[Devin Rousso]

Created attachment 369089 [details]
Patch

[Devin Rousso]

Comment on attachment 369089 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=369089&action=review

> Source/WebInspectorUI/Localizations/en.lproj/localizedStrings.js:81
> +localizedStrings["A context menu item to force (override) a DOM node's pseudo-classes"] = "Forced Pseudo-Classes";

The only negative I can see of this approach is that it "breaks" the alphabetization of UI strings.  This could be solved by ordering based on the format string rather than the key, but I don't think it's that big of an issue either way.

[Timothy Hatcher]

Have we talked to the localization folks about this? They might need to update tooling to support this.

[Devin Rousso]

(In reply to Timothy Hatcher from comment #3)
> Have we talked to the localization folks about this? They might need to update tooling to support this.
What would need to be updated?  AFAIU, they just inject the localizedStrings.js file and replace the text inside the ` = "...";`.

Previously, we'd put any "comment" as an actual JS comment on the line above, and often the key for the UIString would be almost the same string (if not identical).  This patch "unifies" the comment and key into the same value.

For example:
```
    /* Settings tab checkbox label for whether searches should be case sensitive. */
    localizedStrings["Case Sensitive @ Settings"] = "Case Sensitive";
```
becomes
```
    localizedStrings["Settings tab checkbox label for whether searches should be case sensitive"] = "Case Sensitive";
```

[Blaze Burg]

Comment on attachment 369089 [details]
Patch

While callsites are a bit shorter, I don't think this is a good change. Whenever a comment string changes or is added, localizers would need to re-localize the key, because the comment string becomes the key.

Unrelated, but I find the @ [Location] formatting to be confusing. Most localization files I've seen on macOS use the format "Search: (Settings tab)" rather than "Search: @ Settings"

[Matt Baker]

(In reply to Brian Burg from comment #5)
> Comment on attachment 369089 [details]
> Patch
> 
> While callsites are a bit shorter, I don't think this is a good change.
> Whenever a comment string changes or is added, localizers would need to
> re-localize the key, because the comment string becomes the key.
> 
> Unrelated, but I find the @ [Location] formatting to be confusing. Most
> localization files I've seen on macOS use the format "Search: (Settings
> tab)" rather than "Search: @ Settings"

Agree.