\n\n> Commitizen adapter for formatting commit messages.\n> Format commit messages with [conventional commits].\n\ncz-vinyl allows you to easily use emojis and ticket ID (JIRA, ...) in your commits using [commitizen].\n\n```javascript\n? Select the type of changes you're committing: (Use arrow keys or type to search)\n> 🤖 chore: Build process or auxiliary tool changes\n 🚀 ci: CI related changes\n 📘 docs: Documentation only changes\n 🔥 feat: A new feature\n 🐞 fix: A bug fix\n ⚡ perf: A code change that improves performance\n 💡 refactor: A code change that neither fixes a bug or adds a feature\n```\n\n## Demo\n\n\n\n## OpenAI support\nAs from version `2.3.0` we now support OpenAI to generate your commit message! [Create your own OpenAI account](https://platform.openai.com/signup) and provide this library your API key token to use it.\n\n### Payment\nYou pay for your own requests to OpenAI API. The package uses the `3.5-turbo` model official model, that is ~15x times cheaper than GPT-4.\n\n## Installation\n\n**Globally**\n\n```bash\nnpm install --global cz-vinyl\n\n# set as default adapter for your projects\necho '{ \"path\": \"cz-vinyl\" }' > ~/.czrc\n```\n\n**Locally**\n\n```bash\nnpm install --save-dev cz-vinyl\n```\n\nAdd this to your `package.json`:\n\n```json\n\"config\": {\n \"commitizen\": {\n \"path\": \"cz-vinyl\"\n }\n}\n```\n\n## Usage\n\n```sh\n$ git cz\n```\n\n## ESM support\n\ncz-vinyl now supports **only** ESM modules, from version `>1.6.2`. For any issue regarding this, please visit this link https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n## Configuration\n\nLike commitizen, you can specify the configuration of cz-vinyl through various options.\nConfiguration can be set in environment variables or in the following files (the following files can also be configured in home directory):\n\n- a `package.json` property: `\"czvinyl\": {...}` or in `~/package.json`, for example\n- a `.czvinylrc` file in JSON or YAML format\n- a `.czvinylrc.json`, `.czvinylrc.yaml`, `.czvinylrc.yml`, `.czvinylrc.js`, or `.czvinylrc.cjs` file\n- a `inflint.config.ts`, `czvinyl.config.js`, or `czvinyl.config.cjs` CommonJS module exporting an object\n\nThe default commit types, descriptions and emoji that are used are:\n\n```json\n[\n\t{\n\t\t\"description\": \"Build process or auxiliary tool changes\",\n\t\t\"emoji\": \"🤖\",\n\t\t\"value\": \"chore\"\n\t},\n\t{\n\t\t\"description\": \"CI related changes\",\n\t\t\"emoji\": \"🚀\",\n\t\t\"value\": \"ci\"\n\t},\n\t{\n\t\t\"description\": \"Documentation only changes\",\n\t\t\"emoji\": \"📘\",\n\t\t\"value\": \"docs\"\n\t},\n\t{\n\t\t\"description\": \"A new feature\",\n\t\t\"emoji\": \"🔥\",\n\t\t\"value\": \"feat\"\n\t},\n\t{\n\t\t\"description\": \"A bug fix\",\n\t\t\"emoji\": \"🐞\",\n\t\t\"value\": \"fix\"\n\t},\n\t{\n\t\t\"description\": \"A code change that improves performance\",\n\t\t\"emoji\": \"⚡\",\n\t\t\"value\": \"perf\"\n\t},\n\t{\n\t\t\"description\": \"A code change that neither fixes a bug or adds a feature\",\n\t\t\"emoji\": \"💡\",\n\t\t\"value\": \"refactor\"\n\t},\n\t{\n\t\t\"description\": \"Create a release commit\",\n\t\t\"emoji\": \"🔖\",\n\t\t\"value\": \"release\"\n\t},\n\t{\n\t\t\"description\": \"Markup, white-space, formatting, missing semi-colons...\",\n\t\t\"emoji\": \"🎨\",\n\t\t\"value\": \"style\"\n\t},\n\t{\n\t\t\"description\": \"Adding missing tests\",\n\t\t\"emoji\": \"✅\",\n\t\t\"value\": \"test\"\n\t}\n]\n```\n\n| **Environment variable** | **Key** | **Type** | **Default** | **Description** |\n|---------------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| CZ_HEADER_FORMAT | `headerFormat` | `string` \\| `(commitType: string, scope: string \\| undefined, emoji: string \\| undefined, ticketId: string \\| undefined, subject: string) => string` | `{type}: {emoji} [{ticket_id}] {subject}` | How the commit header will be formatted. Supported placeholders: type, scope, emoji, ticket_id, subject |\n| CZ_BODY_FORMAT | `bodyFormat` | `string` \\| `(commitType: string, scope: string \\| undefined, ticketId: string \\| undefined, body: string \\| undefined) => string` | `{body}` | How the commit body will be formatted. Supported placeholders: type, scope, ticket_id, body |\n| | `commitTypes` | `{ value: string; description: string, emoji?: string }[]` | See above | The commit types to work with. |\n| CZ_MAX_COMMIT_LINE_WIDTH | `maxCommitLineWidth` | `number` | `72` | Wraps the commit body message with max line width |\n| CZ_TYPE_QUESTION | `typeQuestion` | `string` | `Select the type of changes you're committing:\\n` | The CLI question for type |\n| CZ_SCOPE_QUESTION | `scopeQuestion` | `string` | `Specify a scope:` | The CLI question for scope |\n| CZ_SKIP_SCOPE | `skipScope` | `boolean` | `true` | Whether to prompt the user to a scope question |\n| | `scopes` | `string[]` | `[]` | Available scopes (empty array allows free text) |\n| CZ_TICKET_ID_QUESTION | `ticketIdQuestion` | `string` | `Type the JIRA Id (ex. V-12345):` | The CLI question for ticket ID |\n| CZ_SKIP_TICKET_ID | `skipTicketId` | `boolean` | `false` | Whether to prompt the user to a ticket ID question |\n| CZ_TICKET_ID_REGEX | `ticketIdRegex` | `string` | `((?
![\"CI](\"https://img.shields.io/github/actions/workflow/status/tal-rofe/cz-vinyl/integrate.yaml?label=CI&logo=GitHub\")
\n \t\n\t\n \t![\"npm](\"https://img.shields.io/npm/dm/cz-vinyl?logo=NPM\")
\n \t\n\t\n \t![\"npm](\"https://img.shields.io/npm/l/cz-vinyl\")
\n \t\n\t\n \t![\"version\"](\"https://img.shields.io/npm/v/cz-vinyl?label=version\")
\n \t\n![](\"assets/logo.png\"/){kind=logo}