commitizen / cz-conventional-changelog

A commitizen adapter for the angular preset of https://github.com/conventional-changelog/conventional-changelog
MIT License
767 stars 442 forks source link

Documentation for `config.commitizen` settings and custom configuration file support #222

Open wojtekKrol opened 3 months ago

wojtekKrol commented 3 months ago

Hi,

I am having difficulty finding documentation for the settings available under config.commitizen for cz-conventional-changelog.

The official documentation states:

"Like Commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key."

However, I have not been able to find comprehensive documentation for the available settings.

Additionally, I attempted to use a custom configuration file by setting up the following in my package.json:

"config": {
  "commitizen": {
    "path": "./node_modules/cz-conventional-changelog",
    "config": "./.cz-config.mjs"
  }
}

In .cz-config.mjs, I have custom settings, but it does not seem to work as expected. Here is a sample of my .cz-config.mjs:

export default {
  types: [
    { value: 'feat', name: 'feat:     A new feature' },
    { value: 'fix', name: 'fix:      A bug fix' },
    { value: 'docs', name: 'docs:     Documentation only changes' },
    // other types
  ],
  scopes: [
    { name: 'module1' },
    { name: 'module2' },
    { name: 'module3' }
  ],
  // other settings
};

Can you please provide detailed documentation for the available settings under config.commitizen and clarify if custom configuration files like .cz-config.mjs are supported?

Thank you!