summaryPunctuation
Reports changeset summaries that don't match the configured ending punctuation.
✅ This rule is included in the changesets stylistic presets.
Changesets copies the summary of each changeset into the CHANGELOG.md of every package it releases.
Ending every summary the same way makes those changelog entries consistent to read.
This rule checks the end of the first paragraph of a changeset’s summary.
By default, it reports summaries that don’t end with a period, exclamation mark, or question mark, and adds a period when run with --fix.
Examples
Section titled “Examples”---"example-package": minor---
Added a new option---"example-package": minor---
Added the following options
- `first`- `second`---"example-package": minor---
Added a new option.---"example-package": minor---
Added the following options:
- `first`- `second`Options
Section titled “Options”punctuation
Section titled “punctuation”Type:
"always" | "never"Default:
"always"
Whether changeset summaries must end with punctuation.
With "never", this rule reports trailing periods, exclamation marks, question marks, and ellipses, and removes them when run with --fix.
changesets.rules({ summaryPunctuation: { punctuation: "never", },});---"example-package": minor---
Added a new option.---"example-package": minor---
Added a new optionWhen Not To Use It
Section titled “When Not To Use It”If you don’t mind inconsistent punctuation in your changelog summaries, this rule might not be for you. If your project’s changesets are written by many contributors and you don’t review changelog entries for consistency, this rule may produce reports that nobody acts on. You might prefer to leave this rule disabled until your project reviews changelog formatting.