Skip to content

docs: fix parserPreset docs #4532

@thebitbesi

Description

@thebitbesi

Steps to Reproduce

Hello,

On this page: https://commitlint.js.org/reference/examples.html , I couldn’t find which parserPreset is being used. I assume it might be "conventional-changelog-conventionalcommits". Could you please clarify the correct name to use and how to configure it?

It would also be helpful to mention that this parser follows the specification here: https://github.com/conventional-changelog/conventional-changelog-config-spec

Additionally, it would be great if you could explain how to share this parser configuration with other tools, like semantic-release.

Semantic-release explained some details about parserOpts and presetConfig for the "conventional-changelog-conventionalcommits" preset would be very useful: https://github.com/semantic-release/commit-analyzer

Thank you very much for your help!

Current Behavior

No response

Expected Behavior

Documentation is clear:

  • How to use parserPreset, parserOpts, presetConfig.
  • How to use a shared presetConfig (with semantic-release, for example).

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

No response

commitlint --version

latest

git --version

latest

node --version

latest

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions