{"_id":"@altar-io/cz-conventional-changelog-jira","_rev":"4-2efac0e60193f99f619ae517b48f21d4","time":{"created":"2022-10-25T23:23:16.762Z","0.0.0-semantically-released":"2022-10-25T22:48:25.929Z","modified":"2023-01-02T16:42:55.701Z","1.0.0":"2022-10-25T23:23:17.095Z","1.0.1":"2023-01-02T16:42:55.601Z"},"name":"@altar-io/cz-conventional-changelog-jira","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@altar-io/cz-conventional-changelog-jira","version":"1.0.0","description":"Commitizen adapter following the conventional-changelog format and also asking for JIRA issue.","main":"index.js","scripts":{"commit":"git-cz","test":"mocha *.test.js","format":"prettier --write *.js","semantic-release":"semantic-release"},"homepage":"https://github.com/altario/cz-conventional-changelog-jira","repository":{"type":"git","url":"git+https://github.com/altario/cz-conventional-changelog-jira.git"},"engineStrict":true,"engines":{"node":">= 10"},"author":{"name":"André Pinto","email":"a.pinix@gmail.com"},"license":"MIT","dependencies":{"boxen":"^5.1.2","chalk":"^2.4.1","commitizen":"^4.2.5","cz-conventional-changelog":"^3.3.0","inquirer":"^8.2.5","lodash.map":"^4.6.0","longest":"^2.0.1","right-pad":"^1.0.1","word-wrap":"^1.2.3","@commitlint/load":">6.1.1"},"devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^5.2.7","chai":"^4.3.6","cosmiconfig":"^5.2.1","mocha":"^10.1.0","mock-require":"^3.0.3","prettier":"^2.7.1","semantic-release":"^19.0.5","semver":"^6.2.0"},"optionalDependencies":{"@commitlint/load":">6.1.1"},"release":{"branches":["main"]},"config":{"commitizen":{"path":"./index.js","jiraMode":false,"skipScope":true}},"publishConfig":{"access":"public"},"gitHead":"e418bd0aefa2d44632d00ba884c94040c3df3ab8","bugs":{"url":"https://github.com/altario/cz-conventional-changelog-jira/issues"},"_id":"@altar-io/cz-conventional-changelog-jira@1.0.0","_nodeVersion":"16.17.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-mjO3TlqqSkLkzL8QTdOWEp95xUApI9C2Q7wSURIWYiwdXF9CRuWpPh0q1u2mxX3WyXLFHo/synx0r4jOJ+w+1A==","shasum":"def686904156d3829af4d11f0486251b388ccb06","tarball":"https://registry.npmjs.org/@altar-io/cz-conventional-changelog-jira/-/cz-conventional-changelog-jira-1.0.0.tgz","fileCount":13,"unpackedSize":2034207,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCtA+chUo/EJxfT1H++ceVQvo+Ob0aBaazZyrYcB8FVXQIgJ2ioWbrtesDw/P5anY50om1Uvgwy5p1qfana1OwjVHY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWG/lACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq1GhAAnex3v42hOVcY9ckTwYEsfD6u89f7M4lZDMYluHGJyC+EdTX5\r\nrWGYdynD7xh6un/6FXaA2MpRwm+14YE+qI9VvQ0wMtq7nIAQtdxAD6MmflTV\r\nHXdg32UmtPx7Pb1JV//WWDPN6Wlzob5sXSMNdBxirbqT3CQEMO1pyoBd+kvU\r\nVex8KHLwPJ6Ih2+eKOg738qOfZ7voG9lyklhf8ZWxFpVTPjREiviTubr6vo2\r\niSJy2J2HwoQvp7dLchcmKWGeUFLywRPMDLmkZXJt/+av2jHQ/PtPzWpJY4Vz\r\nEzdXc2t5jZKVnO7EKYSTf06VQw19os4FQCiXhqO8hjFf+nf+vb9AEb1h0AFf\r\nL+zOMRQ/r6hirkg2at7R3gCJGQMTP/DIIiczrdfDnkyzQs5SrTVt1wRz54kj\r\nF4gI4D6nGX4Pc7Pnfy2jl5Btpidta8L3GjjPDmXAjY0dDNbLZ3HfIJGnaEO+\r\nFsAv809bWY8zuOIYR2qEIE5arhjAYrZ7WEUUTCvY4FCE0EI/jF/TduZWXOdy\r\n9RuX7AL6FRzqWaxOle9sGobcxzZss2/XpsFMromhlQXKiQAcz94Q6hGAAEdm\r\nMyUcAE0YaOi8Q7ioog7+X2dXRuy0n/3KH7NCeXhbiY2NaUpO1R9PxS1/gUfU\r\nMK7C71lLfnHqnGTtkk1Kj/epyJAxW66FI4s=\r\n=1AW0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"altariotechnologies","email":"accounts@altar.io"},"directories":{},"maintainers":[{"name":"altariotechnologies","email":"accounts@altar.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cz-conventional-changelog-jira_1.0.0_1666740196820_0.3119420102509711"},"_hasShrinkwrap":false},"1.0.1":{"name":"@altar-io/cz-conventional-changelog-jira","version":"1.0.1","description":"Commitizen adapter following the conventional-changelog format and also asking for JIRA issue.","main":"index.js","scripts":{"commit":"git-cz","test":"mocha *.test.js","format":"prettier --write *.js","semantic-release":"semantic-release"},"homepage":"https://github.com/altario/cz-conventional-changelog-jira","repository":{"type":"git","url":"git+https://github.com/altario/cz-conventional-changelog-jira.git"},"engineStrict":true,"engines":{"node":">= 10"},"author":{"name":"André Pinto","email":"a.pinix@gmail.com"},"license":"MIT","dependencies":{"boxen":"^5.1.2","chalk":"^2.4.1","commitizen":"^4.2.5","cz-conventional-changelog":"^3.3.0","inquirer":"^8.2.5","lodash.map":"^4.6.0","longest":"^2.0.1","right-pad":"^1.0.1","word-wrap":"^1.2.3","@commitlint/load":">6.1.1"},"devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^5.2.7","chai":"^4.3.6","cosmiconfig":"^5.2.1","mocha":"^10.1.0","mock-require":"^3.0.3","prettier":"^2.7.1","semantic-release":"^19.0.5","semver":"^6.2.0"},"optionalDependencies":{"@commitlint/load":">6.1.1"},"release":{"branches":["main"]},"config":{"commitizen":{"path":"./index.js","jiraMode":false,"skipScope":true}},"publishConfig":{"access":"public"},"gitHead":"b53d362d9a86f42022fe0e355db3fd6a2588aa59","bugs":{"url":"https://github.com/altario/cz-conventional-changelog-jira/issues"},"_id":"@altar-io/cz-conventional-changelog-jira@1.0.1","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-846XJfcK4XSbntfto2kRBgH3AGsBn51scvTI6mw3zyKJg/j8eS1+e2N+nHZSrdYGYXbQsmhFUwepsL9YHFo75w==","shasum":"392165a257491371404a7e4ef5c90600bffe00d0","tarball":"https://registry.npmjs.org/@altar-io/cz-conventional-changelog-jira/-/cz-conventional-changelog-jira-1.0.1.tgz","fileCount":13,"unpackedSize":2034578,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEfAP6Uo2ZrvXvn8xJuYCVep7wG94AD7i7eh0t7tbV0dAiBwVoknpFPPcOohrvEYfAdMfCOLtAnbmgYd1VRGTP+NcA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjswmPACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqGYw//UAlDTgwc//55ArDrx8yk3TunOEP1TRP5O58JnscN9uK4vKu5\r\nE5YUZPXY2T7B5CWjZ5KMNpuL7al+lbK4QE4bTdNMf9YGi4Z0UI64uKL1DegR\r\nxFw7GZLANj+uUtHRMK1YLDA1epmAaSfPqr5TvQxu3T24K6lpdOkMS9Tpmdkr\r\nOTE1WhxzFzn8lxY24NrDG74HCUmhhWYKHdLOrezZvYunieyiIIRCDJPKb/wY\r\n4WfQYj+kXtM5J/BKuzmtluUUznId9/hfjcfHWPdTNWsV26mfUOYuE22xnfSp\r\n0yL4KyE9obM6YRN5YMuQ+mLVj+Z62yklfEFSO0WgrTqclDt00blaw0LnPcuv\r\n+BpH+qU8DDZJErhL8d28w2IlN37I9e+oRUDxMLBKJiIObxcYeCFyJrTG9IkI\r\nLNA5cFcwmL6UTcYkG6Qt0C7+336kjS484jkFGcYO/VQGTOvq+MZqLQWPgAsc\r\nK0qx3GKMcm5XWlWN6xBv9X+H+n1XVAtipsMfpIoMzoDJhZQzJuE9ZD9RTPN9\r\nhi/hROMkuPSTTvqsD8CeDME/7AAxt//23ZqKyHtR41knXOwDys3Y3K4aVPkF\r\nAaC8ZNt4QONrfxpknPUSj8A3cBmg44ozg33qKAUZODTDbSPHAxunN4om0nz8\r\n0LZr0uuygN2S/pz84P3MBFZ6ERyRRG0fSnc=\r\n=N3Uw\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"altariotechnologies","email":"accounts@altar.io"},"directories":{},"maintainers":[{"name":"altariotechnologies","email":"accounts@altar.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cz-conventional-changelog-jira_1.0.1_1672677775355_0.7113097656612091"},"_hasShrinkwrap":false}},"maintainers":[{"name":"altariotechnologies","email":"accounts@altar.io"}],"description":"Commitizen adapter following the conventional-changelog format and also asking for JIRA issue.","homepage":"https://github.com/altario/cz-conventional-changelog-jira","repository":{"type":"git","url":"git+https://github.com/altario/cz-conventional-changelog-jira.git"},"author":{"name":"André Pinto","email":"a.pinix@gmail.com"},"bugs":{"url":"https://github.com/altario/cz-conventional-changelog-jira/issues"},"license":"MIT","readme":"# cz-conventional-changelog-jira\n\nPart of the [commitizen](https://github.com/commitizen/cz-cli) family. Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard and also prompts for a mandatory JIRA issue.\n\n\n\n\n\n## Features\n\n- Works seamlessly with semantic-release 🚀\n- Works seamlessly with Jira smart commits\n- Automatically detects the Jira issue from the branch name\n\n## Preview\n\n![preview](/images/demo.gif)\n\n## Quickstart\n\n### Installation\n\n```bash\nnpm install commitizen @altar-io/cz-conventional-changelog-jira --save-dev\n```\n\nand then add the following to package.json:\n\n```json\n{\n \"scripts\": {\n \"commit\": \"git-cz\"\n },\n \"config\": {\n \"commitizen\": {\n \"path\": \"./node_modules/@altar-io/cz-conventional-changelog-jira\"\n }\n }\n}\n```\n\n### Usage\n\n![Gif of terminal when using cz-conventional-changelog-jira](https://raw.githubusercontent.com/altar.io/cz-conventional-changelog-jira/master/images/demo.gif)\n\n## Configuration\n\nLike commitizen, you can specify the configuration of cz-conventional-changelog-jira through the package.json's `config.commitizen` key, or with environment variables.\n\n| Environment variable | package.json | Default | Description |\n| ----------------------- | ------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| CZ_JIRA_MODE | jiraMode | true | If this is set to true, CZ will ask for a Jira issue and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. |\n| CZ_MAX_HEADER_WIDTH | maxHeaderWidth | 72 | This limits how long a commit message head can be. |\n| CZ_MIN_HEADER_WIDTH | minHeaderWidth | 2 | This limits how short a commit message can be. |\n| CZ_MAX_LINE_WIDTH | maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. |\n| CZ_SKIP_SCOPE | skipScope | true | If scope should be used in commit messages. |\n| CZ_SKIP_DESCRIPTION | skipDescription | false | If description should be used in commit messages. |\n| CZ_SKIP_BREAKING | skipBreaking | false | If breaking changes should be used in commit messages. |\n| | scopes | undefined | A list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'. |\n| CZ_TYPE | defaultType | undefined | The default type. |\n| CZ_SCOPE | defaultScope | undefined | The default scope. |\n| CZ_CUSTOM_SCOPE | customScope | false | Whether user can provide custom scope in addition to predefined ones. |\n| CZ_SUBJECT | defaultSubject | undefined | A default subject. |\n| CZ_BODY | defaultBody | undefined | A default body. |\n| CZ_ISSUES | defaultIssues | undefined | A default issue. |\n| CZ_JIRA_OPTIONAL | jiraOptional | false | If this is set to true, you can leave the JIRA field blank. |\n| CZ_JIRA_PREFIX | jiraPrefix | \"ALT\" | If this is set it will be will be displayed as the default JIRA ticket prefix. |\n| CZ_JIRA_MULTIPLE_ISSUES | jiraMultipleIssues | true | If this is set to false, you'll be able to input multiple JIRA tickets (ex: ALT-1, ALT-2, ALT-3) |\n| CZ_JIRA_EMOJI_TYPES | jiraEmojiTypes | false | If this is set to true, commit types have emoji (ex: 🐛). Easier to spot the type. |\n| CZ_JIRA_LOCATION | jiraLocation | \"pre-description\" | Changes position of JIRA ID. Options: `pre-type`, `pre-description`, `post-description`, `post-body`. |\n| CZ_JIRA_PREPEND | jiraPrepend | \"\" | Prepends JIRA ID with an optional decorator. e.g.: `[ALT-123`. |\n| CZ_JIRA_APPEND | jiraAppend | \"\" | Appends JIRA ID with an optional decorator. e.g.: `ALT-123]`. |\n| CZ_EXCLAMATION_MARK | exclamationMark | false | On breaking changes, adds an exclamation mark (!) after the scope, e.g.: `type(scope)!: break stuff`. When activated, reduces the effective allowed header length by 1. |\n\n### Jira Location Options\n\npre-type:\n\n```text\nJIRA-123 type(scope): commit subject\n```\n\npre-description:\n\n```text\ntype(scope): JIRA-123 commit subject\n```\n\npost-description:\n\n```text\ntype(scope): commit subject JIRA-123\n```\n\npost-body:\n\n```text\ntype(scope): commit subject\n\nJIRA-123\n```\n\n```text\ntype(scope): commit subject\n\nthis is a commit body\n\nJIRA-123\n```\n\n## Dynamic Configuration\n\nAlternatively, if you want to create your own profile, you can use the _configurable_ approach.\nHere is an example:\n`./cz-config.js`\n\n```javascript\nconst custom = require('@altar-io/cz-conventional-changelog-jira/configurable');\n// You can do this optionally if you want to extend the commit types\nconst defaultTypes = require('@altar-io/cz-conventional-changelog-jira/types');\n\nmodule.exports = custom({\n types: {\n ...defaultTypes,\n perf: {\n description: 'Improvements that will make your code perform better',\n title: 'Performance',\n },\n },\n skipScope: false,\n scopes: ['myScope1', 'myScope2'],\n customScope: true,\n});\n```\n\n**./package.json**\n\n```json\n{\n \"config\": {\n \"commitizen\": {\n \"path\": \"./cz-config.js\"\n }\n }\n}\n```\n\nThis example would:\n\n- Display _\"perf\"_ as an extra commit type\n- Ask you to add a commit scope\n- Limit the scope selection to either `myScope` or `myScope2`\n\nList of all supported configurable options when using the _configurable_ approach:\n\n| Key | Default | Description |\n| ------------------ | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| jiraMode | true | If this is set to true, CZ will ask for a Jira issue and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. |\n| maxHeaderWidth | 72 | This limits how long a commit message head can be. |\n| minHeaderWidth | 2 | This limits how short a commit message can be. |\n| maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. |\n| skipScope | true | If scope should be used in commit messages. |\n| defaultType | undefined | The default type. |\n| defaultScope | undefined | The default scope. |\n| defaultSubject | undefined | A default subject. |\n| defaultBody | undefined | A default body. |\n| defaultIssues | undefined | A default issue. |\n| jiraPrefix | 'ALT' | The default JIRA ticket prefix that will be displayed. |\n| jiraMultipleIssues | true | The default amount if tickets that go in the commit message. |\n| jiraEmojiTypes | false | The default display of thet types with emoji (easier to spot the type). |\n| types | ./types.js | A list (JS Object) of supported commit types. |\n| scopes | undefined | A list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'. |\n| customScope | false | If this is set to true, users are given an option to provide custom scope aside the ones predefined in 'scopes' array. In this case a new option named 'custom' appears in the list and once chosen a prompt appears to provide custom scope |\n| jiraOptional | false | If this is set to true, you can leave the JIRA field blank. |\n| jiraLocation | \"pre-description\" | Changes position of JIRA ID. Options: `pre-type`, `pre-description`, `post-description`, `post-body` |\n| jiraPrepend | \"\" | Prepends JIRA ID with an optional decorator. e.g.: `[ALT-123` |\n| jiraAppend | \"\" | Appends JIRA ID with an optional decorator. e.g.: `ALT-123]` |\n| exclamationMark | false | On breaking changes, adds an exclamation mark (!) after the scope, e.g.: `type(scope)!: break stuff`. When activated, reduces the effective allowed header length by 1. |\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 72. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.\n","readmeFilename":"README.md"}