Skip to content

VBC-103: ascii-art-block

warning

Category: docs
Analysis: Regex (whole file)
File types: .js, .ts, .tsx, .py, .sh, .go, .rs, .java, .c, .cpp, .cs, .kt, .swift, .rb, .astro
Scope: comments only
Tags: docs style

What it reports

Block of decoration at line {line}: three or more comment lines that are shape and nothing else. A rule around a section heading is punctuation and is not reported; a banner is furniture that has to be maintained.

Flagged

py
# ####################
# ####################
# ####################
js
// ####################
// ####################
// ####################

Not flagged

py
# --------------------------------
# Shared fixtures from public data
# --------------------------------
py
# ------------------------------
py
# - handles retries

Pattern

regex
(?:^[ \t]*(?:#|//)(?=[^\nA-Za-z0-9]*$)[^\n]*[-=*#_|/\\+~^]{6,}[^\n]*$\n){3,}

Released under the MIT License.