Skip to content

BSL222 — Partially localized text is used in the StrTemplate function

← All rules

Summary

Partially localized text is used in the StrTemplate function

Identifiers

Field Value
Rule code BSL222
Compatible alias MultilingualStringUsingWithTemplate
Severity INFORMATION
Enabled by default Yes
Implemented Yes
Tags localization, style

Behavior

  • The public identifier BSL222 and alias MultilingualStringUsingWithTemplate are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL222"]
ignore = ["MultilingualStringUsingWithTemplate"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL222
  • bsl-disable:
Value = "example";  // bsl-disable: BSL222
  • compatible BSLLS form:
Value = "example";  // BSLLS:MultilingualStringUsingWithTemplate-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL222
// code without this diagnostic
// noqa-enable: BSL222

// bsl-disable: BSL222
// code without this diagnostic
// bsl-enable: BSL222

// BSLLS:MultilingualStringUsingWithTemplate-off
// code without this diagnostic
// BSLLS:MultilingualStringUsingWithTemplate-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

NStr in a multilingual configuration has different fragments for different languages. If you start a session under a language code that is not in the string passed to NStr, it will return an empty string. When used with StrTemplate, an empty string returned from NStr will throw an exception.

Sources