Literal Line Comment Prefix Toggle
Toggle a literal comment prefix at column zero for all hard lines: remove only when every line has it, otherwise add to all.
Description
Toggle a literal comment prefix at column zero for all hard lines: remove only when every line has it, otherwise add to all.
A line-comment toggle adds or removes one literal prefix consistently across a block. Its decision depends on whether every parsed line already begins with that prefix.
When to use this tool
Toggle a literal comment prefix at column zero for all hard lines: remove only when every line has it, otherwise add to all.
- Prepare the supplied text, prefix fields for this operation.
- Compare the complete example with the representation used by your own input before carrying the result into another step.
How to use the tool and how it works
- Enter text, prefix. Use the exact text syntax, units and index conventions explained below.
- Run the tool. If input validation fails, correct the supplied fields before interpreting any result.
- Read result.action, result.text. Interpret false, null and empty lists using the distinctions below; they can be valid outputs.
Require a nonempty prefix without CR/LF. If all line contents start with it, remove one prefix from each; otherwise add it to every line. Preserve each original newline spelling.1
| Input field | Meaning and representation | Accepted input |
|---|---|---|
| text | text. | Text; at most 8,192 UTF-16 code units, subject to the grammar above |
| prefix | prefix. | Text; at most 8,192 UTF-16 code units, subject to the grammar above |
| Output field | Interpretation |
|---|---|
| result | Object containing the named outputs below. |
| result.action | The action value under the stated formula or text convention. |
| result.text | The text value under the stated formula or text convention. |
{
"input": {
"text": "a\nb",
"prefix": "# "
},
"output": {
"result": {
"action": "add",
"text": "# a\n# b"
}
}
}Limitations and assumptions
- Prefixes are checked at column one, before indentation handling. A terminal newline creates an empty final line in the line model, which also participates in the toggle decision.
- Text offsets and lengths use UTF-16 code units unless explicitly described as bytes or code points. CRLF, CR and LF are recognized as line endings; a terminal newline creates a final empty line in the shared line model.
- Every declared top-level field is required and unexpected fields are rejected. Numeric inputs must be finite; ordinary text fields are bounded to 8,192 UTF-16 code units, with tighter operation-specific limits where stated.
- Ordinary string lists have at most 128 entries of at most 128 code units each; numeric lists and matrices have separate bounded size checks. Nonfinite results and excessively large serialized outputs are rejected.
- Indexes are zero-based and spans have an exclusive end unless explicitly stated otherwise. A valid false, null or empty-list result is distinct from malformed input.
Alternative or Complementary methods
Use a parser or language-aware editor when quoting, syntax or nested constructs matter. For plain text transforms, keep UTF-16 offsets, Unicode code points, grapheme clusters and UTF-8 byte offsets distinct; apply changes to the same source version used to calculate spans.
References
Similar or alternative tools
- Literal Line Prefix Filter
Filter hard-line contents by an exact literal prefix; preserve source line numbers and offsets, without regex interpretation.
- Consecutive Duplicate Line Collapser
Collapse only consecutive identical line contents, retaining each kept line separator; nonadjacent duplicates remain.