BSL161 — Missed postfix "Cached"

← All rules

Summary

Missed postfix "Cached"

Identifiers

Field	Value
Rule code	BSL161
Compatible alias	CommonModuleNameCached
Severity	INFORMATION
Enabled by default	Yes
Implemented	Yes
Tags	convention, naming, module

Behavior

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

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: BSL161

• bsl-disable:

Value = "example";  // bsl-disable: BSL161

• compatible BSLLS form:

Value = "example";  // BSLLS:CommonModuleNameCached-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: BSL161
// code without this diagnostic
// noqa-enable: BSL161

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

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

Use the "Cached" (rus. ПовтИсп) and "ClientCached" (rus. КлиентПовтИсп) postfixes for the modules that implement functions with repeated use of return values (upon the call or session time) on the server and on the client respectively.

Examples

FilesClientCached, UsersInternalCached

Sources

Standard: Rules for creating common modules (RU)