Skip to content

BSL162 - Missed postfix "Client"

← All rules

Summary

Missed postfix "Client"

Identifiers

Field Value
Rule code BSL162
Compatible alias CommonModuleNameClient
Severity INFORMATION
Without configuration Yes
BSLLS JSON, ON mode without overrides Yes
Registry flag implemented Yes
Tags convention, naming, module

The implemented flag describes the registry; it does not certify verified BSLLS parity.

Behavior

  • The public identifier BSL162 and alias CommonModuleNameClient 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 = ["BSL162"]
ignore = ["CommonModuleNameClient"]

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: BSL162
  • bsl-disable:
Value = "example";  // bsl-disable: BSL162
  • compatible BSLLS form:
Value = "example";  // BSLLS:CommonModuleNameClient-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: BSL162
// code without this diagnostic
// noqa-enable: BSL162

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

// BSLLS:CommonModuleNameClient-off
// code without this diagnostic
// BSLLS:CommonModuleNameClient-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

Client common modules contain client business logic (functionality specific to the client only) and have the following features:

  • Client (Managed application)
  • Client (Ordinary application)

In cases where client methods should be available only in managed application mode (or only in regular application mode or only in external connection mode), a different combination of these two features is allowed.

Client common modules are named with the "Client" postfix ( "Клиент" in Rus). Except when the Global flag is on.

Examples

FilesClient, CommonClient, StandardSubsystemsClient

Sources

Standard: Modules (RU)