cz-iconic-commits

Part of the Iconic Commits family. Prompts for the Iconic Commits standard.

Configuration

package.json

Like commitizen, you specify the configuration of cz-iconic-commits through the package.json's config.commitizen key.

{
// ...  default values
    "config": {
        "commitizen": {
            "path": "./node_modules/cz-iconic-commits",
            "disableScopeLowerCase": false,
            "disableSubjectLowerCase": false,
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultIntention": "",
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "types": [
              ...
              {
                "name": "feat",
                "description": "A new feature",
                "title": "Features",
              },
              ...
            ],
            "intentions": [
              ...
              {
                "emoji": "😎",
                "entity": "😎",
                "code": ":sunglasses:",
                "description": "Write code like a boss.",
                "name": "sunglasses",
                "defaultType": null,
                "semver": null,
              },
              ...
            ]
        }
    }
// ...
}

Environment variables

The following environment variables can be used to override any default configuration or package.json based configuration.

• CZ_INTENTION = defaultIntention
• CZ_TYPE = defaultType
• CZ_SCOPE = defaultScope
• CZ_SUBJECT = defaultSubject
• CZ_BODY = defaultBody
• CZ_MAX_HEADER_WIDTH = maxHeaderWidth
• CZ_MAX_LINE_WIDTH = maxLineWidth

Commitlint

If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.