├── .github ├── dependabot.yml └── workflows │ └── build.yml ├── .gitignore ├── .pre-commit-hooks.yaml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── cli.js ├── commit-msg.sh ├── git-conventional-commits.default.yaml ├── git-conventional-commits.yaml ├── lib ├── changelogGenerator.js ├── commands │ ├── commandChangelog.js │ ├── commandCommitMessageHook.js │ ├── commandInit.js │ ├── commandVersion.js │ └── config.js ├── execAsync.js ├── git.js ├── gitCommitConvention.js └── semver.js ├── package-lock.json ├── package.json └── test ├── commands ├── commandChangelog.test.js └── config.test.js ├── git.test.js ├── gitCommitConvention.test.js └── semver.test.js /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: npm 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "04:00" 8 | open-pull-requests-limit: 10 9 | commit-message: 10 | prefix: build 11 | include: scope 12 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions 3 | 4 | name: Build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | strategy: 18 | matrix: 19 | node-version: [16.x, 18.x] 20 | # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ 21 | 22 | steps: 23 | - uses: actions/checkout@v3 24 | - name: Use Node.js ${{ matrix.node-version }} 25 | uses: actions/setup-node@v3 26 | with: 27 | node-version: ${{ matrix.node-version }} 28 | cache: 'npm' 29 | - run: npm ci 30 | - run: | 31 | git config --global user.email "test@test.test" 32 | git config --global user.name "test" 33 | - run: npm test 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .idea 3 | -------------------------------------------------------------------------------- /.pre-commit-hooks.yaml: -------------------------------------------------------------------------------- 1 | - id: conventional-commits 2 | name: conventional-commits 3 | description: "Util to validate commit message" 4 | entry: git-conventional-commits commit-msg-hook 5 | stages: [commit-msg] 6 | language: node 7 | 8 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## **2.6.3** 2023-03-02 ([ad1d56c...a64d54f](https://github.com/qoomon/git-conventional-commits/compare/ad1d56c...a64d54f?diff=split)) 2 | 3 | ### Bug Fixes 4 | * use full commit hashes for links ([a64d54f](https://github.com/qoomon/git-conventional-commits/commit/a64d54f)) 5 | 6 |
7 | 8 | ## **2.6.0** 2023-02-28 ([aafcc05...aafcc05](https://github.com/qoomon/git-conventional-commits/compare/aafcc05...aafcc05?diff=split)) 9 | 10 | ### Features 11 | 12 | #####  `changelog` 13 | * adjust changelog styling ([aafcc05](https://github.com/qoomon/git-conventional-commits/commit/aafcc05)) 14 | 15 |
16 | 17 | ## **2.5.2** 2023-02-28 ([15ea67b...15ea67b](https://github.com/qoomon/git-conventional-commits/compare/15ea67b...15ea67b?diff=split)) 18 | 19 | ### Bug Fixes 20 | * fix missing new line for commit line ([15ea67b](https://github.com/qoomon/git-conventional-commits/commit/15ea67b)) 21 | 22 |
23 | 24 | ## **2.5.0** 2023-01-27 ([5d6f92f...5d6f92f](https://github.com/qoomon/git-conventional-commits/compare/5d6f92f...5d6f92f?diff=split)) 25 | 26 | ### Features 27 | * init command add commit message hook ([5d6f92f](https://github.com/qoomon/git-conventional-commits/commit/5d6f92f)) 28 | 29 | ## **2.4.1** 2023-01-17 ([ea1c647...ea1c647](https://github.com/qoomon/git-conventional-commits/compare/ea1c647...ea1c647?diff=split)) 30 | 31 | ### Bug Fixes 32 | * add missing default\.yaml ([ea1c647](https://github.com/qoomon/git-conventional-commits/commit/ea1c647)) 33 | 34 |
35 | 36 | ## **2.4.0** 2022-12-15 ([e19dbd5...e19dbd5](https://github.com/qoomon/git-conventional-commits/compare/e19dbd5...e19dbd5?diff=split)) 37 | 38 | ### Features 39 | * add yaml config support ([e19dbd5](https://github.com/qoomon/git-conventional-commits/commit/e19dbd5)) 40 | 41 |
42 | 43 | ## **2.3.1** 2022-12-14 ([5d29d9b...a75269d](https://github.com/qoomon/git-conventional-commits/compare/5d29d9b...a75269d?diff=split)) 44 | 45 | ### Bug Fixes 46 | * fix git command sytax for windows ([a75269d](https://github.com/qoomon/git-conventional-commits/commit/a75269d)) 47 | 48 |
49 | 50 | ## **2.3.0** 2022-11-06 ([d7e4124...15a031e](https://github.com/qoomon/git-conventional-commits/compare/d7e4124...15a031e?diff=split)) 51 | 52 | ### Features 53 | * change default merge headline to just 'Merges' ([d7e4124](https://github.com/qoomon/git-conventional-commits/commit/d7e4124)) 54 | * create inline Markdown links for issue references ([15a031e](https://github.com/qoomon/git-conventional-commits/commit/15a031e)) 55 | 56 |
57 | 58 | ## **2.2.0** 2022-11-06 ([9e026c5...d0b5b6b](https://github.com/qoomon/git-conventional-commits/compare/9e026c5...d0b5b6b?diff=split)) 59 | 60 | ### Features 61 | * add support for bitbucket merge messages ([d0b5b6b](https://github.com/qoomon/git-conventional-commits/commit/d0b5b6b)) 62 | 63 |
64 | 65 | ## **2.1.2** 2022-09-20 ([9e026c5...68a02b6](https://github.com/qoomon/git-conventional-commits/compare/9e026c5...68a02b6?diff=split)) 66 | 67 | ### Bug Fixes 68 | * fix [#107](https://github.com/qoomon/git-conventional-commits/issues/107) ([b7a3e41](https://github.com/qoomon/git-conventional-commits/commit/b7a3e41)) 69 | 70 |
71 | 72 | ## **2.1.1** 2022-08-17 ([b8d8a18...940f809](https://github.com/qoomon/git-conventional-commits/compare/b8d8a18...940f809?diff=split)) 73 | 74 | ### Bug Fixes 75 | * handle empty repository and no release tag ([940f809](https://github.com/qoomon/git-conventional-commits/commit/940f809)) 76 | 77 |
78 | 79 | ## **2.1.0** 2022-07-30 ([0e01b77...2ef8c09](https://github.com/qoomon/git-conventional-commits/compare/0e01b77...2ef8c09?diff=split)) 80 | 81 | ### Features 82 | * add support for the pre-commit framework (#102) ([0e01b77](https://github.com/qoomon/git-conventional-commits/commit/0e01b77)) 83 | 84 |
85 | 86 | ## **2.0.0** 2022-07-19 ([752f806...ed7cb3b](https://github.com/qoomon/git-conventional-commits/compare/752f806...ed7cb3b?diff=split)) 87 | 88 | ### Features 89 | * ignore pre-release version tags e.g. v1.2.3-SNAPSHOT or v1.2.3-rc1 ([df7be15](https://github.com/qoomon/git-conventional-commits/commit/df7be15)) 90 | * do not recalculate version, if version tag points on commit anchor ([8cd6c74](https://github.com/qoomon/git-conventional-commits/commit/8cd6c74)) 91 | 92 | #####  `changelog` 93 | * release date will be taken from commit date ([ed7cb3b](https://github.com/qoomon/git-conventional-commits/commit/ed7cb3b)) 94 | 95 |
96 | 97 | ## **1.4.2** 2022-07-15 ([6d20004...19d2d70](https://github.com/qoomon/git-conventional-commits/compare/6d20004...19d2d70?diff=split)) 98 | 99 | ### Bug Fixes 100 | * I messed up a little, so this is a working version again ([19d2d70](https://github.com/qoomon/git-conventional-commits/commit/19d2d70)) 101 | 102 |
103 | 104 | ## **1.4.0** 2022-07-15 ([8c71120...31b9fa7](https://github.com/qoomon/git-conventional-commits/compare/8c71120...31b9fa7?diff=split)) 105 | 106 | ### Features 107 | * support breaking change syntax in commit subject ([651a6b3](https://github.com/qoomon/git-conventional-commits/commit/651a6b3)) 108 | 109 |
110 | 111 | ## **1.3.0** 2022-07-14 ([e7e8c4f...06d3556](https://github.com/qoomon/git-conventional-commits/compare/e7e8c4f...06d3556?diff=split)) 112 | 113 | ### Bug Fixes 114 | * always include breaking changes in changelog \(\#96\) ([d43723d](https://github.com/qoomon/git-conventional-commits/commit/d43723d)) 115 | 116 |
117 | 118 | ## **1.2.3** 2022-07-11 ([e2aa89a...b45ae70](https://github.com/qoomon/git-conventional-commits/compare/e2aa89a...b45ae70?diff=split)) 119 | 120 | ### Bug Fixes 121 | * Handle development version increments according to SemVer specification \(\#93\) ([8226d92](https://github.com/qoomon/git-conventional-commits/commit/8226d92)) 122 | 123 |
124 | 125 | ## **1.2.0** 2022-02-25 ([3b1fbbf...a5e7851](https://github.com/qoomon/git-conventional-commits/compare/3b1fbbf...a5e7851?diff=split)) 126 | 127 | ### Features 128 | * add includeInvalidCommits option \(\#74\) ([a5e7851](https://github.com/qoomon/git-conventional-commits/commit/a5e7851)) 129 | 130 |
131 | 132 | ## **1.1.0** 2021-08-31 ([1746e1c...483aa5f](https://github.com/qoomon/git-conventional-commits/compare/1746e1c...483aa5f?diff=split)) 133 | 134 | ### Features 135 | * add \-\-commit option to generate version and changelog for specific commit e\.g\. v1\.0\.0 ([483aa5f](https://github.com/qoomon/git-conventional-commits/commit/483aa5f)) 136 | 137 |
138 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Git Conventional Commits [![starline](https://starlines.qoo.monster/assets/qoomon/git-conventional-commits)](https://github.com/qoomon/starlines) 2 | 3 | [![npm](https://img.shields.io/npm/v/git-conventional-commits)](https://www.npmjs.com/package/git-conventional-commits) 4 | 5 | > [!TIP] 6 | > Also have a look at **[Git Conventional Commits Cheat Sheet](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13)** 7 | 8 | ### Changelog 9 | see [CHANGELOG.md](CHANGELOG.md) 10 | 11 | ### Usage 12 | `npx git-conventional-commits ` 13 | #### Commands 14 | ℹ add help parameter `-h` to commands to list all possible options 15 | ``` 16 | init [options] create a config file template `git-conventional-commits.yaml` 17 | version [options] determine version from conventional commits 18 | changelog [options] generate change log from conventional commits 19 | commit-msg-hook [options] check for conventional commit message format 20 | ``` 21 | 22 | #### First Usage 23 | * Run `npx git-conventional-commits init` 24 | * Adjust [config file](#config-file) `git-conventional-commits.yaml` to your needs 25 | 26 | #### Config File 27 | Example `git-conventional-commits.yaml` 28 | ```yaml 29 | --- 30 | convention: 31 | commitTypes: 32 | - feat # Commits, that add or remove a new feature to the API or UI 33 | - fix # Commits, that fix a API or UI bug of a preceded feat commit 34 | - refactor # Commits, that rewrite/restructure your code, however do not change any API or UI behaviour 35 | - perf # Commits are special `refactor` commits, that improve performance 36 | - style # Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) 37 | - test # Commits, that add missing tests or correcting existing tests 38 | - build # Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ... 39 | - ops # Commits, that affect operational components like infrastructure, deployment, backup, recovery, ... 40 | - docs # Commits, that affect documentation only 41 | - chore # Miscellaneous commits e.g. modifying `.gitignore` 42 | - docs 43 | - merge 44 | commitScopes: [] 45 | releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]* 46 | changelog: 47 | commitTypes: 48 | - feat 49 | - fix 50 | - perf 51 | - merge 52 | includeInvalidCommits: true 53 | commitScopes: [] 54 | commitIgnoreRegexPattern: "^WIP " 55 | headlines: 56 | feat: Features 57 | fix: Bug Fixes 58 | perf: Performance Improvements 59 | merge: Merges 60 | breakingChange: BREAKING CHANGES 61 | commitUrl: https://github.com/qoomon/git-conventional-commits/commit/%commit% 62 | commitRangeUrl: https://github.com/qoomon/git-conventional-commits/compare/%from%...%to%?diff=split 63 | issueRegexPattern: "#[0-9]+" 64 | issueUrl: https://github.com/qoomon/git-conventional-commits/issues/%issue% 65 | 66 | ``` 67 | * `convention` 68 | * `commitTypes` an array of expected commit types 69 | * show warnings for unexpected types 70 | * if not set or empty commit type validation is disabled 71 | * e.g. `["feat", "fix", "doc", "style"]` 72 | * `commitScopes` an array of expected commit types 73 | * show warnings for unexpected scopes 74 | * if not set or empty commit scope validation is disabled 75 | * e.g. `["ui", "database"]` 76 | * `releaseTagGlobPattern` glob pattern to filter for release tags 77 | * release tags must contain semantic version (`[0-9]+\.[0-9]+\.[0-9]+`) 78 | * default `*` 79 | * `issueRegexPattern` regex pattern to find issue IDs 80 | * e.g. Jira issue pattern `[A-Z]{3,}-\\d+` 81 | 82 | * `changelog` 83 | * `commitTypes` filter commits by type 84 | * a subset of `convention.commitTypes` plus 85 | * `merge` commits 86 | * if not set or empty commit type filter is disabled 87 | * e.g. `["feat", "fix", "merge"]` 88 | * `commitScopes` filter commits by scopes 89 | * a subset of `convention.commitScopes` 90 | * if not set or empty commit scope filter is disabled 91 | * e.g. `["ui"]` 92 | * `includeInvalidCommits` include commits without valid type: default: `true` 93 | * if set to false all commits with undefined `commitTypes` will be removed from changelog 94 | * `commitIgnoreRegexPattern` filter commits by commit subject regex 95 | * default `^WIP ` 96 | * `headlines` a map of headline identifier and actual headline 97 | * a subset of `changelog.commitTypes` plus 98 | * `breakingChange` Breaking Changes Section 99 | * e.g. `{ "feat": "Features", "fix": "Bug Fixes", "breakingChange": "BREAKING CHANGES"}` 100 | * default `{ "feat": "Features", "fix": "Bug Fixes", "merge": "Merges", "breakingChange": "BREAKING CHANGES"}` 101 | * `commitUrl` an URL template for generating markdown links to repository commits 102 | * `%commit%` commit hash placeholder 103 | * eg `https://github.com/qoomon/git-conventional-commits/commit/%commit%` 104 | * if not set or empty link generation is disabled 105 | * `issueUrl` an URL template for generating markdown links to an issue tracker 106 | * `%issue%` issue id placeholder 107 | * eg `https://jira.example.org/browse/%issue%` 108 | * if not set or empty link generation is disabled 109 | 110 | 111 | ### Automatically Validate Commit Message Convention before Commit 112 | 113 | To automatically validate commit messages, a git hook can be used in the `commit-msg` stage. 114 | The hook can be created either manually or using the [pre-commit framework](https://pre-commit.com/). 115 | 116 | #### Setup with the pre-commit framework 117 | * Create `.pre-commit-config.yaml` file in the root directory of your repository with following content. 118 | ```yaml 119 | repos: 120 | - repo: https://github.com/qoomon/git-conventional-commits 121 | rev: 122 | hooks: 123 | - id: conventional-commits 124 | ``` 125 | * Install the `pre-commit` framework `pip install pre-commit` 126 | * Install the commit-msg hook `pre-commit install -t commit-msg` 127 | 128 | #### Setup manually 129 | * Setup Commit Message Hook to 130 | * Navigate to your repository directory `cd ` 131 | * Create git hook directory `mkdir .git-hooks` 132 | * Set update hooksPath `git config core.hooksPath .git-hooks` 133 | * Create commit message hook script and make it executable 134 | * `touch .git-hooks/commit-msg && chmod +x .git-hooks/commit-msg` 135 | * Open `.git-hooks/commit-msg` with your favorite editor and paste following script 136 | ```shell 137 | #!/bin/sh 138 | 139 | # fix for windows systems 140 | PATH="/c/Program Files/nodejs:$HOME/AppData/Roaming/npm/:$PATH" 141 | 142 | npx git-conventional-commits commit-msg-hook "$1" 143 | ``` 144 | * Add and commit `.git-hooks/commit-msg` to repository 145 | > [!IMPORTANT] 146 | > Whenever you clone your repository with git hooks you need to enable git hooks once again 147 | >
`git config core.hooksPath .git-hooks` 148 | 149 | 150 | ### Release Workflow with `git-conventional-commits` 151 | * Determine version by `npx git-conventional-commits version` 152 | * Update version in project files 153 | * Commit version bump `git commit -am'build(release): bump project version to '` 154 | * Generate change log by `npx git-conventional-commits changelog --release --file 'CHANGELOG.md'` 155 | * Commit change log `git commit -am'docs(release): create change log entry'` 156 | * Tag commit with version `git tag -a -m'build(release): ' ''` 157 | * Push all changes `git push` 158 | * Build and upload artifacts 159 | 160 | ### Integration with existing repository 161 | 162 | If you have an large existing repo with no release tags e.g. v1.0.0, or if you want the first changelog to be tidy, you need to create a release tag first. 163 | * Create release tag for specific commit`git tag -a -m'build(release): 0.0.0' 'v0.0.0'` 164 | * Push tag `git push origin v0.0.0` 165 | This way `npx git-conventional-commits` will only considre commits based on the commit the release tag is pointing at. 166 | 167 | --- 168 | ## Projects Using git-conventional-commits 169 | - https://github.com/Blazity/next-enterprise 170 | 171 | --- 172 | 173 | ## Build/Release 174 | * `npm install` 175 | * `npm test` 176 | * `npm login` 177 | * `npm publish` 178 | 179 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const yargs = require('yargs').parserConfiguration({ 4 | 'duplicate-arguments-array': false 5 | }); 6 | 7 | yargs 8 | .strict() 9 | .commandDir('./lib/commands') 10 | .demandCommand(1, 'Missing required argument: command') 11 | .wrap(120) 12 | .parse() -------------------------------------------------------------------------------- /commit-msg.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if command -v npx > /dev/null 2>&1 4 | then 5 | # fix for windows systems 6 | PATH="/c/Program Files/nodejs:$HOME/AppData/Roaming/npm/:$PATH" 7 | npx --yes git-conventional-commits commit-msg-hook "$1" 8 | fi 9 | -------------------------------------------------------------------------------- /git-conventional-commits.default.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | convention: 3 | commitTypes: 4 | - feat # Commits, that add or remove a new feature to the API or UI 5 | - fix # Commits, that fix a API or UI bug of a preceded feat commit 6 | - refactor # Commits, that rewrite/restructure your code, however do not change any API or UI behaviour 7 | - perf # Commits are special `refactor` commits, that improve performance 8 | - style # Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) 9 | - test # Commits, that add missing tests or correcting existing tests 10 | - build # Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ... 11 | - ops # Commits, that affect operational components like infrastructure, deployment, backup, recovery, ... 12 | - docs # Commits, that affect documentation only 13 | - chore # Miscellaneous commits e.g. modifying `.gitignore` 14 | - merge 15 | - revert 16 | commitScopes: [] 17 | releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]* 18 | changelog: 19 | commitTypes: 20 | - feat 21 | - fix 22 | - perf 23 | - merge 24 | includeInvalidCommits: true 25 | commitIgnoreRegexPattern: "^WIP " 26 | headlines: 27 | feat: Features 28 | fix: Bug Fixes 29 | perf: Performance Improvements 30 | merge: Merges 31 | breakingChange: BREAKING CHANGES 32 | 33 | ## GitHub 34 | # commitUrl: https://github.com/ACCOUNT/REPOSITORY/commit/%commit% 35 | # commitRangeUrl: https://github.com/ACCOUNT/REPOSITORY/compare/%from%...%to%?diff=split 36 | 37 | ## GitHub Issues 38 | # issueRegexPattern: "#[0-9]+" 39 | # issueUrl: https://github.com/ACCOUNT/REPOSITORY/issues/%issue% 40 | 41 | ## Jira Issues 42 | # issueRegexPattern: "[A-Z][A-Z0-9]+-[0-9]+" 43 | # issueUrl: https://WORKSPACE.atlassian.net/browse/%issue% 44 | -------------------------------------------------------------------------------- /git-conventional-commits.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | convention: 3 | commitTypes: 4 | - feat # Commits, that add or remove a new feature to the API or UI 5 | - fix # Commits, that fix a API or UI bug of a preceded feat commit 6 | - refactor # Commits, that rewrite/restructure your code, however do not change any API or UI behaviour 7 | - perf # Commits are special `refactor` commits, that improve performance 8 | - style # Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) 9 | - test # Commits, that add missing tests or correcting existing tests 10 | - build # Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ... 11 | - ops # Commits, that affect operational components like infrastructure, deployment, backup, recovery, ... 12 | - docs # Commits, that affect documentation only 13 | - chore # Miscellaneous commits e.g. modifying `.gitignore` 14 | - merge 15 | - revert 16 | commitScopes: [s] 17 | releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]* 18 | changelog: 19 | commitTypes: 20 | - feat 21 | - fix 22 | - perf 23 | - merge 24 | includeInvalidCommits: true 25 | commitIgnoreRegexPattern: "^WIP " 26 | headlines: 27 | feat: Features 28 | fix: Bug Fixes 29 | perf: Performance Improvements 30 | merge: Merges 31 | breakingChange: BREAKING CHANGES 32 | commitUrl: https://github.com/qoomon/git-conventional-commits/commit/%commit% 33 | commitRangeUrl: https://github.com/qoomon/git-conventional-commits/compare/%from%...%to%?diff=split 34 | issueRegexPattern: "#\\d+" 35 | issueUrl: https://github.com/qoomon/maven-git-versioning-extension/issues/%issue% 36 | -------------------------------------------------------------------------------- /lib/changelogGenerator.js: -------------------------------------------------------------------------------- 1 | module.exports = function (config) { 2 | 3 | /** 4 | * @function 5 | * @param {Object} commitLog - a list of commit candidates to be included in the changelog. 6 | * @param {Object} generatorParams - changelog specific generator parameters. 7 | * @param {string} generatorParams.releaseName - the version number of the release including an optional suffix. 8 | * @param {string} [generatorParams.customMarkdown] - optional custom markdown to be included in the changelog. 9 | * @param {boolean} generatorParams.includeInvalidCommits - if true, commits which do not match the ConCom spec will be included in the changelog. 10 | * @param {string[]} [generatorParams.commitTypes] - an optional list of all commit types to include in the changelog (e.g. ["fix", "feat", ...]). 11 | * @param {string[]} [generatorParams.commitScopes] - an optional list of all commit scopes to included in the changelog (e.g. ["deps", "dev-deps", ...]); If not set all scopes are included. 12 | * @param {RegExp} generatorParams.commitIgnoreRegex - regular expression that matches commits to be excluded from the changelog. 13 | */ 14 | this.generateMarkdown = function ( 15 | commitLog, 16 | { 17 | releaseName, 18 | customMarkdown, 19 | includeInvalidCommits, 20 | commitTypes, 21 | commitScopes, 22 | commitIgnoreRegex, 23 | } 24 | ) { 25 | const shouldIncludeInChangesSection = (commit) => { 26 | // filter by commit messages regex 27 | if ( 28 | commitIgnoreRegex && 29 | [commit.subject, commit.body].join("\n\n").match(commitIgnoreRegex) 30 | ) { 31 | return false; 32 | } 33 | 34 | // filter by commit type 35 | if ( 36 | (commit.type || !includeInvalidCommits) && // undefined commit type 37 | commitTypes && 38 | commitTypes.length && // no filter at all 39 | (commit.type === undefined || !commitTypes.includes(commit.type)) 40 | ) { 41 | return false; 42 | } 43 | 44 | // filter by commit scope 45 | // noinspection RedundantIfStatementJS 46 | if ( 47 | commit.scope && 48 | commitScopes && commitScopes.length && 49 | !commitScopes.includes(commit.scope) 50 | ) { 51 | return false; 52 | } 53 | 54 | return true; 55 | }; 56 | const shouldIncludeInBreakingSection = (commit) => commit.breakingChanges.length > 0; 57 | 58 | const firstChangelogCommit = commitLog[0]; 59 | const lastChangelogCommit = commitLog[Math.max(commitLog.length - 1, 0)]; 60 | const changesSectionCommits = commitLog.filter(shouldIncludeInChangesSection); 61 | const breakingSectionCommits = commitLog.filter(shouldIncludeInBreakingSection); 62 | 63 | let changelogMarkdown = ""; 64 | 65 | // ------ generate version headline 66 | let changelogCommitRangeMarkdown = markdownCommitRange(firstChangelogCommit.hash, lastChangelogCommit.hash); 67 | 68 | changelogMarkdown += 69 | `## **${releaseName || lastChangelogCommit.hash}**` + 70 | ` ${yyyy_mm_dd(lastChangelogCommit.date)} (${changelogCommitRangeMarkdown})\n\n`; 71 | 72 | if (changesSectionCommits.length > 0 || breakingSectionCommits.length > 0) { 73 | // ------ generate changes section 74 | const groupedChangelog = bucketAggregation(changesSectionCommits, (commit) => commit.type); 75 | const commitTypes = Object.keys(groupedChangelog).sort(); 76 | commitTypes.forEach((commitType) => { 77 | changelogMarkdown += generateMarkdownCommitTypeSection( 78 | commitType, 79 | groupedChangelog[commitType] 80 | ); 81 | }); 82 | 83 | // ------ generate breaking section 84 | const groupedBreakingChangelog = bucketAggregation( 85 | breakingSectionCommits, 86 | (commit) => commit.type 87 | ); 88 | const breakingCommits = Object.values(groupedBreakingChangelog).reduce( 89 | (result, typeCommits) => result.concat(typeCommits), [] 90 | ); 91 | if (breakingCommits.length) { 92 | changelogMarkdown += "\n" + 93 | generateMarkdownBreakingChangesSection(breakingCommits); 94 | } 95 | 96 | // ------ generate custom markdown section 97 | if (customMarkdown && customMarkdown.length) { 98 | changelogMarkdown += "\n" + 99 | generateCustomMarkdownSection(customMarkdown); 100 | } 101 | } else { 102 | changelogMarkdown += "*no relevant changes*\n"; 103 | } 104 | 105 | changelogMarkdown +="
\n\n"; 106 | 107 | return changelogMarkdown; 108 | }; 109 | 110 | function generateMarkdownCommitTypeSection(commitType, commits) { 111 | const typeSectionHeadline = config.headlines[commitType !== 'undefined' ? commitType : '?'] || commitType; 112 | let typeSectionMarkdown = `### ${typeSectionHeadline}\n\n`; 113 | 114 | const scopedCommits = bucketAggregation(commits, commit => commit.scope); 115 | // sort scopes by name with, undefined scope at front, if present 116 | const commitScopes = Object.keys(scopedCommits).sort((l, r) => { 117 | if (l === 'undefined') return -1; 118 | if (r === 'undefined') return 1; 119 | return l > r ? 1 : -1; 120 | }) 121 | commitScopes.forEach(scope => { 122 | typeSectionMarkdown += generateMarkdownScopeSection(scope, scopedCommits[scope]); 123 | }); 124 | 125 | return typeSectionMarkdown; 126 | } 127 | 128 | function generateMarkdownScopeSection(scope, commits) { 129 | let scopeSectionMarkdown = ''; 130 | if (scope !== 'undefined') { 131 | scopeSectionMarkdown += `#####  \`${scope}\`\n\n`; 132 | } 133 | commits.forEach(commit => { 134 | scopeSectionMarkdown += `- ${generateMarkdownCommit(commit)}`; 135 | }); 136 | return scopeSectionMarkdown + '\n' 137 | } 138 | 139 | function generateMarkdownCommit(commit) { 140 | let commitMarkdown = ''; 141 | if (commit.revert) { 142 | commitMarkdown += '**Revert** '; 143 | } 144 | let descriptionMarkdown = escapeMarkdown(commit.description); 145 | // replace issue references with links 146 | commit.description.match(config.issueRegex())?.forEach(issueId => { 147 | descriptionMarkdown = descriptionMarkdown.replace(escapeMarkdown(issueId), markdownIssueId(issueId)); 148 | }); 149 | commitMarkdown += descriptionMarkdown.trim(); 150 | 151 | let referencesMarkdown = [markdownCommitHash(commit.hash)]; 152 | // add issue references from body 153 | commit.body.match(config.issueRegex())?.forEach(issueId => { 154 | referencesMarkdown.push(markdownIssueId(issueId)); 155 | }); 156 | commitMarkdown += ` (${referencesMarkdown.join(', ')})\n`; 157 | 158 | return commitMarkdown; 159 | } 160 | 161 | function generateMarkdownBreakingChangesSection(commits) { 162 | const sectionHeadline = config.headlines["breakingChange"] || "BREAKING CHANGES"; 163 | let changelogMarkdown = `### ${sectionHeadline}\n`; 164 | commits 165 | .sort((left, right) => (left.scope || "").localeCompare(right.scope || "")) 166 | .forEach(commit => commit.breakingChanges 167 | .forEach(breakingChange => { 168 | const msgSubject = breakingChange.split('\n').splice(0, 1)[0]; 169 | const msgBody = breakingChange.split('\n').splice(1).join("\n") 170 | .replace(/\n\n\n/, "\n\n").replace(/\n*$/, ""); // remove multiple empty lines and trailing spaces 171 | 172 | let breakingChangeMarkdown = "- "; 173 | if (commit.scope) { 174 | breakingChangeMarkdown += `\`${commit.scope}\``; 175 | } 176 | if (msgSubject) { 177 | breakingChangeMarkdown += ` ${escapeMarkdown(msgSubject)}`; 178 | } 179 | breakingChangeMarkdown += ` (${markdownCommitHash(commit.hash)})\n`; 180 | if (msgBody) { 181 | breakingChangeMarkdown += "\n"; 182 | breakingChangeMarkdown += `${escapeMarkdown(msgBody)}\n`; 183 | } 184 | 185 | changelogMarkdown += breakingChangeMarkdown; 186 | })); 187 | return changelogMarkdown; 188 | } 189 | 190 | function generateCustomMarkdownSection(customMarkdowns) { 191 | let changelogMarkdown = ""; 192 | customMarkdowns.forEach((customMarkdown) => { 193 | changelogMarkdown += `${customMarkdown}\n`; 194 | }); 195 | return changelogMarkdown; 196 | } 197 | 198 | function markdownLink(name, url) { 199 | return `[${name}](${url})`; 200 | } 201 | 202 | function markdownIssueId(issueId) { 203 | if (config.issueUrl) { 204 | const issueUrl = config.issueUrl.replace("%issue%", issueId); 205 | return markdownLink(issueId, issueUrl); 206 | } 207 | 208 | return issueId; 209 | } 210 | 211 | function markdownCommitHash(commitHash, revName) { 212 | if (config.commitUrl) { 213 | const commitUrl = config.commitUrl.replace("%commit%", commitHash); 214 | return markdownLink((revName || commitHash.substring(0, 7)), commitUrl); 215 | } 216 | 217 | return (revName || commitHash); 218 | } 219 | 220 | function markdownCommitRange(formCommitHash, toCommitHash) { 221 | if (config.commitRangeUrl) { 222 | const commitRangeUrl = config.commitRangeUrl 223 | .replace("%from%", formCommitHash) 224 | .replace("%to%", toCommitHash); 225 | return markdownLink(`${formCommitHash.substring(0, 7)}...${toCommitHash.substring(0, 7)}`, commitRangeUrl); 226 | } 227 | 228 | return `${formCommitHash}...${toCommitHash}`; 229 | } 230 | 231 | }; 232 | 233 | function escapeMarkdown(text) { 234 | const markdownEscapeChars = ['\\', '`', '*', '{', '}', '[', ']', '(', ')', '#', '+', '-', '.', '!', '_', '>']; 235 | const markdownEscapeRegex = RegExp("[" + markdownEscapeChars.join("\\") + "]", "g"); 236 | return text.replace(markdownEscapeRegex, "\\$&").replace(/\n/g, "\n "); 237 | } 238 | 239 | function yyyy_mm_dd(date) { 240 | const dd = String(date.getDate()).padStart(2, '0'); 241 | const mm = String(date.getMonth() + 1).padStart(2, '0'); //January is 0! 242 | const yyyy = date.getFullYear(); 243 | return [yyyy, mm, dd].join("-"); 244 | } 245 | 246 | function bucketAggregation(items, aggregation) { 247 | return items.reduce((buckets, item) => { 248 | const aggregationKey = aggregation(item); 249 | buckets[aggregationKey] = buckets[aggregationKey] || []; 250 | buckets[aggregationKey].push(item); 251 | return buckets; 252 | }, {}) 253 | } 254 | -------------------------------------------------------------------------------- /lib/commands/commandChangelog.js: -------------------------------------------------------------------------------- 1 | const Config = require("./config"); 2 | const CommitConvention = require("../gitCommitConvention"); 3 | const ChangelogGenerator = require("../changelogGenerator"); 4 | const fs = require('fs'); 5 | 6 | exports.command = 'changelog' 7 | exports.desc = 'Generate change log from conventional commits' 8 | exports.builder = function (yargs) { 9 | yargs.option('config', { 10 | alias: 'c', 11 | desc: 'Config file path', 12 | default: Config.defaultPath, 13 | requiresArg: true 14 | }) 15 | yargs.option('commit', { 16 | desc: 'Commit anchor e.g. v1.0.0', 17 | default: 'HEAD', 18 | requiresArg: true 19 | }) 20 | 21 | yargs.option('release', { 22 | alias: 'r', 23 | desc: 'Release version', 24 | requiresArg: true 25 | }) 26 | yargs.option('name', { 27 | alias: 'n', 28 | desc: 'Release name', 29 | requiresArg: true 30 | }) 31 | yargs.option('file', { 32 | alias: 'f', 33 | desc: 'Prepend changelog to a file', 34 | requiresArg: true 35 | // https://github.com/yargs/yargs/blob/master/docs/api.md#coercekey-fn 36 | }) 37 | yargs.option('markdown', { 38 | alias: 'm', 39 | type: 'string', 40 | array: true, 41 | desc: 'Add multiple custom markdown snippets e.g. "### Assets\\n* [awesome app](https://example.org/awesome.zip)"', 42 | requiresArg: true 43 | }) 44 | } 45 | 46 | exports.handler = async function (argv) { 47 | const config = Config.load(argv.config); 48 | const commitConvention = new CommitConvention(config.convention, argv.commit); 49 | const changelogGenerator = new ChangelogGenerator(config.changelog); 50 | 51 | let releaseName = argv.release || (await commitConvention.getVersion()); 52 | if (argv.name) { 53 | releaseName += ` - ${argv.name}`; 54 | } 55 | 56 | const commitLog = await commitConvention.getCommitLog(); 57 | 58 | // ------ generate markdown -------------------------------------- 59 | let changelogMarkdown = changelogGenerator.generateMarkdown(commitLog, { 60 | releaseName, 61 | customMarkdown: argv.markdown, 62 | includeInvalidCommits: config.changelog.includeInvalidCommits, 63 | commitTypes: config.changelog.commitTypes, 64 | commitScopes: config.changelog.commitScopes, 65 | commitIgnoreRegex: config.changelog.commitIgnoreRegex(), 66 | }); 67 | 68 | // ------ output ------------------------------------------------- 69 | if (argv.file) { 70 | prependFileSync(argv.file, changelogMarkdown); 71 | } else { 72 | console.log(changelogMarkdown); 73 | } 74 | }; 75 | 76 | function prependFileSync(file, content) { 77 | let fileContent = ''; 78 | if (fs.existsSync(file)) { 79 | fileContent = fs.readFileSync(file).toString(); 80 | } 81 | fs.writeFileSync(file, content + fileContent); 82 | } 83 | -------------------------------------------------------------------------------- /lib/commands/commandCommitMessageHook.js: -------------------------------------------------------------------------------- 1 | const Config = require("./config"); 2 | const CommitConvention = require("../gitCommitConvention"); 3 | const fs = require("fs"); 4 | 5 | exports.command = 'commit-msg-hook ' 6 | exports.desc = 'Check for conventional commit message format' 7 | exports.builder = function (yargs) { 8 | yargs.positional('commit-msg-file', { 9 | type: 'string', 10 | describe: 'Commit message file path', 11 | }) 12 | yargs.option('config', { 13 | alias: 'c', 14 | desc: 'Config file path', 15 | default: Config.defaultPath, 16 | requiresArg: true 17 | }) 18 | } 19 | exports.handler = async function (argv) { 20 | const convention = Config.load(argv.config).convention; 21 | const commitConvention = new CommitConvention(convention); 22 | 23 | const commitMessage = fs.readFileSync(argv.commitMsgFile).toString(); 24 | const commitSubject = commitMessage.split('\n')[0]; 25 | const conventionalCommit = commitConvention.parseCommit({ 26 | subject: commitSubject 27 | }); 28 | 29 | if (!conventionalCommit.type) { 30 | console.error('[ERROR] Invalid commit message'); 31 | console.error(` Valid message pattern: [()]: `); 32 | process.exit(2); 33 | } 34 | 35 | let conventionError = false 36 | 37 | if (conventionalCommit.type && 38 | convention.commitTypes && convention.commitTypes.length && 39 | !convention.commitTypes.includes(conventionalCommit.type)) { 40 | conventionError = true 41 | console.error(`[ERROR] Unexpected commit type: '${conventionalCommit.type}'`); 42 | const maxTypeLength = Math.max(...convention.commitTypes.map(s => s.length)); 43 | console.error(` Permitted types:\n` + 44 | convention.commitTypes.map(e => ` - ${e.padEnd(maxTypeLength )} ${convention.commitTypeDescriptions?.[e] ?? ''}`).join('\n')); 45 | } 46 | if (conventionalCommit.scope && 47 | convention.commitScopes && convention.commitScopes.length && 48 | !convention.commitScopes.includes(conventionalCommit.scope)) { 49 | conventionError = true 50 | console.error(`[ERROR] Unexpected commit scope: '${conventionalCommit.scope}'`); 51 | const maxScopeLength = Math.max(...convention.commitScopes.map(s => s.length)); 52 | console.error(` Permitted scopes:\n` + 53 | convention.commitScopes.map(e => ` - ${e.padEnd(maxScopeLength )} ${convention.commitScopeDescriptions?.[e] ?? ''}`).join('\n')); 54 | } 55 | 56 | if (conventionError) { 57 | console.error() 58 | console.error(`To adjust convention edit config file (${argv.config})`); 59 | process.exit(2); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /lib/commands/commandInit.js: -------------------------------------------------------------------------------- 1 | const Config = require("./config"); 2 | const fs = require("fs"); 3 | 4 | const gitCommitMsgHookDefaultPath = './.git/hooks/commit-msg' 5 | const gitCommitMsgHookTemplatePath = `${__dirname}/../../commit-msg.sh`; 6 | const LOG_WARN = '\x1b[1m\x1b[33m[WARN]\x1b[0m'; 7 | 8 | exports.command = 'init' 9 | exports.desc = `Creates config file and commit message hook` 10 | exports.builder = function (yargs) { 11 | yargs.option('config', { 12 | alias: 'c', 13 | desc: 'Config file path', 14 | default: Config.defaultPath, 15 | requiresArg: true 16 | }) 17 | } 18 | 19 | exports.handler = async function (argv) { 20 | if (!fs.existsSync(argv.config)) { 21 | console.info(`Creating config file ${argv.config}.`) 22 | fs.copyFileSync(Config.templatePath, argv.config, fs.constants.COPYFILE_EXCL); 23 | } else { 24 | console.warn(`${LOG_WARN} Could not creat config file ${argv.config}, because it already exists.`) 25 | } 26 | 27 | if (!fs.existsSync(gitCommitMsgHookDefaultPath)) { 28 | console.info(`Creating commit message hook ${gitCommitMsgHookDefaultPath}.`) 29 | fs.copyFileSync(gitCommitMsgHookTemplatePath, gitCommitMsgHookDefaultPath, fs.constants.COPYFILE_EXCL); 30 | } else { 31 | console.warn(`${LOG_WARN} Could not create message hook ${gitCommitMsgHookDefaultPath}, because it already exists.`) 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /lib/commands/commandVersion.js: -------------------------------------------------------------------------------- 1 | const Config = require("./config"); 2 | const CommitConvention = require("../gitCommitConvention"); 3 | 4 | exports.command = 'version' 5 | exports.desc = 'Determine version from conventional commits' 6 | exports.builder = function (yargs) { 7 | yargs.option('config', { 8 | alias: 'c', 9 | desc: 'Config file path', 10 | default: Config.defaultPath, 11 | requiresArg: true 12 | }) 13 | yargs.option('commit', { 14 | desc: 'Commit anchor e.g. v1.0.0', 15 | default: 'HEAD', 16 | requiresArg: true 17 | }) 18 | } 19 | 20 | exports.handler = async function (argv) { 21 | const config = Config.load(argv.config); 22 | const commitConvention = new CommitConvention(config.convention, argv.commit); 23 | 24 | const conventionalVersion = await commitConvention.getVersion(); 25 | 26 | console.log(conventionalVersion); 27 | } 28 | -------------------------------------------------------------------------------- /lib/commands/config.js: -------------------------------------------------------------------------------- 1 | const fs = require("fs"); 2 | const path = require("path"); 3 | const YAML = require('yaml') 4 | 5 | const defaultPath = "./git-conventional-commits.yaml"; 6 | const templatePath = `${__dirname}/../../git-conventional-commits.default.yaml`; 7 | 8 | function load(configFile) { 9 | configFile = configFile || defaultPath; 10 | 11 | // legacy support for json config 12 | if(!fs.existsSync(configFile) ) { 13 | const jsonPath = configFile.replace(/\.yaml$/,".json") 14 | if(fs.existsSync(jsonPath)) { 15 | configFile = jsonPath 16 | } 17 | } 18 | 19 | const configText = fs.readFileSync(path.resolve(configFile)).toString(); 20 | const configOverrideDocument = YAML.parseDocument(configText); 21 | const configOverride =configOverrideDocument.toJSON(); 22 | const config = defaultConfig(); 23 | 24 | if (configOverride.convention) { 25 | const conventionConfig = config.convention; 26 | const conventionOverride = configOverride.convention; 27 | conventionConfig.releaseTagGlobPattern = conventionOverride.releaseTagGlobPattern || 28 | conventionConfig.releaseTagGlobPattern; 29 | 30 | conventionConfig.msgRegex = RegExp(conventionOverride.commitMessageRegexPattern || conventionConfig.msgRegex); 31 | conventionConfig.commitTypes = conventionOverride.commitTypes || conventionConfig.commitTypes; 32 | conventionConfig.commitTypeDescriptions = configOverrideDocument 33 | .get('convention').get('commitTypes') 34 | .items.reduce((acc, item) => { 35 | acc[item.value] = [item.commentBefore?.trim(), item.comment?.trim()] 36 | .filter(Boolean).join('\n') || undefined; 37 | return acc; 38 | }, {}); 39 | conventionConfig.featureCommitTypes = conventionOverride.featureCommitTypes || conventionConfig.featureCommitTypes; 40 | conventionConfig.commitScopes = conventionOverride.commitScopes || conventionConfig.commitScopes; 41 | conventionConfig.commitScopeDescriptions = configOverrideDocument 42 | .get('convention').get('commitScopes') 43 | .items.reduce((acc, item) => { 44 | acc[item.value] = [item.commentBefore?.trim(), item.comment?.trim()] 45 | .filter(Boolean).join('\n') || undefined; 46 | return acc; 47 | }, {}); 48 | 49 | // Legacy support convention.issueRegexPattern 50 | config.changelog.issueRegexPattern = conventionOverride.issueRegexPattern || config.changelog.issueRegexPattern; 51 | } 52 | 53 | // check for mandatory capturing groups 54 | if (!hasAllCapturingGroups(config.convention.msgRegex, ['type', 'scope', 'breaking', 'description'])) { 55 | throw new Error(`msgRegex: ${config.convention.msgRegex.source} does not have all mandatory capture groups ('type', 'scope', 'breaking', 'description')`); 56 | } 57 | 58 | if (configOverride.changelog) { 59 | const changelogConfig = config.changelog; 60 | const changelogOverride = configOverride.changelog; 61 | changelogConfig.commitTypes = changelogOverride.commitTypes || changelogConfig.commitTypes; 62 | changelogConfig.includeInvalidCommits = changelogOverride.includeInvalidCommits !== undefined 63 | ? changelogOverride.includeInvalidCommits === true 64 | : changelogConfig.includeInvalidCommits; 65 | changelogConfig.commitScopes = changelogOverride.commitScopes || changelogConfig.commitScopes; 66 | changelogConfig.commitIgnoreRegexPattern = changelogOverride.commitIgnoreRegexPattern || changelogConfig.commitIgnoreRegexPattern; 67 | changelogConfig.headlines = { 68 | ...changelogConfig.headlines, 69 | ...changelogOverride.headlines 70 | }; 71 | 72 | changelogConfig.commitUrl = changelogOverride.commitUrl || changelogConfig.commitUrl; 73 | changelogConfig.commitRangeUrl = changelogOverride.commitRangeUrl || changelogConfig.commitRangeUrl; 74 | changelogConfig.issueRegexPattern = changelogOverride.issueRegexPattern || changelogConfig.issueRegexPattern; 75 | changelogConfig.issueUrl = changelogOverride.issueUrl || changelogConfig.issueUrl; 76 | } 77 | return config; 78 | } 79 | 80 | function defaultConfig() { 81 | const config = { 82 | convention: { 83 | releaseTagGlobPattern: "*", 84 | commitTypes: [ 85 | 'feat', 86 | 'fix', 87 | 'perf', 88 | 'refactor', 89 | 'style', 90 | 'test', 91 | 'build', 92 | 'ops', 93 | 'docs', 94 | 'chore', 95 | 'merge', 96 | ], 97 | commitTypeDescriptions: {}, 98 | featureCommitTypes: ['feat'], 99 | commitScopes: null, 100 | commitScopeDescriptions: {}, 101 | }, 102 | changelog: { 103 | commitTypes: ['feat', 'fix', 'perf'], 104 | includeInvalidCommits: true, 105 | commitScopes: null, 106 | commitIgnoreRegexPattern: "^WIP ", 107 | headlines: { 108 | "feat": "Features", 109 | "fix": "Bug Fixes", 110 | "perf": "Performance Improvements", 111 | "merge": "Merges", 112 | "breakingChange": "BREAKING CHANGES", 113 | "?": "? ? ?" 114 | }, 115 | commitUrl: null, 116 | commitRangeUrl: null, 117 | issueRegexPattern: null, 118 | issueUrl: null 119 | } 120 | }; 121 | 122 | // regex patterns 123 | config.convention.msgRegex = /^(?\w+)(?:\((?[^()]+)\))?(?!)?:\s*(?.+)/i; 124 | config.convention.msgMergeRegexList = [ 125 | /^Merge (?.+)/i, // Default Git merge message 126 | /^Merged in (?.+)/i, // Bitbucket merge message e.g. "Merged in team/repository/branch" 127 | ]; 128 | config.convention.msgRevertRegex = /^Revert +["'](?.+)['"]/i; 129 | config.convention.bodyRevertRegex = /(?\S+)\.+?$/im; // \S - no white spaces 130 | // match only release version e.g. 1.2.3 ((?:[^-]|$) ignores pre-release versions e.g. 1.2.3-SNAPSHOT) 131 | config.convention.semanticVersionRegex = /(?\d+)\.(?\d+)\.(?\d+)/; 132 | 133 | config.changelog.commitIgnoreRegex = () => RegExp(config.changelog.commitIgnoreRegexPattern || '(?!)',"m"); 134 | 135 | config.changelog.issueRegex = () => RegExp( 136 | "(?<=(^|\\s))" + (config.changelog.issueRegexPattern || '(?!)') + "(?=(\\s|$))", 137 | "mg" 138 | ); 139 | 140 | return config; 141 | } 142 | 143 | 144 | function hasAllCapturingGroups(exp, groups) { 145 | return groups.every(group => exp.source.includes(`(?<${group}>`)); 146 | } 147 | 148 | module.exports = { 149 | defaultPath, 150 | templatePath, 151 | load, 152 | defaultConfig, 153 | hasAllCapturingGroups 154 | } 155 | -------------------------------------------------------------------------------- /lib/execAsync.js: -------------------------------------------------------------------------------- 1 | const exec = require('child_process').exec; 2 | 3 | module.exports = function (command, options) { 4 | return new Promise(function (resolve, reject) { 5 | exec(command, options, (error, stdout, stderr) => { 6 | if (error) { 7 | reject(error); 8 | return; 9 | } 10 | resolve(stdout); 11 | }); 12 | }); 13 | } 14 | -------------------------------------------------------------------------------- /lib/git.js: -------------------------------------------------------------------------------- 1 | const execAsync = require('./execAsync'); 2 | 3 | /** 4 | * @function 5 | * @param {Object} options - changelog specific generator parameters. 6 | * @param {Object} [options.commitAnchor] - commit anchor. 7 | * @param {string} [options.matchPattern] - tag glob pattern. 8 | * @param {string} [options.excludePattern] - tag exclude glob pattern. 9 | */ 10 | async function getLastTag( 11 | { 12 | commitAnchor = 'HEAD', 13 | matchPattern= '*', 14 | excludePattern, 15 | } 16 | ) { 17 | return await execAsync(`git describe --tags --match=${matchPattern} ${excludePattern ? `--exclude=${excludePattern}` : ''} --no-abbrev ${commitAnchor}`, {encoding: 'UTF-8'}) 18 | .then(output => output.trim()) 19 | .catch(err => { 20 | // return undefined if no tag was found 21 | if (err.code === 128) { 22 | return; 23 | } 24 | throw err; 25 | }); 26 | } 27 | 28 | const LOG_COMMIT_DELIMITER = '===LOG_COMMIT_DELIMITER==='; 29 | const LOG_FIELD_SEPARATOR = '===LOG_FIELD_SEPARATOR==='; 30 | 31 | async function getCommitLog(from, to = 'HEAD') { 32 | const gitLogFormat = ["%H", "%aI", "%s", "%b"].join(LOG_FIELD_SEPARATOR) + LOG_COMMIT_DELIMITER; 33 | const gitLog = await execAsync(`git log --reverse --format=${gitLogFormat} ${from ? `${from}..` : ''}${to}`, {encoding: 'UTF-8'}) 34 | .then(result => result.split(LOG_COMMIT_DELIMITER + '\n').slice(0, -1)) 35 | .catch(err => { 36 | // return empty log if no commits available 37 | if (err.code === 128) { 38 | return []; 39 | } 40 | throw err; 41 | }); 42 | 43 | return gitLog.map(commit => commit.split(LOG_FIELD_SEPARATOR)) 44 | .map(fields => ({ 45 | hash: fields[0], 46 | date: new Date(fields[1]), 47 | subject: fields[2], 48 | body: fields[3] 49 | })); 50 | } 51 | 52 | async function isEqualCommit(rev1, rev2) { 53 | if (!rev1 && !rev2) { 54 | return true; 55 | } 56 | 57 | if (!rev1 || !rev2) { 58 | return false; 59 | } 60 | 61 | const hashArray = await execAsync(`git rev-parse "${rev1}^{}" "${rev2}^{}"`, {encoding: 'UTF-8'}) 62 | .then(result => result.split('\n')); 63 | 64 | return hashArray[0] === hashArray[1]; 65 | } 66 | 67 | module.exports = { 68 | getLastTag, 69 | getCommitLog, 70 | isEqualCommit, 71 | }; 72 | -------------------------------------------------------------------------------- /lib/gitCommitConvention.js: -------------------------------------------------------------------------------- 1 | const Git = require("./git"); 2 | const {applyChangesToVersion} = require("./semver"); 3 | 4 | module.exports = function (convention, commitAnchor = 'HEAD') { 5 | 6 | let commitLog 7 | 8 | this.getCommitLog = async function () { 9 | if (commitLog === undefined) { 10 | let lastReleaseTag = await getLastReleaseTag(commitAnchor) 11 | if (await Git.isEqualCommit(lastReleaseTag, commitAnchor)) { 12 | lastReleaseTag = await getLastReleaseTag(commitAnchor + '~1') 13 | } 14 | const commits = await Git.getCommitLog(lastReleaseTag, commitAnchor); 15 | commitLog = commits.map(this.parseCommit); 16 | } 17 | return commitLog 18 | } 19 | 20 | this.getVersion = async function () { 21 | let version = { 22 | major: 0, 23 | minor: 0, 24 | patch: 0 25 | }; 26 | 27 | const lastReleaseTag = await getLastReleaseTag(commitAnchor); 28 | if (lastReleaseTag) { 29 | const lastVersionMatch = lastReleaseTag.match(convention.semanticVersionRegex); 30 | if (!lastVersionMatch) { 31 | console.error(`[ERROR] could not find semantic version pattern within last release tag '${lastReleaseTag}'`); 32 | process.exit(2); 33 | } 34 | 35 | version = { 36 | major: parseInt(lastVersionMatch.groups.major), 37 | minor: lastVersionMatch.groups.minor ? parseInt(lastVersionMatch.groups.minor) : 0, 38 | patch: lastVersionMatch.groups.patch ? parseInt(lastVersionMatch.groups.patch) : 0, 39 | } 40 | } 41 | 42 | if (!await Git.isEqualCommit(lastReleaseTag, commitAnchor)) { 43 | // ------determine version bump --------------------------------------- 44 | 45 | const changes = (await this.getCommitLog()).reduce((acc, commit) => { 46 | if (commit.breakingChanges && commit.breakingChanges.length) { 47 | acc.breaking++; 48 | } else if (convention.featureCommitTypes.includes(commit.type)) { 49 | acc.features++; 50 | } else { 51 | acc.patches++; 52 | } 53 | return acc; 54 | }, {breaking: 0, features: 0, patches: 0}); 55 | 56 | applyChangesToVersion(version, changes); 57 | } 58 | 59 | return `${version.major}.${version.minor}.${version.patch}`; 60 | } 61 | 62 | this.parseCommit = function (commit) { 63 | const conventionalCommit = { 64 | ...commit 65 | }; 66 | 67 | // parse subject 68 | const conventionalSubject = parseCommitSubject(commit); 69 | Object.assign(conventionalCommit, conventionalSubject); 70 | 71 | // parse breaking changes 72 | conventionalCommit.breakingChanges = commit.body ? commit.body.split(/^BREAKING[ -]CHANGES?: */im).splice(1) : []; 73 | if (conventionalSubject.breaking && !conventionalCommit.breakingChanges.length) { 74 | conventionalCommit.breakingChanges = [conventionalSubject.description] 75 | } 76 | delete conventionalCommit.breaking; 77 | 78 | return conventionalCommit; 79 | } 80 | 81 | function parseCommitSubject(commit) { 82 | let conventionalSubject = { 83 | ...commit, 84 | description: commit.subject, 85 | }; 86 | 87 | const msgMatch = commit.subject.match(convention.msgRegex); 88 | if (msgMatch) { 89 | conventionalSubject.type = msgMatch.groups.type; 90 | if (!conventionalSubject.type) 91 | throw new Error(`Invalid msgRegex: ${convention.msgRegex}. Capturing group 'type' is empty.`); 92 | conventionalSubject.scope = msgMatch.groups.scope === '' ? undefined : msgMatch.groups.scope; 93 | conventionalSubject.breaking = msgMatch.groups.breaking === '!'; 94 | conventionalSubject.description = msgMatch.groups.description; 95 | if (!conventionalSubject.description) 96 | throw new Error(`Invalid msgRegex: ${convention.msgRegex}. Capturing group 'description' is empty.`); 97 | } else { 98 | const msgMergeMatch = getFirstMatch(commit.subject, convention.msgMergeRegexList); 99 | if (msgMergeMatch) { 100 | conventionalSubject.type = 'merge'; 101 | conventionalSubject.description = msgMergeMatch.groups.description; 102 | } else { 103 | const msgRevertMatch = commit.subject.match(convention.msgRevertRegex); 104 | if (msgRevertMatch) { 105 | conventionalSubject.subject = msgRevertMatch.groups.subject; 106 | conventionalSubject = parseCommitSubject(conventionalSubject); 107 | conventionalSubject.revert = !conventionalSubject.revert; // negate revert of revert commit 108 | } else { 109 | console.warn(`[WARN] ${commit.hash ? `${commit.hash.substring(0, 7)} - ` : ''}Invalid commit subject format: '${commit.subject}'`); 110 | return conventionalSubject; 111 | } 112 | } 113 | } 114 | 115 | if (conventionalSubject.type && 116 | convention.commitTypes && convention.commitTypes.length && 117 | !convention.commitTypes.includes(conventionalSubject.type)) { 118 | console.warn(`[WARN] ${commit.hash ? `${commit.hash.substring(0, 7)} - ` : ''}Unexpected commit type: '${conventionalSubject.type}'`); 119 | } 120 | if (conventionalSubject.scope && 121 | convention.commitScopes && convention.commitScopes.length && 122 | !convention.commitScopes.includes(conventionalSubject.scope)) { 123 | console.warn(`[WARN] ${commit.hash ? `${commit.hash.substring(0, 7)} - ` : ''}Unexpected commit scope: '${conventionalSubject.scope}'`); 124 | } 125 | 126 | return conventionalSubject; 127 | } 128 | 129 | async function getLastReleaseTag(commitRef) { 130 | return await Git.getLastTag({ 131 | commitAnchor: commitRef, 132 | matchPattern: convention.releaseTagGlobPattern, 133 | excludePattern: `${convention.releaseTagGlobPattern}-*`, // exclude pre-release versions 134 | }) 135 | } 136 | 137 | function getFirstMatch(string, regexList) { 138 | for (const regex of regexList) { 139 | const match = string.match(regex); 140 | if (match) { 141 | return match; 142 | } 143 | } 144 | } 145 | }; 146 | -------------------------------------------------------------------------------- /lib/semver.js: -------------------------------------------------------------------------------- 1 | function applyChangesToVersion(version, changes) { 2 | // SemVer 2.0.0 §4: public api should not be considered stable when major version is 0 3 | if (version.major === 0) { 4 | // never change major version in development releases 5 | if (changes.breaking > 0 || changes.features > 0) { 6 | version.minor++; 7 | version.patch = 0; 8 | return; 9 | } 10 | if (changes.patches > 0) { 11 | version.patch++; 12 | return; 13 | } 14 | } 15 | 16 | if (changes.breaking > 0) { 17 | version.major++; 18 | version.minor = 0; 19 | version.patch = 0; 20 | return; 21 | } 22 | if (changes.features > 0) { 23 | version.minor++; 24 | version.patch = 0; 25 | return; 26 | } 27 | if (changes.patches > 0) { 28 | version.patch++; 29 | return; 30 | } 31 | } 32 | 33 | module.exports = { 34 | applyChangesToVersion, 35 | }; 36 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "git-conventional-commits", 3 | "version": "2.8.0", 4 | "description": "git conventional commits util", 5 | "licence": "GPLv3", 6 | "main": "cli.js", 7 | "scripts": { 8 | "start": "./cli.js", 9 | "test": "jest" 10 | }, 11 | "repository": "github:qoomon/git-conventional-commits", 12 | "author": "", 13 | "dependencies": { 14 | "yaml": "^2.1.3", 15 | "yargs": "^17.6.2" 16 | }, 17 | "devDependencies": { 18 | "jest": "^29.5.0", 19 | "tmp-promise": "^3.0.3" 20 | }, 21 | "bin": { 22 | "git-conventional-commits": "cli.js" 23 | }, 24 | "files": [ 25 | "cli.js", 26 | "lib/", 27 | "git-conventional-commits.default.yaml", 28 | "commit-msg.sh" 29 | ] 30 | } 31 | -------------------------------------------------------------------------------- /test/commands/commandChangelog.test.js: -------------------------------------------------------------------------------- 1 | const fs = require("fs"); 2 | const path = require("path"); 3 | const temp = require("tmp-promise"); 4 | const execAsync = require("../../lib/execAsync"); 5 | const YAML = require('yaml') 6 | 7 | const commandChangelog = require("../../lib/commands/commandChangelog"); 8 | 9 | 10 | beforeEach(async () => { 11 | const tempDirectory = await temp.dir(); 12 | process.chdir(tempDirectory.path); 13 | 14 | await execAsync("git init"); 15 | 16 | const config = {} 17 | fs.writeFileSync("git-conventional-commits.yaml", YAML.stringify(config), 'utf8'); 18 | }); 19 | 20 | const createSimpleChangelog = async (commitSubject, commitBody) => { 21 | const changelogFile = "CHANGELOG.md"; 22 | 23 | // add commitMessage 0 24 | fs.writeFileSync("text.txt", "0"); 25 | await execAsync("git add text.txt"); 26 | await execAsync("git commit -a -m init"); 27 | 28 | // add tag 1 29 | const givenVersionTag1 = "v1.0.0"; 30 | await execAsync(`git tag -a -m ${givenVersionTag1} ${givenVersionTag1}`); 31 | 32 | // add commitMessage 1 33 | fs.writeFileSync("text.txt", "1"); 34 | 35 | let gitCmd = `git commit -a -m "${commitSubject}"`; 36 | if (commitBody) { 37 | gitCmd += ` -m "${commitBody}"`; 38 | } 39 | await execAsync(gitCmd); 40 | 41 | // WHEN 42 | await commandChangelog.handler({ 43 | config: "./git-conventional-commits.yaml", 44 | file: changelogFile, 45 | }); 46 | 47 | return fs.readFileSync(changelogFile).toString(); 48 | }; 49 | 50 | test("commandChangelog - included commit", async () => { 51 | // GIVEN 52 | const commitType = "fix"; 53 | const commitMessage = "prevent bad stuff from happening"; 54 | const commitSubject = `${commitType}: ${commitMessage}`; 55 | 56 | // WHEN 57 | const changelogString = await createSimpleChangelog(commitSubject, null); 58 | 59 | // THEN 60 | expect(changelogString).toMatch( 61 | new RegExp(`Bug Fixes\\s+-\\s+${commitMessage}`, "g") 62 | ); 63 | }); 64 | 65 | test("commandChangelog - ignored commit", async () => { 66 | // GIVEN 67 | const commitType = "refactor"; 68 | const commitMessage = "make all private fields lowercase"; 69 | const commitSubject = `${commitType}: ${commitMessage}`; 70 | 71 | // WHEN 72 | const changelogString = await createSimpleChangelog(commitSubject, null); 73 | 74 | // THEN 75 | expect(changelogString).toMatch(/no relevant changes/); 76 | }); 77 | 78 | test("commandChangelog - included because breaking", async () => { 79 | // GIVEN 80 | const commitType = "refactor"; 81 | const commitMessage = "make all private fields lowercase"; 82 | const commitSubject = `${commitType}: ${commitMessage}`; 83 | 84 | const commitBodyType = "BREAKING CHANGES"; 85 | const commitBodyMessage = 86 | "configuration field foo is renamed to bar, update your configuration file"; 87 | const commitBody = `${commitBodyType}: ${commitBodyMessage}`; 88 | 89 | // WHEN 90 | const changelogString = await createSimpleChangelog( 91 | commitSubject, 92 | commitBody 93 | ); 94 | 95 | // THEN 96 | expect(changelogString).toMatch( 97 | new RegExp(`BREAKING CHANGES\\s+-\\s+${commitBodyMessage}`, "g") 98 | ); 99 | }); 100 | 101 | test("commandChangelog - ignored by regex pattern", async () => { 102 | // GIVEN 103 | const commitType = "fix"; 104 | const commitMessage = "Just a work in progress"; 105 | const commitSubject = `${commitType}: ${commitMessage}`; 106 | 107 | const commitBody = "WIP I want to be ignored"; 108 | 109 | // WHEN 110 | const changelogString = await createSimpleChangelog( 111 | commitSubject, 112 | commitBody 113 | ); 114 | 115 | // THEN 116 | expect(changelogString).toMatch(/no relevant changes/); 117 | }); 118 | -------------------------------------------------------------------------------- /test/commands/config.test.js: -------------------------------------------------------------------------------- 1 | const config = require("../../lib/commands/config"); 2 | 3 | 4 | test("config - message RegEx", async () => { 5 | // GIVEN 6 | const requiredCaptureGroups = ['type', 'scope', 'breaking', 'description']; 7 | 8 | 9 | // WHEN 10 | const validMsgRegex = /^(?\w+)(?:\((?[^()]+)\))?(?!)?:\s*(?.+)/i; 11 | const invalidMsgRegex = /(?:\((?[^()]+)\))?(?!)?:\s*(?.+)/i; 12 | 13 | // THEN 14 | expect(config.hasAllCapturingGroups(validMsgRegex, requiredCaptureGroups)).toBe(true); 15 | expect(config.hasAllCapturingGroups(invalidMsgRegex, requiredCaptureGroups)).toBe(false); 16 | }); 17 | 18 | test("config - merge RegEx", async () => { 19 | // GIVEN 20 | const requiredCaptureGroups = ['description']; 21 | 22 | 23 | // WHEN 24 | const validMsgRegex = /^Merge (?.+)/i; 25 | const invalidMsgRegex = /^Merge (?.+)/i; 26 | 27 | // THEN 28 | expect(config.hasAllCapturingGroups(validMsgRegex, requiredCaptureGroups)).toBe(true); 29 | expect(config.hasAllCapturingGroups(invalidMsgRegex, requiredCaptureGroups)).toBe(false); 30 | }); 31 | 32 | 33 | -------------------------------------------------------------------------------- /test/git.test.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs'); 2 | const temp = require('tmp-promise'); 3 | const execAsync = require('../lib/execAsync'); 4 | 5 | 6 | const Git = require('../lib/git'); 7 | 8 | 9 | beforeEach(async () => { 10 | const gitDir = await temp.dir(); 11 | process.chdir(gitDir.path); 12 | await execAsync('git init'); 13 | }); 14 | 15 | 16 | test('getLastTag', async () => { 17 | 18 | // GIVEN 19 | 20 | // add commit 0 21 | fs.writeFileSync('text.txt', 'Lorem ipsum 0'); 22 | await execAsync('git add text.txt'); 23 | await execAsync('git commit -a -m init'); 24 | 25 | // add commit 1 26 | fs.writeFileSync('text.txt', 'Lorem ipsum 1'); 27 | await execAsync('git commit -a -m "update 1"'); 28 | 29 | // add tag 1 30 | const givenVersionTag1 = 'v1.0.0'; 31 | await execAsync(`git tag -a -m ${givenVersionTag1} ${givenVersionTag1}`); 32 | 33 | // add commit 2 34 | fs.writeFileSync('text.txt', 'Lorem ipsum 2'); 35 | await execAsync('git commit -a -m "update 2"'); 36 | 37 | // add tag 2 38 | const givenVersionTag2 = 'v2.0.0'; 39 | await execAsync(`git tag -a -m ${givenVersionTag2} ${givenVersionTag2}`); 40 | 41 | 42 | // WHEN 43 | let lastVersionTag = await Git.getLastTag({matchPattern: 'v*'}); 44 | 45 | 46 | // THEN 47 | expect(lastVersionTag).toBe(givenVersionTag2) 48 | }); 49 | 50 | test('getLastTag - skipTagOnRev=false', async () => { 51 | 52 | // GIVEN 53 | 54 | // add commit 0 55 | fs.writeFileSync('text.txt', 'Lorem ipsum 0'); 56 | await execAsync('git add text.txt'); 57 | await execAsync('git commit -a -m init'); 58 | 59 | // add commit 1 60 | fs.writeFileSync('text.txt', 'Lorem ipsum 1'); 61 | await execAsync('git commit -a -m "update 1"'); 62 | 63 | // add tag 1 64 | const givenVersionTag1 = 'v1.0.0'; 65 | await execAsync(`git tag -a -m ${givenVersionTag1} ${givenVersionTag1}`); 66 | 67 | // add commit 2 68 | fs.writeFileSync('text.txt', 'Lorem ipsum 2'); 69 | await execAsync('git commit -a -m "update 2"'); 70 | 71 | // add tag 2 72 | const givenVersionTag2 = 'v2.0.0'; 73 | await execAsync(`git tag -a -m ${givenVersionTag2} ${givenVersionTag2}`); 74 | 75 | 76 | // WHEN 77 | let lastVersionTag = await Git.getLastTag({matchPattern: 'v*'}); 78 | 79 | 80 | // THEN 81 | expect(lastVersionTag).toBe(givenVersionTag2) 82 | }); 83 | 84 | test('commitLog', async () => { 85 | 86 | // GIVEN 87 | 88 | // add commit 0 89 | fs.writeFileSync('text.txt', 'Lorem ipsum 0'); 90 | await execAsync('git add text.txt'); 91 | await execAsync('git commit -a -m init'); 92 | 93 | // add commit 1 94 | fs.writeFileSync('text.txt', 'Lorem ipsum 1'); 95 | await execAsync('git commit -a -m "update 1"'); 96 | 97 | // add tag 1 98 | const givenVersionTag1 = 'v1.0.0'; 99 | await execAsync(`git tag -a -m ${givenVersionTag1} ${givenVersionTag1}`); 100 | 101 | // add commit 2 102 | fs.writeFileSync('text.txt', 'Lorem ipsum 2'); 103 | await execAsync('git commit -a -m "update 2"'); 104 | 105 | // add commit 3 106 | fs.writeFileSync('text.txt', 'Lorem ipsum 3'); 107 | await execAsync('git commit -a -m "update 3"'); 108 | 109 | 110 | // WHEN 111 | let gitCommitLog = await Git.getCommitLog(givenVersionTag1); 112 | 113 | 114 | // THEN 115 | expect(gitCommitLog.length).toBe(2); 116 | expect(gitCommitLog[0]).toEqual({ 117 | hash: expect.any(String), 118 | date: expect.any(Date), 119 | body: '', 120 | subject: 'update 2' 121 | }); 122 | 123 | expect(gitCommitLog[1]).toEqual({ 124 | hash: expect.any(String), 125 | date: expect.any(Date), 126 | body: '', 127 | subject: 'update 3' 128 | }) 129 | }); 130 | -------------------------------------------------------------------------------- /test/gitCommitConvention.test.js: -------------------------------------------------------------------------------- 1 | const Config = require('../lib/commands/config'); 2 | const CommitConvention = require('../lib/gitCommitConvention'); 3 | 4 | test('parseCommit', async () => { 5 | 6 | // GIVEN 7 | const conventionConfig = Config.defaultConfig().convention; 8 | const commitConvention = new CommitConvention(conventionConfig); 9 | const commit = { 10 | hash: "1c9d750", 11 | subject: "feat(ui): new shit", 12 | body: '' 13 | }; 14 | 15 | 16 | // WHEN 17 | let conventionalCommit = await commitConvention.parseCommit(commit); 18 | 19 | 20 | // THEN 21 | expect(conventionalCommit).toEqual({ 22 | hash: commit.hash, 23 | subject: commit.subject, 24 | body: commit.body, 25 | type: 'feat', 26 | scope: 'ui', 27 | description: 'new shit', 28 | breakingChanges: [], 29 | }) 30 | }); 31 | 32 | test('parseCommit - breaking changes - description', async () => { 33 | 34 | // GIVEN 35 | const conventionConfig = Config.defaultConfig().convention; 36 | const commitConvention = new CommitConvention(conventionConfig); 37 | const commit = { 38 | hash: "1c9d750", 39 | subject: "feat!: Ditch support of windows XP", 40 | body: '' 41 | }; 42 | 43 | 44 | // WHEN 45 | let conventionalCommit = await commitConvention.parseCommit(commit); 46 | 47 | 48 | // THEN 49 | expect(conventionalCommit).toEqual({ 50 | hash: commit.hash, 51 | subject: commit.subject, 52 | body: commit.body, 53 | type: 'feat', 54 | scope: undefined, 55 | description: 'Ditch support of windows XP', 56 | breakingChanges: ["Ditch support of windows XP"], 57 | }) 58 | }); 59 | 60 | test('parseCommit - breaking changes - body', async () => { 61 | 62 | // GIVEN 63 | const conventionConfig = Config.defaultConfig().convention; 64 | const commitConvention = new CommitConvention(conventionConfig); 65 | const commit = { 66 | hash: "1c9d750", 67 | subject: "feat: new shit", 68 | body: 'BREAKING CHANGE: Ditch support of windows XP' 69 | }; 70 | 71 | 72 | // WHEN 73 | let conventionalCommit = await commitConvention.parseCommit(commit); 74 | 75 | 76 | // THEN 77 | expect(conventionalCommit).toEqual({ 78 | hash: commit.hash, 79 | subject: commit.subject, 80 | body: commit.body, 81 | type: 'feat', 82 | scope: undefined, 83 | description: 'new shit', 84 | breakingChanges: ["Ditch support of windows XP"], 85 | }) 86 | }); 87 | -------------------------------------------------------------------------------- /test/semver.test.js: -------------------------------------------------------------------------------- 1 | const {applyChangesToVersion} = require("../lib/semver"); 2 | 3 | const applyChangesToVersionTest = (versionString, changesString, expectedString) => { 4 | test(`applyChangesToVersion - ${versionString} + ${changesString} -> ${expectedString}`, async () => { 5 | // GIVEN 6 | const p = s => parseInt(s, 10); 7 | const givenVersionSplit = versionString.split('.').map(p); 8 | const givenVersion = { 9 | major: givenVersionSplit[0], 10 | minor: givenVersionSplit[1], 11 | patch: givenVersionSplit[2], 12 | }; 13 | const changeSplit = changesString.split('.').map(p); 14 | const changes = { 15 | breaking: changeSplit[0], 16 | features: changeSplit[1], 17 | patches: changeSplit[2], 18 | }; 19 | 20 | const expectedVersionSplit = expectedString.split('.').map(p); 21 | const expectedVersion = { 22 | major: expectedVersionSplit[0], 23 | minor: expectedVersionSplit[1], 24 | patch: expectedVersionSplit[2], 25 | } 26 | 27 | // WHEN 28 | applyChangesToVersion(givenVersion, changes); 29 | 30 | // THEN 31 | expect(givenVersion).toEqual(expectedVersion); 32 | }); 33 | }; 34 | 35 | // pure changes (either major, minor or patch) to stable version 36 | applyChangesToVersionTest("1.0.0", "0.0.1", "1.0.1"); 37 | applyChangesToVersionTest("1.0.0", "0.1.0", "1.1.0"); 38 | applyChangesToVersionTest("1.0.0", "1.0.0", "2.0.0"); 39 | 40 | // mixed changes (at least two of major, minor or patch) to stable version 41 | applyChangesToVersionTest("1.0.0", "0.1.1", "1.1.0"); 42 | applyChangesToVersionTest("1.0.0", "1.1.0", "2.0.0"); 43 | applyChangesToVersionTest("1.0.0", "1.0.1", "2.0.0"); 44 | 45 | // pure changes (either major, minor or patch) to development version 46 | applyChangesToVersionTest("0.1.0", "0.0.1", "0.1.1"); 47 | applyChangesToVersionTest("0.1.0", "0.1.0", "0.2.0"); 48 | applyChangesToVersionTest("0.1.0", "1.0.0", "0.2.0"); 49 | 50 | // mixed changes (at least two of major, minor or patch) to development version 51 | applyChangesToVersionTest("0.1.0", "0.1.1", "0.2.0"); 52 | applyChangesToVersionTest("0.1.0", "1.1.0", "0.2.0"); 53 | applyChangesToVersionTest("0.1.0", "1.0.1", "0.2.0"); 54 | --------------------------------------------------------------------------------