Commits

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = Commits

[*.md]
BasedOnStyles = Vale, Commits

The name installs the latest release each time vale sync runs. To stay on v0.1.0, the release this page describes, give its URL instead:

Packages = https://github.com/jdkato/commits/releases/download/v0.1.0/Commits.zip

Assets 7

Files the package ships under config/, installed alongside its rules by vale sync.

• 6 templates
  • commitlint.tmpl
  • committed.tmpl
  • conform.tmpl
  • github.tmpl
  • gitlint.tmpl
  • hook.tmpl
• 1 view
  • Commit textfsm scopes: subject, gap, body, trailer

• Commits.Blank error existence scope: gap Style guide

  Separate the subject from the body with a blank line.

• Commits.Body error occurrence scope: body Style guide

  Commit body is empty.

• Commits.Body warning conditional scope: subject Style guide

  A body is mandatory except for 'docs', and runs at least 20 characters: explain why.

• Commits.Body error occurrence scope: body Style guide

  A body is required: say why.

• Commits.BodyIsMissing error occurrence scope: body Style guide

  B6 body-is-missing.

• Commits.BodyLength error Commits._shared.Wrap Style guide

  A body line runs past 100 characters from '%s'.

• Commits.BodyMaxLength error occurrence scope: body Style guide

  A body of %d characters, past body-max-length.

• Commits.BodyMaxLineLength error Commits._shared.Wrap Style guide

  B1 body-max-line-length: this line runs past 80 from '%s'.

• Commits.BodyMinLength error occurrence scope: body Style guide

  B5 body-min-length: a body of %d characters.

• Commits.BodyMinLength error occurrence scope: body Style guide

  A body of %d characters, under body-min-length.

• Commits.BodyTrailingWhitespace error existence scope: raw Style guide

  B2 body-trailing-whitespace.

• Commits.Breaking error existence scope: trailer Style guide

  '%s' is the one token the spec reads case-sensitively: write 'BREAKING CHANGE:'.

• Commits.BreakingBang error conditional scope: trailer Style guide

  A 'BREAKING CHANGE:' footer goes with a '!' in the header.

• Commits.Capital warning existence scope: subject Style guide

  The summary completes 'This change modifies Go to ...', so it does not start with a capital: '%s'.

• Commits.Capitalize error existence scope: subject Style guide

  Capitalize the subject line: '%s'.

• Commits.Capitalized error Commits._shared.Capitalized Style guide

  The summary is not capitalized: '%s'.

• Commits.Case error existence scope: subject Style guide

  A label is in capitals: '%s'.

• Commits.Closes error existence scope: trailer Style guide

  A Closes: tag takes a URL to the public report, not '%s'.

• Commits.Commit warning existence scope: body Style guide

  Refer to a commit by twelve or more characters of its SHA-1 and its summary: 'commit e21d2170f366 ("video: remove ...")'.

• Commits.DCO error Kernel.SignedOff Style guide

  Commit does not have a valid DCO: 'Signed-off-by: Name <email>'.

• Commits.Description error existence scope: subject Style guide

  A description follows the type: what the change does.

• Commits.DescriptionLength error Commitlint.SubjectLength Style guide

  Conventional commit description is %d characters, over descriptionLength.

• Commits.DisallowCleanupCommits error existence scope: subject Style guide

  CC2 contrib-disallow-cleanup-commits: '%s'.

• Commits.Exclamation error existence scope: subject Style guide

  No '!' before the colon; mark a breaking change with a 'BREAKING CHANGE:' footer.

• Commits.Fixes error existence scope: trailer Style guide

  A Fixes: tag carries at least 12 characters of the SHA-1 and the summary in parentheses: 'Fixes: 54a4f0239f2e ("KVM: MMU: ...")'.

• Commits.Footer warning existence scope: body Style guide

  '%s' is a footer. Put a blank line between the body and the footers.

• Commits.FooterLength error existence scope: trailer Style guide

  A footer line runs past 100 characters from '%s'.

• Commits.FooterMaxLength error occurrence scope: trailer Style guide

  Footers of %d characters, past footer-max-length.

• Commits.FooterRequired error occurrence scope: trailer Style guide

  A footer is required.

• Commits.FullStop error Commits._shared.Period Style guide

  A subject does not end with a period.

• Commits.HardTab error existence scope: raw Style guide

  T4/B3 hard-tab: a tab character.

• Commits.HeaderCase error existence scope: subject Style guide

  Commit header case is not lower: '%s'.

• Commits.HeaderCase error existence scope: subject Style guide

  header-case is lower-case: '%s'.

• Commits.HeaderLength error Commits._shared.SubjectLength Style guide

  Header is %d characters.

• Commits.HeaderLength error Commits._shared.SubjectLength Style guide

  A header of %d characters, past header-max-length.

• Commits.HeaderMinLength error occurrence scope: subject Style guide

  A header of %d characters, under header-min-length.

• Commits.Imperative warning existence scope: subject Style guide

  Write the subject as a command: 'Add', not '%s'.

• Commits.Intention error existence scope: subject Style guide

  Begin with a gitmoji, as the emoji or its ':shortcode:', then a space. '%s' is not one.

• Commits.InvalidLastCharacter error Commits._shared.Period Style guide

  Commit header ends in an invalid character.

• Commits.Issue warning existence scope: body, trailer Style guide

  Reference an issue as 'Fixes #12345' or 'Updates #12345', not '%s'.

• Commits.Jira error Jira.Key Style guide

  Commit header does not contain a Jira issue key from the configured projects.

• Commits.Key error occurrence scope: subject Style guide

  Include the issue key in the subject, in capitals: 'PROJ-123'.

