[no-unlocalized-strings] Tracking issue for the rule improvements.

[timofei-iatsenko]

I created this issue to collect all problems / improvements for no-unlocalized-strings rule.

• Support regexp in ignoreAttribute ignoreProperty ignoreFunction how to ignore property by pattern? #40
• Ignore subkeys with ignoreProperty no-unlocalized-strings ignoreProperty option should extend to ignoring string values in subkeys #39
• ignore bracket access strings by default, eq obj["key with space”] no-unlocalized-strings should ignore string keys for dereferencing object values #38
• use type information to ignore methods from some popular built-ins such as Map, Set, etc no-unlocalized-strings should ignore string keys for dereferencing object values #38
• ignoreProperty should work for ClassDeclaration -> PropertyDefinition, ObjectExpression -> Property, MemberExpression.property ignoreProperty does not work as expected #37
• The original whitelist regexp works a bit weird, need refinement Confusing results of lingui/no-unlocalized-strings #30

[jgarplind]

Not sure if this is a good place to share input, but we noticed that const CAPITAL_LETTERS is always ignored(?).

Might be an anti-pattern on our end, but we have occasionally used such syntax for copy text, which the linter did not help us catch.

[timofei-iatsenko]

Yes, this excluded by default. The capital letters in the variable names mostly used to define constants, so they are excluded.

I think it could be a good idea to revisit the defaults, and make them configurable or overridable.

[nyadav810]

Any chance that regex patterns will be supported in ignoreFunction in the future? I want to be able to ignore Events.*, logger.* and console.* with all functions exposed on a certain object ignored by this rule. Thanks!

[timofei-iatsenko]

@nyadav810 ignoreFunction is a little bit different from other ignore* options, because ignoreFunction supports complex selectors matching object.method, which in AST is presented as different nodes, so the signature for this option is not trivial.

[timofei-iatsenko]

I went through the issues with this rule and tried to address them all. It seems like we need a big change in how the rule is set up. There’s no way to make it work perfectly for everyone and every project. So, I’ve decided to remove all the built-in settings and made them fully customizable.

For example, if a user doesn’t want:

but we noticed that const CAPITAL_LETTERS is always ignored(?).

they can simply remove the related regex from their options.

Let me know what you think, and feel free to share any other feedback you have on this rule.

[jgarplind]

I think the defaults so far have been very sane, and only small caveats such as the above have been slight nuissences.

As long as it is easy to reproduce the existing default experience, I think that sounds good!

[timofei-iatsenko]

@nyadav810 FYI #77

[timofei-iatsenko]

Guys, I would appreciate if you review and left your feedback on this PR #78

Also while working on it, i've noticed that in a real life sceanario we probably don't need separate settings for ignoreAttribute, ignoreProperties, ignoreVariable because in most of the cases we will want to have the same values in all of them. And now i'm thinking of replacing all these 3 options into one.

/* eslint lingui/no-unlocalized-strings: ["error", {"ignoreAttribute": ["className"]}] */
export const MyComponent() {
 return <div className="classes string">Ola!</>
}

/* eslint lingui/no-unlocalized-strings: ["error", {"ignoreVariable": ["className"]}] */
export const MyComponent() {
  const className = "doing some magic";

 return <div className={className}>Ola!</>
}

/* eslint lingui/no-unlocalized-strings: ["error", {"ignoreProperty": ["className"]}] */
const variants = {
  variantA: {
    className: "classes string"
  },
  variantB: {
    className: "classes string"
  }
]
export const MyComponent({variant}) {
 return <div className={variants[variant].className}>Ola!</>
}

[nyadav810]

Thanks for the improvements @timofei-iatsenko !!!

Another quirk I found - when called as a function, msg triggers this warning as well!

Example:

msg({ message: "hello", comment: "a common greeting" })

...
warning  String not marked for translation. Wrap it with t``, <Trans>, or msg``  lingui/no-unlocalized-strings

(I'm having to add msg to ignoreFunction in the ESLint config to ignore those)

[timofei-iatsenko]

@nyadav810 thanks for the report. Also noticed it when worked on the #78. It's fixed there.