Skip to content

BSL168 — Unrecommended common module name

← All rules

Summary

Unrecommended common module name

Identifiers

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

Behavior

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

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

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

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

It is not recommended to use the words "Procedures", "Functions", "Handlers", "Module", "Functionality" in the name of the general module.

Examples

Sources