Skip to content

BSL211 — Metadata object names must not exceed the allowed length

← All rules

Summary

Metadata object names must not exceed the allowed length

Identifiers

Field Value
Rule code BSL211
Compatible alias MetadataObjectNameLength
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags naming, convention

Behavior

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

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

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

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

Metadata object names must not exceed 80 characters.

In addition to problems using these objects, there are problems with uploading the configuration to files.

Examples

LooooooooooooooooooooooooooooooooooooooooooooooooooooooooongVeryLongDocumentName

Sources

Standard: Name, synonym, comment (RU)