{"_id":"@alexktzk/cz-customizable","_rev":"2-7a3ea4bd84810df709f0b8198197695b","name":"@alexktzk/cz-customizable","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"version":"1.0.0","name":"@alexktzk/cz-customizable","description":"Commitizen customizable adapter following the conventional-changelog format.","main":"index.js","types":"index.d.ts","scripts":{"eslint":"node_modules/eslint/bin/eslint.js *.js spec/**.js","test":"node_modules/jasmine-node/bin/jasmine-node spec/","test:coverage":"istanbul cover -x cz-config-EXAMPLE.js node_modules/jasmine-node/bin/jasmine-node spec/","test:check-coverage":"istanbul check-coverage --statements 100 --branches 100 --functions 100 --lines 100","test:watch":"node_modules/jasmine-node/bin/jasmine-node --color --autotest spec/ --watch .","report-coverage":"cat ./coverage/lcov.info | codecov","semantic-release":"semantic-release","travis-deploy-once":"travis-deploy-once"},"homepage":"https://github.com/alexktzk/cz-customizable","repository":{"type":"git","url":"git+https://github.com/alexktzk/cz-customizable.git"},"author":{"name":"Alex Kutuzaki","email":"alexktzk@gmail.com"},"license":"MIT","dependencies":{"editor":"1.0.0","find-config":"0.3.0","temp":"0.8.3","winston":"2.1.0","word-wrap":"1.1.0","inquirer":"1.2.3"},"devDependencies":{"codecov.io":"0.1.6","commitizen":"^3.0.4","eslint":"1.9.0","ghooks":"^2.0.4","istanbul":"0.4.0","jasmine-node":"1.14.5","rewire":"2.5.0","semantic-release":"^15.12.0","travis-deploy-once":"^5.0.9"},"config":{"commitizen":{"path":"./index.js"},"cz-customizable":{"config":"cz-config-EXAMPLE.js"},"ghooks":{"pre-commit":"npm run eslint && npm run test"}},"gitHead":"7a14d8f0764090d55d5b8606ea1f180273cbc26b","bugs":{"url":"https://github.com/alexktzk/cz-customizable/issues"},"_id":"@alexktzk/cz-customizable@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"11.3.0","_npmUser":{"name":"alexktzk","email":"alexktzk@gmail.com"},"dist":{"integrity":"sha512-yPYSF9diGqVIvIZI19UtDNAyCn9/or0scoQwukzbV3P/6UGSHgwanYzCMRzbZ2/6rk41dBdJ8VicF9tadgpnhA==","shasum":"4b1c5119e5994bab8e70c7aa83939b4cb8739a4f","tarball":"https://registry.npmjs.org/@alexktzk/cz-customizable/-/cz-customizable-1.0.0.tgz","fileCount":13,"unpackedSize":114868,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcJNx0CRA9TVsSAnZWagAA498P/1aXssdQ87N+LoSjSQK8\ne/f2EfWv+0eLk20mehOU4wPfg+fvne52/ajUMMJ9yOoutH+WtW7KP31KdEOl\nN+JsXhw2e5QecSUC67WT3iRQTJ8tY1BVuNX+GrkdCgjCUTznT6ngnlyW3HJk\nj7mSOuZdgngYW3rZ3S7Agvtr6px++BvsFDT6NpvF/FVDu2lv8jTqoZe6RwHL\nwj+ZuhZP0C//ibrj+WEInAAF9z6wtYDkPA9CEeANoHdW2/rPnmYYenV6Lmyt\njXXPKjasOBuQDJ2FcrTYRVfIt7O+Vy4pil/OxtEAoSCeNAOoLfSoSJehbtPI\nxkKfw6aerzVw2oMFhdDbb9UkEQGkhEP4IEEpom9GMCo+HzHLemMF5kJldOdh\nghtmZyiu/AqfebfRta2GP1pB+f1BV4aZtcQNHr8RGHIObSAqYYHmYUnoZLF7\nipmy9y75m48G00Is9Dpr7bTtP1ZqWInHNUI9fxDVHuTRJVtsr4gPwVjlFRxp\nwgFGAN04YCM7QawCtGWJmM24nRSnJdVyCyYpIcMR+2zHMk05q5TRTVlzrPrR\nXziSIfXxajuJS3ujSnScItUvPpiBjp2AKXHgb75VdpsZuv/ay89JPsXm3iBv\no+6J+Lp+TCjhsjL7+VrIQjhJFurNw6eWD2UL4xnu7MoQfY7dcL4kPD82zsxp\nCxAl\r\n=9VBf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBuyovZCdefBXweYIKfqzdcHgcJOfIu/wC+3Dv7wh9G6AiEAhwTP60hHZahihv9f14ZzkFWUKfOBJ+kFUPCKXfGVnRw="}]},"maintainers":[{"name":"alexktzk","email":"alexktzk@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cz-customizable_1.0.0_1545919604262_0.6541172581208492"},"_hasShrinkwrap":false},"1.1.0":{"version":"1.1.0","name":"@alexktzk/cz-customizable","description":"Commitizen customizable adapter following the conventional-changelog format.","main":"index.js","types":"index.d.ts","scripts":{"eslint":"node_modules/eslint/bin/eslint.js *.js spec/**.js","test":"node_modules/jasmine-node/bin/jasmine-node spec/","test:coverage":"istanbul cover -x cz-config-EXAMPLE.js node_modules/jasmine-node/bin/jasmine-node spec/","test:check-coverage":"istanbul check-coverage --statements 100 --branches 100 --functions 100 --lines 100","test:watch":"node_modules/jasmine-node/bin/jasmine-node --color --autotest spec/ --watch .","report-coverage":"cat ./coverage/lcov.info | codecov","semantic-release":"semantic-release","travis-deploy-once":"travis-deploy-once"},"homepage":"https://github.com/alexktzk/cz-customizable","repository":{"type":"git","url":"git+https://github.com/alexktzk/cz-customizable.git"},"author":{"name":"Alex Kutuzaki","email":"alexktzk@gmail.com"},"license":"MIT","dependencies":{"editor":"1.0.0","find-config":"0.3.0","temp":"0.8.3","winston":"2.1.0","word-wrap":"1.1.0","inquirer":"1.2.3"},"devDependencies":{"codecov.io":"0.1.6","commitizen":"^3.0.4","eslint":"1.9.0","ghooks":"^2.0.4","istanbul":"0.4.0","jasmine-node":"1.14.5","rewire":"2.5.0","semantic-release":"^15.12.0","travis-deploy-once":"^5.0.9"},"config":{"commitizen":{"path":"./index.js"},"cz-customizable":{"config":"cz-config-EXAMPLE.js"},"ghooks":{"pre-commit":"npm run eslint && npm run test"}},"gitHead":"f73225cf4087da6c7a2922b6c85210aa8398228c","bugs":{"url":"https://github.com/alexktzk/cz-customizable/issues"},"_id":"@alexktzk/cz-customizable@1.1.0","_npmVersion":"6.4.1","_nodeVersion":"11.3.0","_npmUser":{"name":"alexktzk","email":"alexktzk@gmail.com"},"dist":{"integrity":"sha512-F1oIZxT02p490sfQ5IoGLg+WAbH4q/B6iomYXKN+mQDQqeZE+RQ/6USpMSf4nc5OmHjdd6iIU/8QJ5HC8al15Q==","shasum":"04a2b80b742620db3ba6fe65d502196a8ce1a67a","tarball":"https://registry.npmjs.org/@alexktzk/cz-customizable/-/cz-customizable-1.1.0.tgz","fileCount":14,"unpackedSize":115307,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcJPxUCRA9TVsSAnZWagAA4L8P/16s35aWkCWaTvx12aVQ\n+orx6f+iErFOjpdYaOWbY3PaOeWcxYex9QCSJdN1PlVcNsw2p71E37DbuorC\nBpPgAHTXHnWwkV3/S/oQPhiira3pEVsLYk7qfdwtQbid2z4NaSguuyRMBvWR\n6eGW26TI2GPX7fq5IgNnK3G0X+qOC4yLpNpufuppHNy4HGnUvq6OUGWIYH8A\nXNx7/g9CZysPZB7hFtC8WJ6t7qLlPcvV5vjfKmp9xR7deYcPn7R82WKvPZ03\n8x6uhUVICoT9czVV1HA/EHLp+mf8tL56LFPg+94RngyLQJugh7mTdb+T7rFy\nuhTMEyXPfzWbZZnq25jYxWeuuaNeFU8nPdkeLohzKVunj9oZehPNa+0DxlJW\nVPqPnNIfx9+8XdI8hY+jb9NIPfUr2RbknUEa+mLiWUYyUXFd8M3S/yyUz/kR\ncBsqHPq3I413H89a4JPDjmIxh4xxOQ3hcgIF10f0jzuxQDVj2sWrBuXbkc20\nNLIz9seRM6aHGJJkNyiQ/cY+rYQEhuWGGeg641i3wZZrUcPWhdVLQ9TVGDnI\n/GUwjZBpZYmurVYIVchy1UaHyB5kEpEhR3gmoK6DVT6IuXKL0dxzrXvyRtax\n2rvImgVqstYi1zya79g2XILiVytkbH0yBhIbhp0jiYqNd7BSi2zM23zpS8WD\nk0PW\r\n=CCVx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEjMU6o7pdLMilQlJSJslUwnoxPp/y34gYWhPe+abo9FAiBwYiq6eVn266NV4WXyGEbsS+sBoxMqXN1MGKSZh+mPYQ=="}]},"maintainers":[{"name":"alexktzk","email":"alexktzk@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cz-customizable_1.1.0_1545927764038_0.7280994824346045"},"_hasShrinkwrap":false}},"time":{"created":"2018-12-27T14:06:44.092Z","1.0.0":"2018-12-27T14:06:44.445Z","modified":"2022-04-04T12:40:59.991Z","1.1.0":"2018-12-27T16:22:44.161Z"},"maintainers":[{"name":"alexktzk","email":"alexktzk@gmail.com"}],"description":"Commitizen customizable adapter following the conventional-changelog format.","homepage":"https://github.com/alexktzk/cz-customizable","repository":{"type":"git","url":"git+https://github.com/alexktzk/cz-customizable.git"},"author":{"name":"Alex Kutuzaki","email":"alexktzk@gmail.com"},"bugs":{"url":"https://github.com/alexktzk/cz-customizable/issues"},"license":"MIT","readme":"# cz-customizable\n\nThe customizable Commitizen plugin to help achieve consistent commit messages like the [AngularJS team](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).\n\n![screenshot](screenshot.png)\n\nSuitable for large teams working with multiple projects with their own commit scopes. When you specify the scopes in your `.cz-config.js`, `cz-customizable` allows you to **select** the pre-defined scopes. No more spelling mistakes embarrassing you when generating the changelog file.\n\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Build Status](https://travis-ci.org/leonardoanalista/cz-customizable.svg)](https://travis-ci.org/leonardoanalista/cz-customizable) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![codecov.io](https://codecov.io/github/leonardoanalista/cz-customizable/coverage.svg?branch=master)](https://codecov.io/github/leonardoanalista/cz-customizable?branch=master) [![npm monthly downloads](https://img.shields.io/npm/dm/cz-customizable.svg?style=flat-square)](https://www.npmjs.com/package/cz-customizable)\n\n## Steps\n* install commitizen in case you don't have it: `npm install -g commitizen`. Make sure you have the latest version of commitizen installed globally.\n* install the cz-customizable: `npm install cz-customizable --save-dev`\n* configure `commitizen` to use `cz-customizable` as plugin. Add those lines to your `package.json`:\n\n  ```\n  ...\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"node_modules/cz-customizable\"\n    }\n  }\n  ```\n\n## Configure\n* `cz-customizable` will first look for a file called `.cz-config.js`\n* alternatively add a config block in your `package.json`:\n  ```\n  ...\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"node_modules/cz-customizable\"\n    },\n    \"cz-customizable\": {\n      \"config\": \"config/path/to/my/config.js\"\n    }\n  }\n  ```\nNote: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `cz-config.js`.\n\n\n**Notes:**\n* you should commit your `.cz-config.js` file to your git.\n\n\nFrom now on, instead of `git commit` you type `git cz` and let the tool do the work for you.\n\nHopefully this will help you to have consistent commit messages and have a fully automated deployment without any human intervention.\n\n## Options\n\nHere are the options you can set in your `.cz-config.js`:\n\n* scopes: {Array of Strings}: Specify the scopes for your particular project. Eg.: for some banking system: [\"acccounts\", \"payments\"]. For another travelling application: [\"bookings\", \"search\", \"profile\"]\n* scopeOverrides: {Object where key contains a Array of String}: Use this when you want to override scopes for a specific commit type. Example bellow specify scopes when type is `fix`:\n```\n  scopeOverrides: {\n    fix: [\n      {name: 'merge'},\n      {name: 'style'},\n      {name: 'e2eTest'},\n      {name: 'unitTest'}\n    ]\n  }\n  ```\n  * allowCustomScopes: {boolean, default false}: adds the option `custom` to scope selection so you can still type a scope if you need.\n  * allowBreakingChanges: {Array of Strings: default none}. List of commit types you would like to the question `breaking change` prompted. Eg.: ['feat', 'fix']\n  * appendBranchNameToCommitMessage: If you use `cz-customizable` with `cz-customizable-ghooks`, you can get the branch name automatically appended to the commit message. This is done by a commit hook on `cz-customizable-ghooks`. This option has been added on `cz-customizable-ghooks`, v1.3.0. Default value is `true`.\n  * breakingPrefix: {string, default 'BREAKING CHANGE:'}: Set a custom prefix for the breaking change block in commit messages\n  * footerPrefix: {string, default 'ISSUES CLOSED:'}: Set a custom prefix for the footer block in commit messages\n\n## Related tools\n- (https://github.com/commitizen/cz-cli)\n- (https://github.com/stevemao/conventional-recommended-bump)\n- (https://github.com/semantic-release/semantic-release)\n- (https://github.com/uglow/cz-customizable-ghooks)\n\n\n\n## GOTCHAS\n\n* backticks\nIf you wish to have backticks in your content, for example \"feat: \\`string\\`\", the commit preview will be \"feat: \\\\\\\\`string\\\\\\\\`\".\nDon't worry because on your `git log` will be \"feat: \\`string\\`\" as desired.\n\n* multiline contents on the body of the message\nBody is the only place where you can use a `pipe` to break lines.\nE.g.: you type this: `my items are:| - item01| - item 02`, which will become:\n\n\n```\nmy items are:\n - item01\n - item 02\n```\n\n\n## CONTRIBUTING\n\n* if you add a new config property, please remember to update Types  in file `index.d.ts`.\nPlease refer to:\n* [Contributor Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md) - disregard section \"Signing the CLA\" and basically be polite, respectful and understanding that we are all here after working hours spending time to build something useful to all.\n* [Conduct of Code](https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md) from [AngularJs](https://github.com/angular/angular.js) project.\n\n\n\nLeonardo Correa\n","readmeFilename":"README.md"}