{"_id":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection","_rev":"2-e92e3caaab2263c7f7303f80be32ed58","name":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.4":{"name":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection","version":"1.0.4","author":{"name":"Zachary Levine","email":"zach@zjlevine.dev"},"license":"MIT","_id":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection@1.0.4","maintainers":[{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"}],"homepage":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection","bugs":{"url":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection/issues"},"dist":{"shasum":"6be2ea2850e2535b09fda279ee3d9f308a2c2bcf","tarball":"https://registry.npmjs.org/@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection/-/cz-conventional-changelog-with-jiraid-detection-1.0.4.tgz","fileCount":5,"integrity":"sha512-YXR3GN0ki7NsITJ9dezXa3zMnBhYRWPTU5ORnFBlB/vPu70dkgD2S27O2zvYHt236cqk0GfYrgqsP+mN9lbe9g==","signatures":[{"sig":"MEYCIQDTt7m0+qVaXDA4h1q37Pg4pwRo8T/SSp2rdg0FFxVo8wIhAPYz1nbZbGqFl6GiWxTmLch4kyriDXI/UuytTxDLFSda","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16225},"main":"index.js","config":{"commitizen":{"path":"./index.js"}},"engines":{"node":">= 10"},"gitHead":"967509d6176e0b0f57ef90efb2788faae3fa2f76","scripts":{"test":"mocha *.test.js","commit":"git-cz","format":"prettier --write *.js"},"_npmUser":{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"},"repository":{"url":"git+https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection.git","type":"git"},"_npmVersion":"10.9.2","description":"Commitizen adapter following the conventional-changelog format with an extra step to insert Jira ID. Forked to support detecting lower case Jira IDs","directories":{},"_nodeVersion":"23.6.0","dependencies":{"chalk":"^3.0.0","longest":"^2.0.1","word-wrap":"^1.0.3","commitizen":"^4.0.3","git-branch":"^2.0.1","lodash.map":"^4.5.1","conventional-commit-types":"^3.0.0"},"engineStrict":true,"_hasShrinkwrap":false,"devDependencies":{"chai":"4.3.6","mocha":"9.2.2","semver":"6.3.0","prettier":"1.19.1","@types/chai":"4.3.3","cosmiconfig":"5.2.1","@types/mocha":"9.1.1","mock-require":"3.0.3","semantic-release":"19.0.5","@semantic-release/git":"^10.0.1","@semantic-release/npm":"^9.0.1","@semantic-release/github":"^8.0.6","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/release-notes-generator":"^10.0.3"},"optionalDependencies":{"@commitlint/load":">6.1.1"},"_npmOperationalInternal":{"tmp":"tmp/cz-conventional-changelog-with-jiraid-detection_1.0.4_1737307435772_0.957420484778835","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection","version":"1.0.5","author":{"name":"Zachary Levine","email":"zach@zjlevine.dev"},"license":"MIT","_id":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection@1.0.5","maintainers":[{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"}],"homepage":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection","bugs":{"url":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection/issues"},"dist":{"shasum":"3914ddb8d22e8ac2085dbee7c7e4ecde607ea983","tarball":"https://registry.npmjs.org/@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection/-/cz-conventional-changelog-with-jiraid-detection-1.0.5.tgz","fileCount":5,"integrity":"sha512-Z5/2h/orZMay6RADg4fukbfobkxpI+VM7wJsD9+clxhq2A74htgwol2f9njlylEBftzDNY0WF8HRQYUyakJnJA==","signatures":[{"sig":"MEUCICsAhSpss2Y13lsACp9bfYLFGA2Co7nssDx1RUWsfK69AiEA0eYPj8kpmrpC0pvjnEOs2OEu6aaiZQZXlymTm3bcuq8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16415},"main":"index.js","config":{"commitizen":{"path":"./index.js"}},"engines":{"node":">= 10"},"gitHead":"60ac2fc3a36cf9c9e99224fcd214183b49b98f09","scripts":{"test":"mocha *.test.js","commit":"git-cz","format":"prettier --write *.js"},"_npmUser":{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"},"repository":{"url":"git+https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection.git","type":"git"},"_npmVersion":"10.9.2","description":"Commitizen adapter following the conventional-changelog format with an extra step to insert Jira ID. Forked to support detecting lower case Jira IDs","directories":{},"_nodeVersion":"23.6.0","dependencies":{"chalk":"^3.0.0","longest":"^2.0.1","word-wrap":"^1.0.3","commitizen":"^4.0.3","git-branch":"^2.0.1","lodash.map":"^4.5.1","conventional-commit-types":"^3.0.0"},"engineStrict":true,"_hasShrinkwrap":false,"devDependencies":{"chai":"4.3.6","mocha":"9.2.2","semver":"6.3.0","prettier":"1.19.1","@types/chai":"4.3.3","cosmiconfig":"5.2.1","@types/mocha":"9.1.1","mock-require":"3.0.3","semantic-release":"19.0.5","@semantic-release/git":"^10.0.1","@semantic-release/npm":"^9.0.1","@semantic-release/github":"^8.0.6","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/release-notes-generator":"^10.0.3"},"optionalDependencies":{"@commitlint/load":">6.1.1"},"_npmOperationalInternal":{"tmp":"tmp/cz-conventional-changelog-with-jiraid-detection_1.0.5_1737309320740_0.7398579425943235","host":"s3://npm-registry-packages-npm-production"}},"1.0.6":{"name":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection","version":"1.0.6","description":"Commitizen adapter following the conventional-changelog format with an extra step to insert Jira ID. Forked to support detecting lower case Jira IDs","main":"index.js","scripts":{"commit":"git-cz","test":"mocha *.test.js","format":"prettier --write *.js"},"homepage":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection","repository":{"type":"git","url":"git+https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection.git"},"engineStrict":true,"engines":{"node":">= 10"},"author":{"name":"Zachary Levine","email":"zach@zjlevine.dev"},"license":"MIT","dependencies":{"chalk":"^3.0.0","commitizen":"^4.0.3","conventional-commit-types":"^3.0.0","git-branch":"^2.0.1","lodash.map":"^4.5.1","longest":"^2.0.1","word-wrap":"^1.0.3"},"devDependencies":{"@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.6","@semantic-release/npm":"^9.0.1","@semantic-release/release-notes-generator":"^10.0.3","@types/chai":"4.3.3","@types/mocha":"9.1.1","chai":"4.3.6","cosmiconfig":"5.2.1","mocha":"9.2.2","mock-require":"3.0.3","prettier":"1.19.1","semantic-release":"19.0.5","semver":"6.3.0"},"optionalDependencies":{"@commitlint/load":">6.1.1"},"config":{"commitizen":{"path":"./index.js"}},"_id":"@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection@1.0.6","gitHead":"890dbe1719f3565d6b808e09ddaa72c830796eba","bugs":{"url":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection/issues"},"_nodeVersion":"23.6.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-CsvAhqnfLAdzr5QpV1MQ7lDvyhRy2qXJRnj5e+lXrI6cLNc8cUTm4WLW2Ps429Ng0uvGt9RCYfpGJm7YEDjUgA==","shasum":"9773c937f74d38e8b9c87b34c029aea8e0629dea","tarball":"https://registry.npmjs.org/@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection/-/cz-conventional-changelog-with-jiraid-detection-1.0.6.tgz","fileCount":5,"unpackedSize":16415,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDNXI40qVG60DEj3BoeMaJNaQpBwR+R08j7vkJNGIgkrgIhANE3lCZf6zRSajsfDYUQqSKeuORERbh67XoIQTpatjyH"}]},"_npmUser":{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"},"directories":{},"maintainers":[{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cz-conventional-changelog-with-jiraid-detection_1.0.6_1737309363511_0.9344230444404775"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-19T17:23:55.596Z","modified":"2025-01-19T17:56:03.894Z","1.0.4":"2025-01-19T17:23:56.011Z","1.0.5":"2025-01-19T17:55:20.940Z","1.0.6":"2025-01-19T17:56:03.699Z"},"bugs":{"url":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection/issues"},"author":{"name":"Zachary Levine","email":"zach@zjlevine.dev"},"license":"MIT","homepage":"https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection","repository":{"type":"git","url":"git+https://github.com/3ZsForInsomnia/cz-conventional-changelog-with-jiraid-detection.git"},"description":"Commitizen adapter following the conventional-changelog format with an extra step to insert Jira ID. Forked to support detecting lower case Jira IDs","maintainers":[{"name":"3zs4insomnia","email":"comrade.topanga@gmail.com"}],"readme":"# cz-conventional-changelog-with-jiraid-detection\n\n[![npm version](https://img.shields.io/npm/v/cz-conventional-changelog-with-jiraid-detection.svg?style=flat)](https://www.npmjs.org/package/cz-conventional-changelog-with-jiraid-detection)\n![ci](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection/workflows/ci/badge.svg)\n![npm downloads](https://img.shields.io/npm/dm/cz-conventional-changelog-with-jiraid-detection)\n\nA fork of [cz-conventional-changelog-with-jiraid-detection\n](https://github.com/DawChihLiou/cz-conventional-changelog-with-jiraid-detection) which is in turn a fork of [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog).\n\nPrompts for conventional changelog standard with an extra step to insert Jira ID. Jira ID is auto-detected from your branch name by default.\n\n![Demo](media/demo.gif)\n\nJira ID in the format of `/^[a-zA-Z0-9]+-[0-9]+\\$/`, \"ADR-123\" (or \"adr-123\") for example, will be automatically detected from the current branch name and be displayed as default at the prompt step. The step is optional so you can skip it if you do not have a Jira ID.\n\n## Install\n\nwith npm\n\n```npm install --save-dev @3zs4insomnia/cz-conventional-changelog-with-jiraid-detection```\n\nor with yarn\n\n```yarn add --dev @zs4insomnia/cz-conventional-changelog-with-jiraid-detection```\n\nTo enable it, please update your `package.config` as the following\n\n```json5\n\"config\": {\n    \"commitizen\": {\n      \"path\": \"./node_modules/@3zs4insomnia/cz-conventional-changelog-with-jiraid-detection\"\n    }\n  },\n```\n\n## Features\n\n- 🔥 It works with [semantic-release](https://semantic-release.gitbook.io/semantic-release/) and [Standard Version](https://github.com/conventional-changelog/standard-version) right out of the box.\n- 💚 It share the same configurtion with [commitlint](https://github.com/conventional-changelog/commitlint)'s default configuration.\n- 💆‍♀️ It prompts an optional step for inserting your Jira ID.\n- 🤖 It automatically detects Jira ID from your current branch name and display it as default value at the prompt step.\n- 📝 Jira ID is composed into the top of your commit message body.\n\n\n## Configuration\n\n### package.json\n\nLike commitizen, you specify the configuration of cz-conventional-changelog through the package.json's `config.commitizen` key.\n\n```json5\n{\n// ...  default values\n    \"config\": {\n        \"commitizen\": {\n            \"path\": \"./node_modules/cz-conventional-changelog\",\n            \"disableScopeLowerCase\": false,\n            \"disableSubjectLowerCase\": false,\n            \"maxHeaderWidth\": 100,\n            \"maxLineWidth\": 100,\n            \"defaultType\": \"\",\n            \"defaultScope\": \"\",\n            \"defaultSubject\": \"\",\n            \"defaultBody\": \"\",\n            \"defaultIssues\": \"\",\n            \"types\": {\n              ...\n              \"feat\": {\n                \"description\": \"A new feature\",\n                \"title\": \"Features\"\n              },\n              ...\n            }\n        }\n    }\n// ...\n}\n```\n\n### Environment variables\n\nThe following environment variables can be used to override any default configuration or package.json based configuration.\n\n- CZ_TYPE = defaultType\n- CZ_SCOPE = defaultScope\n- CZ_SUBJECT = defaultSubject\n- CZ_BODY = defaultBody\n- CZ_MAX_HEADER_WIDTH = maxHeaderWidth\n- CZ_MAX_LINE_WIDTH = maxLineWidth\n\n### Commitlint\n\nIf using the [commitlint](https://github.com/conventional-changelog/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.\n","readmeFilename":"README.md"}