├── .github └── workflows │ └── continuous-integration.yml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── cleanup-2-x-x-mess.sh ├── docs ├── hooks │ ├── junk-checker.md │ ├── make.md │ ├── php │ │ ├── composer.md │ │ ├── cs-fixer.md │ │ ├── ctags.md │ │ ├── doctrine.md │ │ └── sismo.md │ ├── syntax-checker.md │ ├── ticketref.md │ └── work-in-progress.md ├── index.md ├── requirements.txt ├── upgrade │ └── 2-to-3.md └── usage.md ├── mkdocs.yml ├── template ├── HEAD ├── configure.sh └── hooks │ ├── change_detector.sh │ ├── commit-msg │ ├── git_config_wrapper.sh │ ├── hook_switcher.sh │ ├── junkchecker │ ├── junk-phrases.sample │ └── pre-commit │ ├── make │ ├── pre-commit │ ├── pre-push │ └── run-make │ ├── php │ ├── composer │ │ ├── post-checkout │ │ ├── post-merge │ │ ├── pre-commit │ │ └── react.sh │ ├── cs-fixer │ │ ├── fix-cs │ │ └── pre-commit │ ├── ctags │ │ ├── configure.sh │ │ ├── post-checkout │ │ ├── post-commit │ │ ├── post-merge │ │ └── update-ctags │ ├── doctrine │ │ ├── post-checkout │ │ ├── post-commit │ │ └── update-schema │ └── sismo │ │ ├── build-project │ │ ├── configure.sh │ │ └── post-commit │ ├── post-checkout │ ├── post-commit │ ├── post-merge │ ├── post-rewrite │ ├── pre-commit │ ├── pre-push │ ├── syntaxchecker │ ├── php.sh │ ├── pre-commit │ └── xlf.sh │ ├── ticketref │ └── commit-msg │ └── wipchecker │ └── pre-push ├── tests ├── all.sh ├── git_config_wrapper_test.sh ├── hook_switcher_test.sh ├── junkchecker_test.sh ├── make_test.sh ├── php │ ├── composer_test.sh │ ├── ctags_test.sh │ ├── doctrine_test.sh │ ├── phpcs_fixer_test.sh │ └── sismo_test.sh ├── syntaxchecker_test.sh ├── ticketref_test.sh └── wipchecker_test.sh └── update.sh /.github/workflows/continuous-integration.yml: -------------------------------------------------------------------------------- 1 | name: "Continuous Integration" 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - "main" 7 | push: 8 | branches: 9 | - "main" 10 | 11 | env: 12 | fail-fast: true 13 | 14 | jobs: 15 | shunit: 16 | name: "SHUnit" 17 | runs-on: "ubuntu-20.04" 18 | 19 | steps: 20 | - name: "Checkout" 21 | uses: "actions/checkout@v2" 22 | 23 | - name: "Configure" 24 | run: | 25 | git config --global init.templatedir "$(pwd)/template" 26 | git config --global user.email "travis@mailinator.com" 27 | git config --global user.name "Travis Bot" 28 | mkdir -p ~/src/shunit2 29 | git clone https://github.com/kward/shunit2.git ~/src/shunit2 30 | svn checkout https://svn.code.sf.net/p/ctags/code/trunk ~/src/ctags 31 | cd ~/src/ctags 32 | wget http://sourceforge.net/p/ctags/patches/_discuss/thread/3a930d9f/1405/attachment/0000-PHP-parser-rewrite.patch 33 | patch -p1 < 0000-PHP-parser-rewrite.patch 34 | autoconf 35 | autoheader 36 | ./configure 37 | make 38 | chmod +x ctags 39 | 40 | - name: "Run tests" 41 | run: "export PATH=~/src/shunit2:~/src/ctags:$PATH && tests/all.sh" 42 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to git_template 2 | 3 | ## Running the test suite 4 | 5 | First, you must make sure you're able to run the test suite. 6 | 7 | Get this random [shunit2][1] fork in ~/src : 8 | 9 | git clone git@github.com:kward/shunit2.git 10 | 11 | add the resulting directory to your `$PATH`, and run `tests/all.sh`. 12 | 13 | ## General contribution guidelines 14 | 15 | Tabs are used for indention. 16 | 17 | When using commands, prefer long options against short options. I invented the 18 | following rule, please follow it: 19 | 20 | > Short options are for the command line, long options are for scripts. 21 | 22 | Also, try adding tests along with your contributions. 23 | 24 | ## Contributing a plugin 25 | 26 | Creating your php plugin is as easy as creating a php folder under `hooks/php`. 27 | You can then create hooks in it. For the moment, only the following are supported 28 | (because I'm lazy) 29 | 30 | * `post-commit` 31 | * `post-checkout` 32 | * `post-merge` 33 | * `post-rewrite` 34 | * `pre-push` 35 | * `pre-commit` 36 | 37 | If you need to add configuration variables git configuration, you should prefix 38 | them with the path to your hook, which is obviously unique. This will avoid 39 | collisions. 40 | 41 | [1]: https://code.google.com/p/shunit2/ 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | GNU GENERAL PUBLIC LICENSE 5 | Version 3, 29 June 2007 6 | 7 | Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/] 8 | Everyone is permitted to copy and distribute verbatim copies 9 | of this license document, but changing it is not allowed. 10 | 11 | Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom to 19 | share and change all versions of a program--to make sure it remains free 20 | software for all its users. We, the Free Software Foundation, use the 21 | GNU General Public License for most of our software; it applies also to 22 | any other work released this way by its authors. You can apply it to 23 | your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you have 34 | certain responsibilities if you distribute copies of the software, or if 35 | you modify it: responsibilities to respect the freedom of others. 36 | 37 | For example, if you distribute copies of such a program, whether 38 | gratis or for a fee, you must pass on to the recipients the same 39 | freedoms that you received. You must make sure that they, too, receive 40 | or can get the source code. And you must show them these terms so they 41 | know their rights. 42 | 43 | Developers that use the GNU GPL protect your rights with two steps: 44 | (1) assert copyright on the software, and (2) offer you this License 45 | giving you legal permission to copy, distribute and/or modify it. 46 | 47 | For the developers' and authors' protection, the GPL clearly explains 48 | that there is no warranty for this free software. For both users' and 49 | authors' sake, the GPL requires that modified versions be marked as 50 | changed, so that their problems will not be attributed erroneously to 51 | authors of previous versions. 52 | 53 | Some devices are designed to deny users access to install or run 54 | modified versions of the software inside them, although the manufacturer 55 | can do so. This is fundamentally incompatible with the aim of 56 | protecting users' freedom to change the software. The systematic 57 | pattern of such abuse occurs in the area of products for individuals to 58 | use, which is precisely where it is most unacceptable. Therefore, we 59 | have designed this version of the GPL to prohibit the practice for those 60 | products. If such problems arise substantially in other domains, we 61 | stand ready to extend this provision to those domains in future versions 62 | of the GPL, as needed to protect the freedom of users. 63 | 64 | Finally, every program is threatened constantly by software patents. 65 | States should not allow patents to restrict development and use of 66 | software on general-purpose computers, but in those that do, we wish to 67 | avoid the special danger that patents applied to a free program could 68 | make it effectively proprietary. To prevent this, the GPL assures that 69 | patents cannot be used to render the program non-free. 70 | 71 | The precise terms and conditions for copying, distribution and 72 | modification follow. 73 | 74 | TERMS AND CONDITIONS 75 | 76 | 0. Definitions. 77 | 78 | "This License" refers to version 3 of the GNU General Public License. 79 | 80 | "Copyright" also means copyright-like laws that apply to other kinds of 81 | works, such as semiconductor masks. 82 | 83 | "The Program" refers to any copyrightable work licensed under this 84 | License. Each licensee is addressed as "you". "Licensees" and 85 | "recipients" may be individuals or organizations. 86 | 87 | To "modify" a work means to copy from or adapt all or part of the work 88 | in a fashion requiring copyright permission, other than the making of an 89 | exact copy. The resulting work is called a "modified version" of the 90 | earlier work or a work "based on" the earlier work. 91 | 92 | A "covered work" means either the unmodified Program or a work based 93 | on the Program. 94 | 95 | To "propagate" a work means to do anything with it that, without 96 | permission, would make you directly or secondarily liable for 97 | infringement under applicable copyright law, except executing it on a 98 | computer or modifying a private copy. Propagation includes copying, 99 | distribution (with or without modification), making available to the 100 | public, and in some countries other activities as well. 101 | 102 | To "convey" a work means any kind of propagation that enables other 103 | parties to make or receive copies. Mere interaction with a user through 104 | a computer network, with no transfer of a copy, is not conveying. 105 | 106 | An interactive user interface displays "Appropriate Legal Notices" 107 | to the extent that it includes a convenient and prominently visible 108 | feature that (1) displays an appropriate copyright notice, and (2) 109 | tells the user that there is no warranty for the work (except to the 110 | extent that warranties are provided), that licensees may convey the 111 | work under this License, and how to view a copy of this License. If 112 | the interface presents a list of user commands or options, such as a 113 | menu, a prominent item in the list meets this criterion. 114 | 115 | 1. Source Code. 116 | 117 | The "source code" for a work means the preferred form of the work 118 | for making modifications to it. "Object code" means any non-source 119 | form of a work. 120 | 121 | A "Standard Interface" means an interface that either is an official 122 | standard defined by a recognized standards body, or, in the case of 123 | interfaces specified for a particular programming language, one that 124 | is widely used among developers working in that language. 125 | 126 | The "System Libraries" of an executable work include anything, other 127 | than the work as a whole, that (a) is included in the normal form of 128 | packaging a Major Component, but which is not part of that Major 129 | Component, and (b) serves only to enable use of the work with that 130 | Major Component, or to implement a Standard Interface for which an 131 | implementation is available to the public in source code form. A 132 | "Major Component", in this context, means a major essential component 133 | (kernel, window system, and so on) of the specific operating system 134 | (if any) on which the executable work runs, or a compiler used to 135 | produce the work, or an object code interpreter used to run it. 136 | 137 | The "Corresponding Source" for a work in object code form means all 138 | the source code needed to generate, install, and (for an executable 139 | work) run the object code and to modify the work, including scripts to 140 | control those activities. However, it does not include the work's 141 | System Libraries, or general-purpose tools or generally available free 142 | programs which are used unmodified in performing those activities but 143 | which are not part of the work. For example, Corresponding Source 144 | includes interface definition files associated with source files for 145 | the work, and the source code for shared libraries and dynamically 146 | linked subprograms that the work is specifically designed to require, 147 | such as by intimate data communication or control flow between those 148 | subprograms and other parts of the work. 149 | 150 | The Corresponding Source need not include anything that users 151 | can regenerate automatically from other parts of the Corresponding 152 | Source. 153 | 154 | The Corresponding Source for a work in source code form is that 155 | same work. 156 | 157 | 2. Basic Permissions. 158 | 159 | All rights granted under this License are granted for the term of 160 | copyright on the Program, and are irrevocable provided the stated 161 | conditions are met. This License explicitly affirms your unlimited 162 | permission to run the unmodified Program. The output from running a 163 | covered work is covered by this License only if the output, given its 164 | content, constitutes a covered work. This License acknowledges your 165 | rights of fair use or other equivalent, as provided by copyright law. 166 | 167 | You may make, run and propagate covered works that you do not 168 | convey, without conditions so long as your license otherwise remains 169 | in force. You may convey covered works to others for the sole purpose 170 | of having them make modifications exclusively for you, or provide you 171 | with facilities for running those works, provided that you comply with 172 | the terms of this License in conveying all material for which you do 173 | not control copyright. Those thus making or running the covered works 174 | for you must do so exclusively on your behalf, under your direction 175 | and control, on terms that prohibit them from making any copies of 176 | your copyrighted material outside their relationship with you. 177 | 178 | Conveying under any other circumstances is permitted solely under 179 | the conditions stated below. Sublicensing is not allowed; section 10 180 | makes it unnecessary. 181 | 182 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 183 | 184 | No covered work shall be deemed part of an effective technological 185 | measure under any applicable law fulfilling obligations under article 186 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 187 | similar laws prohibiting or restricting circumvention of such 188 | measures. 189 | 190 | When you convey a covered work, you waive any legal power to forbid 191 | circumvention of technological measures to the extent such circumvention 192 | is effected by exercising rights under this License with respect to 193 | the covered work, and you disclaim any intention to limit operation or 194 | modification of the work as a means of enforcing, against the work's 195 | users, your or third parties' legal rights to forbid circumvention of 196 | technological measures. 197 | 198 | 4. Conveying Verbatim Copies. 199 | 200 | You may convey verbatim copies of the Program's source code as you 201 | receive it, in any medium, provided that you conspicuously and 202 | appropriately publish on each copy an appropriate copyright notice; 203 | keep intact all notices stating that this License and any 204 | non-permissive terms added in accord with section 7 apply to the code; 205 | keep intact all notices of the absence of any warranty; and give all 206 | recipients a copy of this License along with the Program. 207 | 208 | You may charge any price or no price for each copy that you convey, 209 | and you may offer support or warranty protection for a fee. 210 | 211 | 5. Conveying Modified Source Versions. 212 | 213 | You may convey a work based on the Program, or the modifications to 214 | produce it from the Program, in the form of source code under the 215 | terms of section 4, provided that you also meet all of these conditions: 216 | 217 | a) The work must carry prominent notices stating that you modified 218 | it, and giving a relevant date. 219 | 220 | b) The work must carry prominent notices stating that it is 221 | released under this License and any conditions added under section 222 | 7. This requirement modifies the requirement in section 4 to 223 | "keep intact all notices". 224 | 225 | c) You must license the entire work, as a whole, under this 226 | License to anyone who comes into possession of a copy. This 227 | License will therefore apply, along with any applicable section 7 228 | additional terms, to the whole of the work, and all its parts, 229 | regardless of how they are packaged. This License gives no 230 | permission to license the work in any other way, but it does not 231 | invalidate such permission if you have separately received it. 232 | 233 | d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms 251 | of sections 4 and 5, provided that you also convey the 252 | machine-readable Corresponding Source under the terms of this License, 253 | in one of these ways: 254 | 255 | a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | 260 | b) Convey the object code in, or embodied in, a physical product 261 | (including a physical distribution medium), accompanied by a 262 | written offer, valid for at least three years and valid for as 263 | long as you offer spare parts or customer support for that product 264 | model, to give anyone who possesses the object code either (1) a 265 | copy of the Corresponding Source for all the software in the 266 | product that is covered by this License, on a durable physical 267 | medium customarily used for software interchange, for a price no 268 | more than your reasonable cost of physically performing this 269 | conveying of source, or (2) access to copy the 270 | Corresponding Source from a network server at no charge. 271 | 272 | c) Convey individual copies of the object code with a copy of the 273 | written offer to provide the Corresponding Source. This 274 | alternative is allowed only occasionally and noncommercially, and 275 | only if you received the object code with such an offer, in accord 276 | with subsection 6b. 277 | 278 | d) Convey the object code by offering access from a designated 279 | place (gratis or for a charge), and offer equivalent access to the 280 | Corresponding Source in the same way through the same place at no 281 | further charge. You need not require recipients to copy the 282 | Corresponding Source along with the object code. If the place to 283 | copy the object code is a network server, the Corresponding Source 284 | may be on a different server (operated by you or a third party) 285 | that supports equivalent copying facilities, provided you maintain 286 | clear directions next to the object code saying where to find the 287 | Corresponding Source. Regardless of what server hosts the 288 | Corresponding Source, you remain obligated to ensure that it is 289 | available for as long as needed to satisfy these requirements. 290 | 291 | e) Convey the object code using peer-to-peer transmission, provided 292 | you inform other peers where the object code and Corresponding 293 | Source of the work are being offered to the general public at no 294 | charge under subsection 6d. 295 | 296 | A separable portion of the object code, whose source code is excluded 297 | from the Corresponding Source as a System Library, need not be 298 | included in conveying the object code work. 299 | 300 | A "User Product" is either (1) a "consumer product", which means any 301 | tangible personal property which is normally used for personal, family, 302 | or household purposes, or (2) anything designed or sold for incorporation 303 | into a dwelling. In determining whether a product is a consumer product, 304 | doubtful cases shall be resolved in favor of coverage. For a particular 305 | product received by a particular user, "normally used" refers to a 306 | typical or common use of that class of product, regardless of the status 307 | of the particular user or of the way in which the particular user 308 | actually uses, or expects or is expected to use, the product. A product 309 | is a consumer product regardless of whether the product has substantial 310 | commercial, industrial or non-consumer uses, unless such uses represent 311 | the only significant mode of use of the product. 312 | 313 | "Installation Information" for a User Product means any methods, 314 | procedures, authorization keys, or other information required to install 315 | and execute modified versions of a covered work in that User Product from 316 | a modified version of its Corresponding Source. The information must 317 | suffice to ensure that the continued functioning of the modified object 318 | code is in no case prevented or interfered with solely because 319 | modification has been made. 320 | 321 | If you convey an object code work under this section in, or with, or 322 | specifically for use in, a User Product, and the conveying occurs as 323 | part of a transaction in which the right of possession and use of the 324 | User Product is transferred to the recipient in perpetuity or for a 325 | fixed term (regardless of how the transaction is characterized), the 326 | Corresponding Source conveyed under this section must be accompanied 327 | by the Installation Information. But this requirement does not apply 328 | if neither you nor any third party retains the ability to install 329 | modified object code on the User Product (for example, the work has 330 | been installed in ROM). 331 | 332 | The requirement to provide Installation Information does not include a 333 | requirement to continue to provide support service, warranty, or updates 334 | for a work that has been modified or installed by the recipient, or for 335 | the User Product in which it has been modified or installed. Access to a 336 | network may be denied when the modification itself materially and 337 | adversely affects the operation of the network or violates the rules and 338 | protocols for communication across the network. 339 | 340 | Corresponding Source conveyed, and Installation Information provided, 341 | in accord with this section must be in a format that is publicly 342 | documented (and with an implementation available to the public in 343 | source code form), and must require no special password or key for 344 | unpacking, reading or copying. 345 | 346 | 7. Additional Terms. 347 | 348 | "Additional permissions" are terms that supplement the terms of this 349 | License by making exceptions from one or more of its conditions. 350 | Additional permissions that are applicable to the entire Program shall 351 | be treated as though they were included in this License, to the extent 352 | that they are valid under applicable law. If additional permissions 353 | apply only to part of the Program, that part may be used separately 354 | under those permissions, but the entire Program remains governed by 355 | this License without regard to the additional permissions. 356 | 357 | When you convey a copy of a covered work, you may at your option 358 | remove any additional permissions from that copy, or from any part of 359 | it. (Additional permissions may be written to require their own 360 | removal in certain cases when you modify the work.) You may place 361 | additional permissions on material, added by you to a covered work, 362 | for which you have or can give appropriate copyright permission. 363 | 364 | Notwithstanding any other provision of this License, for material you 365 | add to a covered work, you may (if authorized by the copyright holders of 366 | that material) supplement the terms of this License with terms: 367 | 368 | a) Disclaiming warranty or limiting liability differently from the 369 | terms of sections 15 and 16 of this License; or 370 | 371 | b) Requiring preservation of specified reasonable legal notices or 372 | author attributions in that material or in the Appropriate Legal 373 | Notices displayed by works containing it; or 374 | 375 | c) Prohibiting misrepresentation of the origin of that material, or 376 | requiring that modified versions of such material be marked in 377 | reasonable ways as different from the original version; or 378 | 379 | d) Limiting the use for publicity purposes of names of licensors or 380 | authors of the material; or 381 | 382 | e) Declining to grant rights under trademark law for use of some 383 | trade names, trademarks, or service marks; or 384 | 385 | f) Requiring indemnification of licensors and authors of that 386 | material by anyone who conveys the material (or modified versions of 387 | it) with contractual assumptions of liability to the recipient, for 388 | any liability that these contractual assumptions directly impose on 389 | those licensors and authors. 390 | 391 | All other non-permissive additional terms are considered "further 392 | restrictions" within the meaning of section 10. If the Program as you 393 | received it, or any part of it, contains a notice stating that it is 394 | governed by this License along with a term that is a further 395 | restriction, you may remove that term. If a license document contains 396 | a further restriction but permits relicensing or conveying under this 397 | License, you may add to a covered work material governed by the terms 398 | of that license document, provided that the further restriction does 399 | not survive such relicensing or conveying. 400 | 401 | If you add terms to a covered work in accord with this section, you 402 | must place, in the relevant source files, a statement of the 403 | additional terms that apply to those files, or a notice indicating 404 | where to find the applicable terms. 405 | 406 | Additional terms, permissive or non-permissive, may be stated in the 407 | form of a separately written license, or stated as exceptions; 408 | the above requirements apply either way. 409 | 410 | 8. Termination. 411 | 412 | You may not propagate or modify a covered work except as expressly 413 | provided under this License. Any attempt otherwise to propagate or 414 | modify it is void, and will automatically terminate your rights under 415 | this License (including any patent licenses granted under the third 416 | paragraph of section 11). 417 | 418 | However, if you cease all violation of this License, then your 419 | license from a particular copyright holder is reinstated (a) 420 | provisionally, unless and until the copyright holder explicitly and 421 | finally terminates your license, and (b) permanently, if the copyright 422 | holder fails to notify you of the violation by some reasonable means 423 | prior to 60 days after the cessation. 424 | 425 | Moreover, your license from a particular copyright holder is 426 | reinstated permanently if the copyright holder notifies you of the 427 | violation by some reasonable means, this is the first time you have 428 | received notice of violation of this License (for any work) from that 429 | copyright holder, and you cure the violation prior to 30 days after 430 | your receipt of the notice. 431 | 432 | Termination of your rights under this section does not terminate the 433 | licenses of parties who have received copies or rights from you under 434 | this License. If your rights have been terminated and not permanently 435 | reinstated, you do not qualify to receive new licenses for the same 436 | material under section 10. 437 | 438 | 9. Acceptance Not Required for Having Copies. 439 | 440 | You are not required to accept this License in order to receive or 441 | run a copy of the Program. Ancillary propagation of a covered work 442 | occurring solely as a consequence of using peer-to-peer transmission 443 | to receive a copy likewise does not require acceptance. However, 444 | nothing other than this License grants you permission to propagate or 445 | modify any covered work. These actions infringe copyright if you do 446 | not accept this License. Therefore, by modifying or propagating a 447 | covered work, you indicate your acceptance of this License to do so. 448 | 449 | 10. Automatic Licensing of Downstream Recipients. 450 | 451 | Each time you convey a covered work, the recipient automatically 452 | receives a license from the original licensors, to run, modify and 453 | propagate that work, subject to this License. You are not responsible 454 | for enforcing compliance by third parties with this License. 455 | 456 | An "entity transaction" is a transaction transferring control of an 457 | organization, or substantially all assets of one, or subdividing an 458 | organization, or merging organizations. If propagation of a covered 459 | work results from an entity transaction, each party to that 460 | transaction who receives a copy of the work also receives whatever 461 | licenses to the work the party's predecessor in interest had or could 462 | give under the previous paragraph, plus a right to possession of the 463 | Corresponding Source of the work from the predecessor in interest, if 464 | the predecessor has it or can get it with reasonable efforts. 465 | 466 | You may not impose any further restrictions on the exercise of the 467 | rights granted or affirmed under this License. For example, you may 468 | not impose a license fee, royalty, or other charge for exercise of 469 | rights granted under this License, and you may not initiate litigation 470 | (including a cross-claim or counterclaim in a lawsuit) alleging that 471 | any patent claim is infringed by making, using, selling, offering for 472 | sale, or importing the Program or any portion of it. 473 | 474 | 11. Patents. 475 | 476 | A "contributor" is a copyright holder who authorizes use under this 477 | License of the Program or a work on which the Program is based. The 478 | work thus licensed is called the contributor's "contributor version". 479 | 480 | A contributor's "essential patent claims" are all patent claims 481 | owned or controlled by the contributor, whether already acquired or 482 | hereafter acquired, that would be infringed by some manner, permitted 483 | by this License, of making, using, or selling its contributor version, 484 | but do not include claims that would be infringed only as a 485 | consequence of further modification of the contributor version. For 486 | purposes of this definition, "control" includes the right to grant 487 | patent sublicenses in a manner consistent with the requirements of 488 | this License. 489 | 490 | Each contributor grants you a non-exclusive, worldwide, royalty-free 491 | patent license under the contributor's essential patent claims, to 492 | make, use, sell, offer for sale, import and otherwise run, modify and 493 | propagate the contents of its contributor version. 494 | 495 | In the following three paragraphs, a "patent license" is any express 496 | agreement or commitment, however denominated, not to enforce a patent 497 | (such as an express permission to practice a patent or covenant not to 498 | sue for patent infringement). To "grant" such a patent license to a 499 | party means to make such an agreement or commitment not to enforce a 500 | patent against the party. 501 | 502 | If you convey a covered work, knowingly relying on a patent license, 503 | and the Corresponding Source of the work is not available for anyone 504 | to copy, free of charge and under the terms of this License, through a 505 | publicly available network server or other readily accessible means, 506 | then you must either (1) cause the Corresponding Source to be so 507 | available, or (2) arrange to deprive yourself of the benefit of the 508 | patent license for this particular work, or (3) arrange, in a manner 509 | consistent with the requirements of this License, to extend the patent 510 | license to downstream recipients. "Knowingly relying" means you have 511 | actual knowledge that, but for the patent license, your conveying the 512 | covered work in a country, or your recipient's use of the covered work 513 | in a country, would infringe one or more identifiable patents in that 514 | country that you have reason to believe are valid. 515 | 516 | If, pursuant to or in connection with a single transaction or 517 | arrangement, you convey, or propagate by procuring conveyance of, a 518 | covered work, and grant a patent license to some of the parties 519 | receiving the covered work authorizing them to use, propagate, modify 520 | or convey a specific copy of the covered work, then the patent license 521 | you grant is automatically extended to all recipients of the covered 522 | work and works based on it. 523 | 524 | A patent license is "discriminatory" if it does not include within 525 | the scope of its coverage, prohibits the exercise of, or is 526 | conditioned on the non-exercise of one or more of the rights that are 527 | specifically granted under this License. You may not convey a covered 528 | work if you are a party to an arrangement with a third party that is 529 | in the business of distributing software, under which you make payment 530 | to the third party based on the extent of your activity of conveying 531 | the work, and under which the third party grants, to any of the 532 | parties who would receive the covered work from you, a discriminatory 533 | patent license (a) in connection with copies of the covered work 534 | conveyed by you (or copies made from those copies), or (b) primarily 535 | for and in connection with specific products or compilations that 536 | contain the covered work, unless you entered into that arrangement, 537 | or that patent license was granted, prior to 28 March 2007. 538 | 539 | Nothing in this License shall be construed as excluding or limiting 540 | any implied license or other defenses to infringement that may 541 | otherwise be available to you under applicable patent law. 542 | 543 | 12. No Surrender of Others' Freedom. 544 | 545 | If conditions are imposed on you (whether by court order, agreement or 546 | otherwise) that contradict the conditions of this License, they do not 547 | excuse you from the conditions of this License. If you cannot convey a 548 | covered work so as to satisfy simultaneously your obligations under this 549 | License and any other pertinent obligations, then as a consequence you may 550 | not convey it at all. For example, if you agree to terms that obligate you 551 | to collect a royalty for further conveying from those to whom you convey 552 | the Program, the only way you could satisfy both those terms and this 553 | License would be to refrain entirely from conveying the Program. 554 | 555 | 13. Use with the GNU Affero General Public License. 556 | 557 | Notwithstanding any other provision of this License, you have 558 | permission to link or combine any covered work with a work licensed 559 | under version 3 of the GNU Affero General Public License into a single 560 | combined work, and to convey the resulting work. The terms of this 561 | License will continue to apply to the part which is the covered work, 562 | but the special requirements of the GNU Affero General Public License, 563 | section 13, concerning interaction through a network will apply to the 564 | combination as such. 565 | 566 | 14. Revised Versions of this License. 567 | 568 | The Free Software Foundation may publish revised and/or new versions of 569 | the GNU General Public License from time to time. Such new versions will 570 | be similar in spirit to the present version, but may differ in detail to 571 | address new problems or concerns. 572 | 573 | Each version is given a distinguishing version number. If the 574 | Program specifies that a certain numbered version of the GNU General 575 | Public License "or any later version" applies to it, you have the 576 | option of following the terms and conditions either of that numbered 577 | version or of any later version published by the Free Software 578 | Foundation. If the Program does not specify a version number of the 579 | GNU General Public License, you may choose any version ever published 580 | by the Free Software Foundation. 581 | 582 | If the Program specifies that a proxy can decide which future 583 | versions of the GNU General Public License can be used, that proxy's 584 | public statement of acceptance of a version permanently authorizes you 585 | to choose that version for the Program. 586 | 587 | Later license versions may give you additional or different 588 | permissions. However, no additional obligations are imposed on any 589 | author or copyright holder as a result of your choosing to follow a 590 | later version. 591 | 592 | 15. Disclaimer of Warranty. 593 | 594 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 595 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 596 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 597 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 598 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 599 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 600 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 601 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 602 | 603 | 16. Limitation of Liability. 604 | 605 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 606 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 607 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 608 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 609 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 610 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 611 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 612 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 613 | SUCH DAMAGES. 614 | 615 | 17. Interpretation of Sections 15 and 16. 616 | 617 | If the disclaimer of warranty and limitation of liability provided 618 | above cannot be given local legal effect according to their terms, 619 | reviewing courts shall apply local law that most closely approximates 620 | an absolute waiver of all civil liability in connection with the 621 | Program, unless a warranty or assumption of liability accompanies a 622 | copy of the Program in return for a fee. 623 | 624 | END OF TERMS AND CONDITIONS 625 | 626 | How to Apply These Terms to Your New Programs 627 | 628 | If you develop a new program, and you want it to be of the greatest 629 | possible use to the public, the best way to achieve this is to make it 630 | free software which everyone can redistribute and change under these terms. 631 | 632 | To do so, attach the following notices to the program. It is safest 633 | to attach them to the start of each source file to most effectively 634 | state the exclusion of warranty; and each file should have at least 635 | the "copyright" line and a pointer to where the full notice is found. 636 | 637 | {one line to give the program's name and a brief idea of what it does.} 638 | Copyright (C) {year} {name of author} 639 | 640 | This program is free software: you can redistribute it and/or modify 641 | it under the terms of the GNU General Public License as published by 642 | the Free Software Foundation, either version 3 of the License, or 643 | (at your option) any later version. 644 | 645 | This program is distributed in the hope that it will be useful, 646 | but WITHOUT ANY WARRANTY; without even the implied warranty of 647 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 648 | GNU General Public License for more details. 649 | 650 | You should have received a copy of the GNU General Public License 651 | along with this program. If not, see [http://www.gnu.org/licenses/]. 652 | 653 | Also add information on how to contact you by electronic and paper mail. 654 | 655 | If the program does terminal interaction, make it output a short 656 | notice like this when it starts in an interactive mode: 657 | 658 | {project} Copyright (C) {year} {fullname} 659 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 660 | This is free software, and you are welcome to redistribute it 661 | under certain conditions; type `show c' for details. 662 | 663 | The hypothetical commands `show w' and `show c' should show the appropriate 664 | parts of the General Public License. Of course, your program's commands 665 | might be different; for a GUI interface, you would use an "about box". 666 | 667 | You should also get your employer (if you work as a programmer) or school, 668 | if any, to sign a "copyright disclaimer" for the program, if necessary. 669 | For more information on this, and how to apply and follow the GNU GPL, see 670 | [http://www.gnu.org/licenses/]. 671 | 672 | The GNU General Public License does not permit incorporating your program 673 | into proprietary programs. If your program is a subroutine library, you 674 | may consider it more useful to permit linking proprietary applications with 675 | the library. If this is what you want to do, use the GNU Lesser General 676 | Public License instead of this License. But first, please read 677 | [http://www.gnu.org/philosophy/why-not-lgpl.html]. 678 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A set of useful git hooks 2 | 3 | These hooks automate some tasks with the help of git. 4 | For the moment, it is mostly hooks related to tools from the php ecosystem. 5 | 6 | ## Documentation 7 | 8 | Read [the documentation][1] to learn more about git template. 9 | 10 | ## Contributing 11 | 12 | see [CONTRIBUTING.md][2] 13 | 14 | ## Credits 15 | 16 | Inspired by [Tim Pope][3] 17 | 18 | ## Build Status 19 | 20 | [![Build Status][4]][5] 21 | 22 | [1]: http://git-template.readthedocs.io 23 | [2]: ./CONTRIBUTING.md 24 | [3]: http://tbaggery.com/2011/08/08/effortless-ctags-with-git.html 25 | [4]: https://travis-ci.org/greg0ire/git_template.png 26 | [5]: https://travis-ci.org/greg0ire/git_template 27 | -------------------------------------------------------------------------------- /cleanup-2-x-x-mess.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash -eu 2 | main() 3 | { 4 | local gitDir 5 | gitDir=$(git rev-parse --git-common-dir) 6 | 7 | rm -rf "$gitDir/{tests,docs,mkdocs.yml,README.md,LICENSE,CONTRIBUTING.md,update.sh}" 8 | } 9 | main 10 | -------------------------------------------------------------------------------- /docs/hooks/junk-checker.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Checks for user defined phrases that you don't want to commit to your 4 | repository, such as `var_dump()`, `console.log()` etc. on `pre-commit`. 5 | 6 | This can be overridden by using the following option : 7 | 8 | ```sh 9 | git commit --no-verify 10 | ``` 11 | 12 | This hook is language-agnostic. 13 | 14 | You must configure the `phrasesfile` option for this hook . The value is the 15 | name of a file that contains one forbidden phrase per line. There is a sample, 16 | you can use it like this : 17 | 18 | git config [--global] hooks.junkchecker.phrasesfile .git/hooks/junkchecker/junk-phrases.sample 19 | 20 | # Activation 21 | 22 | ```sh 23 | git config --add hooks.enabled-plugins junkchecker 24 | ``` 25 | -------------------------------------------------------------------------------- /docs/hooks/make.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Runs one or several make targets on pre-commit, or on pre-push, or both. 4 | 5 | # Activation 6 | 7 | ```sh 8 | git config --add hooks.enabled-plugins make 9 | ``` 10 | 11 | # Configuration 12 | 13 | By default, the `test` target will be run. To change the target: 14 | 15 | ```sh 16 | git config hooks.make.target "my_target my_other_target" 17 | ``` 18 | 19 | By default, `make` is only run on pre-push, but pre-commit is also supported. 20 | To change this, you can specify a list of hooks to run `make` on: 21 | 22 | ```sh 23 | git config hooks.make.on "pre-commit pre-push" 24 | ``` 25 | -------------------------------------------------------------------------------- /docs/hooks/php/composer.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | This set of scripts monitors `composer.lock` changes and updates (or reminds you 4 | to update) your vendor dependencies on `post-checkout` and `post-merge`. 5 | Additionally, it checks composer.json for validity on `pre-commit`. 6 | It assumes Composer is [globally installed][1]. 7 | 8 | # Configuration 9 | 10 | You must tell it whether you wish it to run Composer, or if you would rather 11 | it to notify you when you need to do it: 12 | 13 | ```sh 14 | # If you want Composer to run each time composer.lock changes 15 | git config hooks.composer.onChange run 16 | 17 | # If you prefer to get a notification 18 | git config hooks.composer.onChange just_warn 19 | ``` 20 | 21 | If the latter case, you must configure a notifier. Available notifiers for the 22 | moment are `echo` and `notify-send`. So to use `notify-send`, which is pretty 23 | cool, you need to do this (here, globally) : 24 | 25 | ```sh 26 | git config --global hooks.notification.notifier notify-send 27 | ``` 28 | 29 | # Activation 30 | 31 | ```sh 32 | git config --add hooks.enabled-plugins php/composer 33 | ``` 34 | 35 | [1]: https://github.com/composer/composer#global-installation-of-composer-manual 36 | -------------------------------------------------------------------------------- /docs/hooks/php/cs-fixer.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Runs [php-cs-fixer][1] when detecting changed php files. 4 | 5 | # Configuration 6 | 7 | You can specify the path to your binary 8 | 9 | ```sh 10 | git config hooks.php-cs-fixer.executable /custom/path/to/php-cs-fixer 11 | ``` 12 | 13 | Defaults to `php-cs-fixer`, occurs on `pre-checkout`. 14 | 15 | # Activation 16 | 17 | ```sh 18 | git config --add hooks.enabled-plugins php/cs-fixer 19 | ``` 20 | [1]: http://cs.sensiolabs.org/ 21 | -------------------------------------------------------------------------------- /docs/hooks/php/ctags.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Updates `.git/tags` file by scanning the project with the ctags command. It is 4 | configured for a php project. To make vim look for this file in the `.git` 5 | directory, you can install Tim Pope's [fugitive][1] or simply add 6 | `set tags+=.git/tags` to your .vimrc - some plugins (like [ctrlp-tjump][2]) 7 | require this to see the tags even if fugitive is installed. 8 | 9 | # Configuration 10 | 11 | You can specify which kinds of tags ctags should create: 12 | 13 | ```sh 14 | git config hooks.php-ctags.tag-kinds cdfiv 15 | ``` 16 | 17 | Default value is `cfi`. Execute `ctags --list-kinds` if you want to see which 18 | tag kinds are available. 19 | 20 | Optionally, you can set the projectType configuration, like this : 21 | 22 | ```sh 23 | git config hooks.php-ctags.project-type projectType 24 | ``` 25 | 26 | Supported project types : 27 | 28 | - symfony 29 | 30 | This will make ctags ignore cache directories. 31 | 32 | If you want improved PHP languages support, install the [patched version of ctags][3] 33 | support. 34 | 35 | Occurs on `post-checkout`, `post-commit`, and `post-merge`. 36 | 37 | # Activation 38 | 39 | ```sh 40 | git config --add hooks.enabled-plugins php/ctags 41 | ``` 42 | [1]: https://github.com/tpope/vim-fugitive 43 | [2]: https://github.com/ivalkeen/vim-ctrlp-tjump 44 | [3]: https://github.com/shawncplus/phpcomplete.vim/wiki/Patched-ctags 45 | -------------------------------------------------------------------------------- /docs/hooks/php/doctrine.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | These hooks run the `doctrine:schema:validate` task of a Symfony project and 4 | update / migrate your database depending on the presence of a 5 | `doctrine-migrations` folder in your vendor directory on `post-checkout` and 6 | `post-commit`. 7 | 8 | # Configuration 9 | 10 | You can change the symfony executable (default value `app/console`). Useful if 11 | you are using docker and you want to execute the binary in the container, for 12 | instance. 13 | 14 | ```sh 15 | git config hooks.doctrine.sf-executable "docker exec my_container /path/to/app/console" 16 | ``` 17 | 18 | # Activation 19 | 20 | ```sh 21 | git config --add hooks.enabled-plugins php/doctrine 22 | ``` 23 | -------------------------------------------------------------------------------- /docs/hooks/php/sismo.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | The `post-commit` hook makes [Sismo][1] run each time you commit. It is a `post-commit` 4 | hook because Sismo is a *local* Continuous Testing Server, which means you can 5 | build before you push, thus making sure no failing build ever comes out of your 6 | repo, and even making sure each commit passes the tests, because you can rewrite 7 | failing commits. 8 | 9 | # Configuration 10 | 11 | You must configure the path to the sismo executable, and you may do so globally, 12 | like this: 13 | 14 | ```sh 15 | git config --global --add hooks.php-sismo.path /usr/share/nginx/html/sismo.php 16 | ``` 17 | 18 | You must also configure the slug of your project: 19 | 20 | ```sh 21 | git config hooks.php-sismo.slug my-slug 22 | ``` 23 | 24 | # Activation 25 | 26 | ```sh 27 | git config --add hooks.enabled-plugins php/sismo 28 | ``` 29 | 30 | [1]: http://sismo.sensiolabs.org/ "A local Continuous Testing Server" 31 | -------------------------------------------------------------------------------- /docs/hooks/syntax-checker.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Checks for syntax errors in files that have a checker, based on the file extension. 4 | For the moment, there is : 5 | 6 | - a php checker, located at `hooks/syntaxchecker/php.sh`; 7 | - an xliff checker, located at `hooks/syntaxchecker/xlf.sh`. 8 | 9 | This hook is language-agnostic. 10 | 11 | # Activation 12 | 13 | ```sh 14 | git config --add hooks.enabled-plugins syntaxchecker 15 | ``` 16 | -------------------------------------------------------------------------------- /docs/hooks/ticketref.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Adds a ticket reference to the commit-msg, this allows for some workflows to 4 | be able to correlate a number of commits against a specific 5 | feature/ticket/incident/issue etc. once merged. 6 | 7 | A branch of `ABC-1234-hello-world` would turn a commit of 8 | `git commit -m "Hello World"` into `[ABC-1234] Hello World`. (by default) 9 | 10 | # Activation 11 | 12 | ```sh 13 | git config --add hooks.enabled-plugins ticketref 14 | ``` 15 | 16 | # Configuration 17 | 18 | By default this hook will prefix the commit message with the ticket reference, 19 | this can be configured to be added as a suffix via: 20 | ```sh 21 | git config hooks.ticketref.position "POST" 22 | ``` 23 | -------------------------------------------------------------------------------- /docs/hooks/work-in-progress.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Checks for commit messages starting with "WIP" and prevents you from pushing 4 | the corresponding commits. Occurs on `pre-push` (obviously). 5 | 6 | This can be ignored with an option : 7 | 8 | ```sh 9 | git push --no-verify 10 | ``` 11 | 12 | This hook is language-agnostic. 13 | 14 | # Activation 15 | 16 | ```sh 17 | git config --add hooks.enabled-plugins wipchecker 18 | ``` 19 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Git Template documentation 2 | 3 | Have you ever commited an invalid `composer.json` ? a parse error ? changes that 4 | made the test suite go red ? or maybe debugging statements like 5 | `var_dump`, `console.log`, `die` and so on ? 6 | Have you ever accused your colleagues of breaking things when you really should 7 | have run `composer install` or updated your database schema ? 8 | Have you ever pushed a work in progress commit that you really meant to complete 9 | a bit later ? 10 | 11 | If this feels familiar, Git Template has your back, give it a try! 12 | 13 | [Git Template][0] is a replacement for the default directory that gets copied 14 | each time you create or clone a git repository. That's right, every time you 15 | create or clone a git repository, some files get copied in your `.git` directory. 16 | These files mostly consist of example hooks you may change and adapt to meet your 17 | needs. 18 | Git Template contains useful (mostly php-related) hooks along with a configuration 19 | script that will let you to switch them on or off and configure parameters when 20 | available, and an update script that will let you update your copies. 21 | 22 | ## Installation 23 | 24 | git clone https://github.com/greg0ire/git_template ~/.git_template 25 | 26 | ## Configuration 27 | 28 | Set the newly cloned repo as your git template directory. This will tell git to 29 | populate new repositories created with either `git clone` or `git init` with 30 | the content of this directory. By default, it uses `/usr/share/git-core/templates`. 31 | 32 | git config --global init.templatedir '~/.git_template/template' 33 | 34 | ## Updating 35 | 36 | To get updates you need to update your template directory first : 37 | 38 | ```sh 39 | # Go to your template directory (probably ~/.git_template/template) 40 | cd $(git config --path --get init.templatedir) 41 | git pull 42 | ``` 43 | 44 | Then, you can update any repository by running this in the working tree of your 45 | repository : 46 | 47 | ```sh 48 | $(git config --path --get init.templatedir)/../update.sh 49 | # If your template directory is ~/.git_template/template, this is equivalent to : 50 | ~/.git_template/update.sh 51 | ``` 52 | 53 | Make sure you have rsync installed. 54 | 55 | ## Setup on existing projects 56 | 57 | You can also run the update script from a project created before your switch 58 | to `git_template`, but be aware that any hook you created yourself will be deleted. 59 | 60 | [0]: https://github.com/greg0ire/git_template 61 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs==1.2.3 2 | -------------------------------------------------------------------------------- /docs/upgrade/2-to-3.md: -------------------------------------------------------------------------------- 1 | # Upgrading from 2.x.x to 3.x.x 2 | 3 | ## Changing the template directory 4 | 5 | There is just a little change between 2 and 3, it is the location of the template 6 | directory. It is no longer the root in the project, but a sub-directory named… 7 | `template`. Why this change ? Because even if the update script can ignore the 8 | documentation, the tests and itself, `git clone` and `git init` do not. It means 9 | each time you create a new repository, and each time you clone a repository, while 10 | using Git Template 2.x.x, `git` will copy files that are part of the project but 11 | that are not part of the template itself. 12 | 13 | To change that, upgrade to 3.x.x, and adjust your `init.templatedir` variable: 14 | 15 | git config --global init.templatedir '~/.git_template/template' 16 | 17 | And remote the old hooks directory tree (it should contain no file at all) 18 | 19 | rm -rf ~/.git_template/hooks 20 | 21 | After that you will be able to safely run the update script from any project you 22 | have. 23 | 24 | ## Cleaning up repositories 25 | 26 | If you do not like the mess I have created in your repositories, please: 27 | 28 | - accept my sincerest apologies 29 | - run the cleanup script I wrote: `/path/to/.git_template/cleanup-2-x-x-mess.sh` 30 | from the root of each repository you want to clean. 31 | -------------------------------------------------------------------------------- /docs/usage.md: -------------------------------------------------------------------------------- 1 | # Usage 2 | 3 | ## For dummies 4 | 5 | Just run the configuration script. From your repository root, run 6 | 7 | "$(git rev-parse --git-common-dir)/configure.sh" 8 | 9 | The script will help you configure some scripts that shouldn't be configured globally. 10 | 11 | ## Manual configuration 12 | 13 | By default, no hook will run. You must configure the hooks you need: 14 | 15 | ```sh 16 | git config hooks.enabled-plugins php/composer 17 | git config --add hooks.enabled-plugins php/ctags 18 | git config --add hooks.enabled-plugins junkchecker 19 | ``` 20 | 21 | The `--add` flag is necessary if you don't want to wipe out previously added 22 | plugins. 23 | 24 | If you want to enable a plugin on every project, use the `--global` option: 25 | 26 | ```sh 27 | git config --global --add hooks.enabled-plugins some_plugin 28 | ``` 29 | -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: Git Template 2 | theme: readthedocs 3 | nav: 4 | - Home: index.md 5 | - Usage: usage.md 6 | - Hooks: 7 | - 'Junk checker': hooks/junk-checker.md 8 | - 'Make': hooks/make.md 9 | - 'Syntax checker': hooks/syntax-checker.md 10 | - 'Work In Progress': hooks/work-in-progress.md 11 | - 'Ticket Reference': hooks/ticketref.md 12 | - PHP: 13 | - 'Composer': hooks/php/composer.md 14 | - 'Ctags': hooks/php/ctags.md 15 | - 'Coding Standards Fixer': hooks/php/cs-fixer.md 16 | - 'Sismo': hooks/php/sismo.md 17 | - 'Doctrine': hooks/php/doctrine.md 18 | - Upgrading: 19 | - '2.x.x to 3.x.x': upgrade/2-to-3.md 20 | -------------------------------------------------------------------------------- /template/HEAD: -------------------------------------------------------------------------------- 1 | ref: refs/heads/main 2 | -------------------------------------------------------------------------------- /template/configure.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | readonly PROGNAME=$(basename "$0") 4 | readonly PROGDIR="$(cd "$(dirname "$0")"; pwd)" 5 | readonly GIT_COMMON_DIR="$(git rev-parse --git-common-dir)" 6 | export GIT_COMMON_DIR 7 | 8 | . "$GIT_COMMON_DIR/hooks/hook_switcher.sh" 9 | 10 | main() { 11 | local hookName 12 | for directory in $(find "$PROGDIR/hooks" -type d | sort | \ 13 | awk '$0 !~ last "/" {print last} {last=$0} END {print last}') 14 | do 15 | hookName=${directory#$PROGDIR/hooks/} 16 | echo "Configuring $hookName" 17 | switch_hook "$hookName" 18 | find "$directory" -name configure.sh -exec {} \; 19 | done 20 | } 21 | 22 | main 23 | -------------------------------------------------------------------------------- /template/hooks/change_detector.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # @param hook_type post-checkout|post-merge|post-commit|pre-commit 4 | # @param monitored_paths the paths to check 5 | has_changed() 6 | { 7 | local hook_type=$1; shift 8 | local monitored_paths="$@" 9 | local against 10 | local changed 11 | local workDir 12 | set -f 13 | 14 | workDir=$(git rev-parse --show-toplevel) 15 | 16 | case $hook_type in 17 | post-commit) 18 | if git rev-parse --verify HEAD^ >/dev/null 2>&1 19 | then 20 | against=HEAD^ 21 | else 22 | # Initial commit: diff against an empty tree object 23 | against=4b825dc642cb6eb9a060e54bf8d69288fbee4904 24 | fi 25 | changed="$(git diff-tree $against 'HEAD' \ 26 | --stat \ 27 | -- ${monitored_paths}| wc -l)" 28 | ;; 29 | post-checkout | post-merge ) 30 | changed="$(git diff 'HEAD@{1}' \ 31 | --stat \ 32 | -- ${monitored_paths}| wc -l)" 33 | ;; 34 | pre-commit) 35 | if git rev-parse --verify HEAD >/dev/null 2>&1 36 | then 37 | against=HEAD 38 | else 39 | # Initial commit: diff against an empty tree object 40 | against=4b825dc642cb6eb9a060e54bf8d69288fbee4904 41 | fi 42 | changed="$(git diff-index \ 43 | --name-status $against \ 44 | -- ${monitored_paths} | wc -l)" 45 | ;; 46 | esac 47 | 48 | if [ "$changed" -gt 0 ] 49 | then 50 | return 0 51 | else 52 | return 1 53 | fi 54 | } 55 | -------------------------------------------------------------------------------- /template/hooks/commit-msg: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | GIT_COMMON_DIR=$(git rev-parse --git-common-dir) 3 | test -d "$GIT_COMMON_DIR"/rebase-merge -o -d "$GIT_COMMON_DIR"/rebase-apply && exit 0 4 | for enabled_plugin in $(git config --get-all hooks.enabled-plugins) 5 | do 6 | if [ -f "$GIT_COMMON_DIR/hooks/$enabled_plugin/commit-msg" ] 7 | then 8 | "$GIT_COMMON_DIR/hooks/$enabled_plugin/commit-msg" "$1" "$2" 9 | fi 10 | done 11 | -------------------------------------------------------------------------------- /template/hooks/git_config_wrapper.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Gets a required configuration key from the git config 4 | # 5 | # @param string the name of the hook 6 | # @param string the name of the configuration key 7 | # @param string the name of the variable where the return value should be stored 8 | # @param string required | optional whether this config is required of optional 9 | # @param string a default value for the option. Implies optional. 10 | # 11 | # @return int 0: success 12 | # 1: misuse 13 | # 2: key not set 14 | function get_hook_config() 15 | { 16 | local isRequired 17 | if [ $# -ne 4 -a $# -ne 5 ] 18 | then 19 | echo "Usage: $0 ,