Bash

Scans document to detect existing header presence and boundaries.

Scans document to detect existing header presence and boundaries

Parameters

comments

Array of comment prefixes [opener, middle, closer]

Returns

true if valid header found, false if no/broken header, undefined on error

Searches the document within maxScanLength lines for header opener and closer patterns. Sets headerInnerStart and headerInnerEnd properties when valid header is found. Detects broken headers (mismatched/missing opener/closer).

Determines insertion line offset for header placement

Parameters

document

VS Code text document to analyze

Returns

Line number where header should be inserted (0 or 1)

Detects the presence of shebang (#!) lines at the start of the document and returns appropriate insertion offset. Shebangs must remain as the first line of executable scripts, so headers are inserted after them when present.

script with shebang:

#!/bin/bash
# Header inserted here (line 1)