• Commits.Length warning Commits._shared.SubjectLength Style guide

  A summary of %d characters; the kernel asks for no more than 70-75.

• Commits.Limit warning Commits._shared.SubjectLength Style guide

  A subject of %d characters. Shoot for 50; 72 is the hard limit.

• Commits.LineLength error Commits._shared.Wrap Style guide

  line_length: this line runs past 72 from '%s'.

• Commits.Lowercase error Commits._shared.TypeCase Style guide

  A type is lower-case: '%s'.

• Commits.MergeCommit error existence scope: subject Style guide

  merge_commit: '%s'.

• Commits.Message error existence scope: subject Style guide

  A message follows the intention: what the change does.

• Commits.NoFixup error existence scope: subject Style guide

  no_fixup: '%s'.

• Commits.NoWip error existence scope: subject Style guide

  no_wip: '%s'.

• Commits.Package error existence scope: subject Style guide

  Prefix the first line with the affected package: 'net/http: %s ...'.

• Commits.Period error Commits._shared.Period Style guide

  No period at the end of the summary.

• Commits.Period error Commits._shared.Period Style guide

  Do not end the subject line with a period.

• Commits.Placeholder warning existence scope: subject Style guide

  '%s' says nothing about the change. Say what it does.

• Commits.References error occurrence scope: raw Style guide

  Reference an issue somewhere in the message: '#123'.

• Commits.Revert error conditional scope: subject Style guide

  A revert names what it reverts in the body: 'This reverts commit <SHA>'.

• Commits.Scope error existence scope: subject Style guide

  A scope names a section of the codebase; '()' names nothing. Drop it or fill it.

• Commits.Scope error existence scope: subject Style guide

  '%s' is not one of the scopes: api, cli, docs.

• Commits.ScopeCase error existence scope: subject Style guide

  A scope is lower-case: '%s'.

• Commits.ScopeRequired error existence scope: subject Style guide

  A scope is required: '%s(scope):'.

• Commits.Sentence warning Commits._shared.Period Style guide

  The summary is not a complete sentence: no period at the end.

• Commits.SignedOff error occurrence scope: trailer Style guide

  Sign the patch off: git commit -s.

• Commits.Space error existence scope: subject Style guide

  A space follows the colon.

• Commits.SubjectCapitalized error existence scope: subject Style guide

  subject_capitalized: '%s'.

• Commits.SubjectCase error Commits._shared.Capitalized Style guide

  A subject does not open with a capital: '%s'.

• Commits.SubjectLength error Commits._shared.SubjectLength Style guide

  subject_length: a subject of %d columns.

• Commits.SubjectLength error occurrence scope: subject Style guide

  A subject of %d characters, outside subject-min-length and subject-max-length.

• Commits.SubjectNotPunctuated error existence scope: subject Style guide

  subject_not_punctuated: '%s'.

• Commits.Subsystem error existence scope: subject Style guide

  Prefix the summary with the subsystem: 'x86/mm: %s ...'.

• Commits.ThisPatch warning existence scope: subject, body Style guide

  Give the order, not the report: 'make xyzzy do frotz', not '%s makes'.

• Commits.TitleMaxLength error Commits._shared.SubjectLength Style guide

  T1 title-max-length: a title of %d characters.

• Commits.TitleMinLength error occurrence scope: subject Style guide

  T8 title-min-length: a title of %d characters.

• Commits.TitleMustNotContainWord error existence scope: subject Style guide

  T5 title-must-not-contain-word: '%s'.

• Commits.TitleTrailingPunctuation error existence scope: subject Style guide

  T3 title-trailing-punctuation: '%s'.

• Commits.Token error existence scope: body, trailer Style guide

  A footer token uses '-' in place of whitespace: 'Signed-off-by', not '%s'.

• Commits.Trailer error occurrence scope: trailer Style guide

  No trailer matched the required token, by default 'Signed-off-by: '.

• Commits.Truncated error Commits._shared.SubjectLength Style guide

  A subject of %d characters; GitHub truncates it past 72.

• Commits.Type error existence scope: subject Style guide

  Begin with one of the seven labels: 📦 NEW:, 👌 IMPROVE:, 🐛 FIX:, 📖 DOC:, 🚀 RELEASE:, 🤖 TEST:, ‼️ BREAKING:. '%s' is not one.

• Commits.Type error Commitlint.Type Style guide

  allowed_types: '%s' is not one of fix, feat, chore, docs, style, refactor, perf, test.

• Commits.Type error existence scope: subject Style guide

  '%s' is not an Angular type: build, ci, docs, feat, fix, perf, refactor, test, or revert.

• Commits.Type error existence scope: subject Style guide

  Start with a type, then a colon: 'fix: ...', 'feat(scope)!: ...'. '%s' is not one.

• Commits.Type error Commitlint.Type Style guide

  '%s' is not a commitizen type: build, bump, chore, ci, docs, feat, fix, perf, refactor, revert, style, test.

• Commits.Type error existence scope: subject Style guide

  '%s' is not a config-conventional type: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test.

• Commits.TypeCase error Commits._shared.TypeCase Style guide

  A type is lower-case: '%s'.

• Commits.Whitespace error existence scope: subject Style guide

  Whitespace at the edge of the subject.

• Commits.Wrap warning Commits._shared.Wrap Style guide

  Wrap the description at around 72 columns; this line runs on from '%s'.

• Commits.Wrap warning Commits._shared.Wrap Style guide

  Wrap the explanation at 75 columns; this line runs on from '%s'.

• Commits.Wrap warning Commits._shared.Wrap Style guide

  Wrap the body at 72 characters; this line runs on from '%s'.