Skip to content

BSL017 — Export methods in command and general command modules

← All rules

Summary

Export methods in command and general command modules

Identifiers

Field Value
Rule code BSL017
Compatible alias CommandModuleExportMethods
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags design

Behavior

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

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

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

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

You should not place export methods in command and General command modules. You can't access these modules from code external to them, so export methods in these modules do not make sense.

Sources