Development: Conventional Commit Breaking Marker Tool

Description

Parse a restricted Conventional Commit header.

Conventional Commit metadata can signal type, scope and a breaking change in a header or footer. A local header parser covers only its stated syntax and does not determine the actual compatibility impact of a change.

Parse a restricted Conventional Commit header.

When to use this tool

Use Development: Conventional Commit Breaking Marker when splitting a supplied commit header under the documented grammar.

How to use the tool and how it works

Enter header. Use the units and conventions below.
Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
Read result. Expand result to inspect the returned fields.

Parse a restricted Conventional Commit header. Accept lowercase type, optional nonempty parenthesized scope, optional exclamation mark, colon-space and nonempty single-line description; return components and breaking flag.^[1]

Conventional Commits allows a breaking-change signal in a header or footer. This helper inspects only the supplied header.^[2]

Input field	Meaning and units	Accepted input
header	Header	Required. Text. Implementation limit: 8192 Unicode code points and 16384 UTF-16 code units.

Output field	Interpretation	Returned shape
result	Returned object; expand its named members below.	Required. Object.
result.type	Type	Calculated result member: string.
result.scope	Scope	Calculated result member: string.
result.breaking	Breaking	Calculated result member: boolean.
result.description	Description	Calculated result member: string.

json

{
  "input": {
    "header": "feat(api)!: remove endpoint"
  },
  "output": {
    "result": {
      "type": "feat",
      "scope": "api",
      "breaking": true,
      "description": "remove endpoint"
    }
  }
}

Limitations and assumptions

Only the header mark is checked; body/footer BREAKING CHANGE declarations are not parsed.
Outputs are nested inside result. Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Use a complete commit-message parser and review the underlying change before deriving release or compatibility decisions.

References

Calculation and input contract: development/conventional-commit-breaking-marker — tool.io
Conventional Commits 1.0.0 — Conventional Commits

Similar or alternative tools

SemVer Range Empty Intersection Witness
Check whether supplied numeric version bounds intersect.
SemVer Prerelease Numeric Token
Inspect prerelease identifier syntax and numeric leading zeros.