Skip to content

BSL159 - Common module invalid type

← All rules

Summary

Common module invalid type

Identifiers

Field Value
Rule code BSL159
Compatible alias CommonModuleInvalidType
Severity ERROR
Without configuration Yes
BSLLS JSON, ON mode without overrides Yes
Registry flag implemented Yes
Tags design, module

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

Behavior

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

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

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

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

When developing common modules, you should choose one of four code execution contexts:

Common module type Naming example Server call Server External connection Client (Ordinary application) Client (Managed application)
Server-side Common (or CommonServer) + + +
Server-side to call from client CommonServerCall + +
Client-side CommonClient (or CommonGlobal) + +
Client-server CommonClientServer + + + +

Examples

Sources