├── .github └── workflows │ └── test.yml ├── .gitignore ├── CONTRIBUTING ├── COPYING ├── Cask ├── INSTALL ├── NEWS ├── README.org ├── git-auto-commit-mode.el └── tests └── git-auto-commit-mode-tests.el /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | on: 3 | push: {branches: [master]} 4 | pull_request: {branches: [master]} 5 | 6 | jobs: 7 | test: 8 | runs-on: ubuntu-latest 9 | strategy: 10 | matrix: 11 | emacs_version: 12 | - '26.3' 13 | - '27.2' 14 | - '28.2' 15 | - 'snapshot' 16 | include: 17 | - emacs_version: 'snapshot' 18 | allow_failure: true 19 | steps: 20 | - uses: actions/checkout@v2 21 | - uses: purcell/setup-emacs@master 22 | with: 23 | version: ${{ matrix.emacs_version }} 24 | - uses: conao3/setup-cask@master 25 | 26 | - name: Run tests 27 | run: "cask && cask exec buttercup -L . || ${{ matrix.allow_failure == true }}" 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .cask/ 2 | git-auto-commit-mode.elc 3 | -------------------------------------------------------------------------------- /CONTRIBUTING: -------------------------------------------------------------------------------- 1 | # -*- mode: org; -*- 2 | #+STARTUP: showall 3 | 4 | Please feel free to contribute. I welcome any help that you may offer. Whether 5 | it's fixing typo's, updating the documentation, or fixing bugs or adding new 6 | features. 7 | 8 | * Getting the source 9 | 10 | If you wish to work on git-auto-commit-mode you can get the sources by cloning 11 | the repository: 12 | #+BEGIN_EXAMPLE 13 | git clone git://ryuslash.org/emacs/git-auto-commit-mode.org 14 | #+END_EXAMPLE 15 | 16 | * Style 17 | 18 | Use spaces, don't use tabs. If you can, keep lines shorter than 80 characters. 19 | Other than that, Emacs can handle indentation pretty well. 20 | 21 | * Patches 22 | 23 | If you want to send any patches I'd be more than happy to merge them. Please 24 | feel free to use Github pull requests, or any other means preferred by you. 25 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (development 5 | (depends-on "buttercup")) 6 | -------------------------------------------------------------------------------- /INSTALL: -------------------------------------------------------------------------------- 1 | # -*- mode: org; -*- 2 | #+STARTUP: showall 3 | 4 | In order to use git-auto-commit-mode you need to make sure that it 5 | can be found in your =load-path=. You can do this either by installing 6 | it through ELPA or you can do it manually. 7 | 8 | * ELPA 9 | 10 | git-auto-commit-mode can be found in both [[http://marmalade-repo.org/][Marmalade]] and [[http://melpa.milkbox.net/][MELPA]], so 11 | if you have either of those set-up installing should be as easy as: 12 | #+BEGIN_EXAMPLE 13 | M-x package-install git-auto-commit-mode 14 | #+END_EXAMPLE 15 | 16 | And you're done. 17 | 18 | * Manual 19 | 20 | To install git-auto-commit-mode manually you should download the 21 | sources from one of the several places it can be found, after which 22 | you should extract the archive and add the resulting directory to 23 | you load path: 24 | #+BEGIN_EXAMPLE 25 | (add-to-list 'load-path "/path/to/git-auto-commit-mode") 26 | #+END_EXAMPLE 27 | 28 | Once it can be found in your =load-path= you can =load=, =require= or 29 | =autoload= it, whichever you like: 30 | #+BEGIN_EXAMPLE 31 | (require 'git-auto-commit-mode) 32 | 33 | ;; Or... 34 | 35 | (autoload 'git-auto-commit-mode "git-auto-commit-mode") 36 | #+END_EXAMPLE 37 | -------------------------------------------------------------------------------- /NEWS: -------------------------------------------------------------------------------- 1 | # -*- mode: org; -*- 2 | #+STARTUP: showall 3 | 4 | * v4.7.0 5 | 6 | - Fix the URL package header, it was pointing at a non-existent page. 7 | - Add user options =gac-commit-additional-flags=, and =gac-silent-message-p=. 8 | - Fix an issue with having the =[= character somewhere in the path of the file. 9 | 10 | * v4.6.0 11 | 12 | - Only try to commit when changes have been discovered in the file. By 13 | extension git-auto-commit-mode won't ask for a summary to a commit that it 14 | won't make. 15 | - Add option to prevent new (untracked) files from being added to the git 16 | repository automatically, =gac-automatically-add-new-files-p=. 17 | 18 | * v4.5.0 19 | 20 | - Support the fish shell through the ~gac-shell-and~ option. 21 | - Support buffering commits within a certain time interval using the 22 | ~gac-debounce-interval~. 23 | 24 | * v4.4.0 25 | 26 | - Support Windows paths using =convert-standard-filename=. 27 | - Properly escape command-line arguments when calling git with 28 | =shell-quote-argument=. 29 | - Explicitly bind =default-directory= when calling git. 30 | 31 | * v4.3.2 32 | 33 | - Bump version, oops I forgot to do this for 4.3.1. 34 | 35 | * v4.3.1 36 | 37 | - Fix committing files with spaces in their name. 38 | 39 | * v4.3.0 40 | 41 | - Add user option =gac-ask-for-summary-p=. 42 | 43 | * v4.2.2 44 | 45 | - =provide= a ~git-auto-commit-mode~ feature. (Thanks Jascha Geerds!) 46 | 47 | * v4.2.1 48 | 49 | - Fix some version number mistakes. 50 | 51 | * v4.2.0 52 | 53 | - Add README, NEWS, CONTRIBUTING and INSTALL files. 54 | 55 | - Use Emacs' Customize interface for user option 56 | =gac-automatically-push-p=. 57 | 58 | * v4.1 59 | 60 | - Update package URL to new homepage. 61 | 62 | * v4 63 | 64 | - Make =gac-automatically-push= buffer local, always. 65 | 66 | - Rename =gac-automatically-push= to =gac-automatically-push-p= to 67 | follow standard emacs-lisp conventions. 68 | 69 | - Fix commentary about =gac-automatically-push-p=. 70 | 71 | * v3 72 | 73 | - Shows the status when push finishes. 74 | 75 | * v2 76 | 77 | - Add ability to automatically push. 78 | 79 | * v1 80 | 81 | - Initial release. 82 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: git-auto-commit-mode 2 | #+STARTUP: showall 3 | 4 | * NAME 5 | 6 | git-auto-commit-mode - Emacs minor mode to automatically commit (and 7 | push) a git repository. 8 | 9 | [[http://melpa.org/#/git-auto-commit-mode][file:http://melpa.org/packages/git-auto-commit-mode-badge.svg]] 10 | [[http://stable.melpa.org/#/git-auto-commit-mode][file:http://stable.melpa.org/packages/git-auto-commit-mode-badge.svg]] 11 | 12 | * SYNOPSIS 13 | 14 | =M-x git-auto-commit-mode = 15 | 16 | * DESCRIPTION 17 | 18 | git-auto-commit-mode is an Emacs minor mode that tries to commit 19 | changes to a file after every save. 20 | 21 | The commit message sent to git is always the filename of the file 22 | saved, relative to the root of the git repository. 23 | 24 | * USAGE 25 | 26 | When enabled, git-auto-commit-mode uses the =after-save-hook= to 27 | commit changes to git each time. If =gac-automatically-push-p= is 28 | non-nil it also tries to push the ~HEAD~ to the current upstream. 29 | Making sure that upstream is properly set is the responsibility of 30 | the user. 31 | 32 | ** Enabling 33 | 34 | Since git-auto-commit-mode is a regular minor mode you have more 35 | than one option to enable it. 36 | 37 | *** As a file-local variable 38 | 39 | If you're using Emacs 24 or newer you should set an =eval= 40 | file-local variable: 41 | #+BEGIN_EXAMPLE 42 | ;; -*- eval: (git-auto-commit-mode 1) -*- 43 | #+END_EXAMPLE 44 | 45 | If you're using an older version of Emacs, that should be: 46 | #+BEGIN_EXAMPLE 47 | ;; -*- mode: git-auto-commit -*- 48 | #+END_EXAMPLE 49 | 50 | *** As a directory-local variable 51 | 52 | Create a ~.dir-locals.el~ file in the directory where you want 53 | git-auto-commit-mode to be enabled. This will also apply to any 54 | subdirectories, so be careful. For more information see the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html#Directory-Variables][Per-Directory 55 | Local Variables]] section in the Emacs manual. Then put one of the following 56 | snippets of code in there: 57 | 58 | If you're using Emacs 24 or newer you should set an =eval= variable: 59 | #+BEGIN_EXAMPLE 60 | ((nil . ((eval git-auto-commit-mode 1)))) 61 | #+END_EXAMPLE 62 | 63 | If you're using an older version of Emacs, that should be: 64 | #+BEGIN_EXAMPLE 65 | ((nil . ((mode . git-auto-commit)))) 66 | #+END_EXAMPLE 67 | 68 | *** As a hook 69 | 70 | To enable git-auto-commit-mode each time a ~certain-hook~ runs: 71 | #+BEGIN_EXAMPLE 72 | (add-hook 'certain-hook 'git-auto-commit-mode) 73 | #+END_EXAMPLE 74 | 75 | * CUSTOMIZATION 76 | 77 | git-auto-commit-mode is a simple mode, as such it offers little 78 | customization. 79 | 80 | - =gac-automatically-push-p= :: 81 | A boolean value indicating whether or not git-auto-commit-mode should try to 82 | push the git repository's ~HEAD~ to its default upstream. Setting up the 83 | upstream is the user's responsibility. 84 | 85 | - =gac-automatically-add-new-files-p= :: 86 | A boolean value indicating whether or not git-auto-commit-mode should add 87 | new (untracked) files to the repository. 88 | 89 | - =gac-ask-for-summary-p= :: 90 | A boolean value indicating whether or not git-auto-commit-mode should ask 91 | the user for a commit message every time a commit is made. *Note*: Since the 92 | summary is asked for before the commit, but /after/ the file has been saved, 93 | pressing ~C-g~ while entering the Summary will stop the commit from being 94 | made, but not the file from being saved. 95 | 96 | - =gac-shell-and= :: 97 | A string that can be used to change how the shell combines commands. The 98 | default " && " is good for bash-like shells, but " ; and " would be used for 99 | fish, for example. 100 | 101 | - =gac-debounce-interval= :: 102 | A number specifying a buffer between automatic commits in seconds. Wait with 103 | making an actual commit until this number of seconds elapses. 104 | 105 | - =gac-add-additional-flag= :: 106 | A string that can be used to add additional command line flags to the ~git 107 | add~ command. 108 | 109 | - =gac-commit-additional-flag= :: 110 | A string that can be used to add additional command line flags to the ~git 111 | commit~ command. 112 | 113 | - =gac-silent-message-p= :: 114 | A boolean value indicating whether to display the commit summary message, 115 | which is usually displayed in the minibuffer. The default is ~nil~, meaning 116 | that the summary would be displayed on every commit. 117 | 118 | 119 | To set any of these options, you can: 120 | 121 | - Use the customization interface (~M-x customize-group git-auto-commit-mode~). 122 | - Set the defaults in your Emacs initialization file using: 123 | #+begin_src emacs-lisp 124 | (setq-default gac-ask-for-summary-p t) 125 | #+end_src 126 | - Set values in a hook: 127 | #+begin_src emacs-lisp 128 | (defun set-my-settings () 129 | (setq gac-automatically-push-p t)) 130 | 131 | (add-hook 'org-mode-hook 'set-my-settings) 132 | #+end_src 133 | - Set values in a ~.dir-locals.el~ (see [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html#Directory-Variables][Per-Directory Local Variables]]): 134 | #+begin_src emacs-lisp 135 | ((nil . ((gac-shell-and . " ; and ")))) 136 | #+end_src 137 | -------------------------------------------------------------------------------- /git-auto-commit-mode.el: -------------------------------------------------------------------------------- 1 | ;;; git-auto-commit-mode.el --- Emacs Minor mode to automatically commit and push -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2012, 2013, 2014, 2015 Tom Willemse 4 | 5 | ;; Author: Tom Willemse 6 | ;; Created: Jan 9, 2012 7 | ;; Version: 4.7.0 8 | ;; Keywords: vc 9 | ;; URL: https://github.com/ryuslash/git-auto-commit-mode 10 | 11 | ;; This file is free software; you can redistribute it and/or 12 | ;; modify it under the terms of the GNU General Public License 13 | ;; as published by the Free Software Foundation; either version 3 14 | ;; of the License, or (at your option) any later version. 15 | 16 | ;; This file is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this file; If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; git-auto-commit-mode is an Emacs minor mode that tries to commit 27 | ;; changes to a file after every save. 28 | 29 | ;; When `gac-automatically-push-p' is non-nil, it also tries to push 30 | ;; to the current upstream. 31 | 32 | ;; When `gac-debounce-interval' is non-nil and set to a number 33 | ;; representing seconds, it will only perform Git actions at that 34 | ;; interval. That way, repeatedly saving a file will not hammer the 35 | ;; Git repository. 36 | 37 | ;;; Code: 38 | 39 | (require 'subr-x) 40 | 41 | (defgroup git-auto-commit-mode nil 42 | "Customization options for `git-auto-commit-mode'." 43 | :group 'external) 44 | 45 | (defcustom gac-automatically-push-p nil 46 | "Automatically push after each commit. 47 | 48 | If non-nil a git push will be executed after each commit." 49 | :tag "Automatically push" 50 | :group 'git-auto-commit-mode 51 | :type 'boolean 52 | :risky t) 53 | (make-variable-buffer-local 'gac-automatically-push-p) 54 | 55 | (defcustom gac-automatically-add-new-files-p t 56 | "Should new (untracked) files automatically be committed to the repo?" 57 | :tag "Automatically add new files" 58 | :group 'git-auto-commit-mode 59 | :type 'boolean) 60 | 61 | (defcustom gac-ask-for-summary-p nil 62 | "Ask the user for a short summary each time a file is committed?" 63 | :tag "Ask for a summary on each commit" 64 | :group 'git-auto-commit-mode 65 | :type 'boolean) 66 | 67 | (defcustom gac-shell-and " && " 68 | "How to join commands together in the shell. For fish shell, 69 | you want to customise this to: \" ; and \" instead of the default." 70 | :tag "Join shell commands" 71 | :group 'git-auto-commit-mode 72 | :type 'string) 73 | 74 | (defcustom gac-add-additional-flag "" 75 | "Flag to add to the git add command." 76 | :tag "git add flag" 77 | :group 'git-auto-commit-mode 78 | :type 'string) 79 | 80 | (defcustom gac-commit-additional-flag "" 81 | "Flag to add to the git commit command." 82 | :tag "git commit flag" 83 | :group 'git-auto-commit-mode 84 | :type 'string) 85 | 86 | (defcustom gac-silent-message-p nil 87 | "Should git output be output to the message area?" 88 | :tag "Quiet message output" 89 | :group 'git-auto-commit-mode 90 | :type 'boolean) 91 | 92 | 93 | (defcustom gac-debounce-interval nil 94 | "Debounce automatic commits to avoid hammering Git. 95 | 96 | If non-nil a commit will be scheduled to occur that many seconds 97 | in the future. Note that this uses Emacs timer functionality, and 98 | is subject to its limitations." 99 | :tag "Debounce interval" 100 | :group 'git-auto-commit-mode 101 | :type '(choice (number :tag "Interval in seconds") 102 | (const :tag "Off" nil))) 103 | (make-variable-buffer-local 'gac-debounce-interval) 104 | 105 | (defcustom gac-default-message nil 106 | "Default message for automatic commits. 107 | 108 | It can be: 109 | - nil to use the default FILENAME 110 | - a string which is used 111 | - a function returning a string, called with FILENAME as 112 | argument, in which case the result is used as commit message 113 | " 114 | :tag "Default commit message" 115 | :group 'git-auto-commit-mode 116 | :type '(choice (string :tag "Commit message") 117 | (const :tag "Default: FILENAME" nil) 118 | (function :tag "Function"))) 119 | 120 | (defun gac-relative-file-name (filename) 121 | "Find the path to FILENAME relative to the git directory." 122 | (let* ((git-dir 123 | (string-trim-right 124 | (shell-command-to-string "git rev-parse --show-toplevel")))) 125 | (file-relative-name filename git-dir))) 126 | 127 | (defun gac-password (proc string) 128 | "Ask the user for a password when necessary. 129 | 130 | PROC is the process running git. STRING is the line that was 131 | output by PROC." 132 | (let (ask) 133 | (cond 134 | ((or 135 | (string-match "^Enter passphrase for key '\\\(.*\\\)': $" string) 136 | (string-match "^\\\(.*\\\)'s password:" string)) 137 | (setq ask (format "Password for '%s': " (match-string 1 string)))) 138 | ((string-match "^[pP]assword:" string) 139 | (setq ask "Password:"))) 140 | 141 | (when ask 142 | (process-send-string proc (concat (read-passwd ask nil) "\n"))))) 143 | 144 | (defun gac-process-filter (proc string) 145 | "Check if PROC is asking for a password and promps the user if so. 146 | 147 | STRING is the output line from PROC." 148 | (save-current-buffer 149 | (set-buffer (process-buffer proc)) 150 | (let ((inhibit-read-only t)) 151 | (gac-password proc string)))) 152 | 153 | (defun gac-process-sentinel (proc status) 154 | "Report PROC change to STATUS." 155 | (message "git %s" (substring status 0 -1))) 156 | 157 | (defun gac--commit-msg (filename) 158 | "Get a commit message. 159 | 160 | Default to FILENAME." 161 | (let ((relative-filename (gac-relative-file-name filename))) 162 | (if (not gac-ask-for-summary-p) 163 | (if gac-default-message 164 | (if (functionp gac-default-message) 165 | (funcall gac-default-message filename) 166 | gac-default-message) 167 | relative-filename) 168 | (or gac-default-message relative-filename) 169 | (read-string "Summary: " nil nil relative-filename)))) 170 | 171 | (defun gac-commit (buffer) 172 | "Commit the current buffer's file to git." 173 | (let* ((buffer-file (buffer-file-name buffer)) 174 | (filename (convert-standard-filename 175 | (file-name-nondirectory buffer-file))) 176 | (commit-msg (gac--commit-msg buffer-file)) 177 | (default-directory (file-name-directory buffer-file))) 178 | (funcall (if gac-silent-message-p 179 | #'call-process-shell-command 180 | #'shell-command) 181 | (concat "git add " gac-add-additional-flag " " (shell-quote-argument filename) 182 | gac-shell-and 183 | "git commit -m " (shell-quote-argument commit-msg) 184 | " " gac-commit-additional-flag)))) 185 | 186 | (defun gac-push (buffer) 187 | "Push commits to the current upstream. 188 | 189 | This doesn't check or ask for a remote, so the correct remote 190 | should already have been set up." 191 | ;; gac-push is currently only called from gac--after-save, where it is wrapped 192 | ;; in with-current-buffer, which should already take care of 193 | ;; default-directory. The explicit binding here is defensive, in case gac-push 194 | ;; starts being used elsewhere. 195 | (let ((default-directory (file-name-directory (buffer-file-name buffer)))) 196 | (let ((proc (start-process "git" "*git-auto-push*" "git" "push"))) 197 | (set-process-sentinel proc 'gac-process-sentinel) 198 | (set-process-filter proc 'gac-process-filter)))) 199 | 200 | (defvar gac--debounce-timers (make-hash-table :test #'equal)) 201 | 202 | (defun gac--debounced-save () 203 | (let* ((actual-buffer (current-buffer)) 204 | (current-buffer-debounce-timer (gethash actual-buffer gac--debounce-timers))) 205 | (unless current-buffer-debounce-timer 206 | (puthash actual-buffer 207 | (run-at-time gac-debounce-interval nil 208 | #'gac--after-save 209 | actual-buffer) 210 | gac--debounce-timers)))) 211 | 212 | (defun gac--buffer-is-tracked (buffer) 213 | "Check to see if BUFFER’s file is tracked in git." 214 | (let ((file-name (convert-standard-filename 215 | (file-name-nondirectory 216 | (buffer-file-name buffer))))) 217 | (not (string= 218 | (shell-command-to-string (concat "git ls-files " file-name)) 219 | "")))) 220 | 221 | (defun gac--buffer-has-changes (buffer) 222 | "Check to see if there is any change in BUFFER." 223 | (let ((file-name (convert-standard-filename 224 | (file-name-nondirectory 225 | (buffer-file-name buffer))))) 226 | (not (string= 227 | (shell-command-to-string (concat "git diff " file-name)) 228 | "")))) 229 | 230 | (defun gac--after-save (buffer) 231 | (unwind-protect 232 | (when (and (buffer-live-p buffer) 233 | (or (and gac-automatically-add-new-files-p 234 | (not (gac--buffer-is-tracked buffer))) 235 | (gac--buffer-has-changes buffer))) 236 | (gac-commit buffer) 237 | (with-current-buffer buffer 238 | ;; with-current-buffer required here because gac-automatically-push-p 239 | ;; is buffer-local 240 | (when gac-automatically-push-p 241 | (gac-push buffer)))) 242 | (remhash buffer gac--debounce-timers))) 243 | 244 | (defun gac-kill-buffer-hook () 245 | (when (and gac-debounce-interval 246 | gac--debounce-timers 247 | (gethash (current-buffer) gac--debounce-timers)) 248 | (gac--after-save (current-buffer)))) 249 | 250 | (add-hook 'kill-buffer-hook #'gac-kill-buffer-hook) 251 | 252 | (defun gac-after-save-func () 253 | "Commit the current file. 254 | 255 | When `gac-automatically-push-p' is non-nil also push." 256 | (if gac-debounce-interval 257 | (gac--debounced-save) 258 | (gac--after-save (current-buffer)))) 259 | 260 | ;;;###autoload 261 | (define-minor-mode git-auto-commit-mode 262 | "Automatically commit any changes made when saving with this 263 | mode turned on and optionally push them too." 264 | :lighter " ga" 265 | (if git-auto-commit-mode 266 | (add-hook 'after-save-hook 'gac-after-save-func t t) 267 | (remove-hook 'after-save-hook 'gac-after-save-func t))) 268 | 269 | (provide 'git-auto-commit-mode) 270 | 271 | ;;; git-auto-commit-mode.el ends here 272 | -------------------------------------------------------------------------------- /tests/git-auto-commit-mode-tests.el: -------------------------------------------------------------------------------- 1 | ;;; git-auto-commit-mode-tests.el --- Tests for git-auto-commit-mode -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019 Tom Willemse 4 | 5 | ;; Author: Tom Willemse 6 | ;; Keywords: 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | 27 | (require 'buttercup) 28 | (require 'git-auto-commit-mode) 29 | 30 | (defun git-auto-commit-mode-tests--get-last-commit-message () 31 | "Get the last commit message from git." 32 | (shell-command-to-string "git log --format=format:%s")) 33 | 34 | (describe "In a git repository" 35 | :var (temp-dir current-directory) 36 | 37 | (before-each 38 | (setq temp-dir (make-temp-file "gac-" t) 39 | current-directory default-directory 40 | default-directory temp-dir) 41 | (shell-command "git init --initial-branch=gac-test") 42 | (shell-command "git config user.email user@example.com") 43 | (shell-command "git config user.name \"User Example\"")) 44 | 45 | (after-each 46 | (delete-directory temp-dir t) 47 | (setq temp-dir nil 48 | default-directory current-directory 49 | current-directory nil)) 50 | 51 | (describe "New files" 52 | (describe "When ‘gac-automatically-add-new-files’ is t" 53 | (it "Should be added to git" 54 | (let* ((gac-automatically-add-new-files-p t) 55 | (temp-file (expand-file-name "test" temp-dir)) 56 | (buffer (find-file-noselect temp-file))) 57 | (with-current-buffer buffer 58 | (git-auto-commit-mode) 59 | (insert "test") 60 | (save-buffer)) 61 | 62 | (expect (git-auto-commit-mode-tests--get-last-commit-message) 63 | :to-match (rx string-start "test" string-end))))) 64 | 65 | (describe "When ‘gac-automatically-add-new-files’ is nil" 66 | (it "Shouldn’t be added to git" 67 | (let* ((gac-automatically-add-new-files-p nil) 68 | (temp-file (expand-file-name "test" temp-dir)) 69 | (buffer (find-file-noselect temp-file))) 70 | (with-current-buffer buffer 71 | (git-auto-commit-mode) 72 | (insert "test") 73 | (save-buffer)) 74 | 75 | (expect (git-auto-commit-mode-tests--get-last-commit-message) 76 | :not :to-match (rx string-start "test" string-end)))))) 77 | 78 | (describe "Getting a relative path" 79 | (it "should return the file name for files in the project root" 80 | (let* ((temp-file (expand-file-name "test" temp-dir)) 81 | (buffer (find-file-noselect temp-file))) 82 | (with-current-buffer buffer 83 | (git-auto-commit-mode) 84 | (insert "test") 85 | (save-buffer)) 86 | 87 | (expect (gac-relative-file-name temp-file) 88 | :to-equal "test"))) 89 | 90 | (it "should return the file name and directory name for nested files" 91 | (mkdir (expand-file-name "test" temp-dir)) 92 | 93 | (let* ((temp-file (expand-file-name "test/test.txt" temp-dir)) 94 | (buffer (find-file-noselect temp-file))) 95 | (with-current-buffer buffer 96 | (git-auto-commit-mode) 97 | (insert "test") 98 | (save-buffer)) 99 | 100 | (expect (gac-relative-file-name temp-file) 101 | :to-equal "test/test.txt"))) 102 | 103 | (it "should handle ‘[]’ in the filename" 104 | (let* ((temp-file (expand-file-name "[test]-test.txt" temp-dir)) 105 | (buffer (find-file-noselect temp-file))) 106 | (with-current-buffer buffer 107 | (git-auto-commit-mode) 108 | (insert "test") 109 | (save-buffer)) 110 | 111 | (expect (gac-relative-file-name temp-file) 112 | :to-equal "[test]-test.txt"))) 113 | 114 | (it "should handle ‘[]’ in the directory name" 115 | (mkdir (expand-file-name "[test]-test" temp-dir)) 116 | 117 | (let* ((temp-file (expand-file-name "[test]-test/testing.txt" temp-dir)) 118 | (buffer (find-file-noselect temp-file))) 119 | (with-current-buffer buffer 120 | (git-auto-commit-mode) 121 | (insert "test") 122 | (save-buffer)) 123 | 124 | (expect (gac-relative-file-name temp-file) 125 | :to-equal "[test]-test/testing.txt"))) 126 | 127 | (it "should handle ‘[’ in the directory name" 128 | (let* ((temp-file (expand-file-name "testing.txt" temp-dir)) 129 | (buffer (find-file-noselect temp-file))) 130 | (with-current-buffer buffer 131 | (git-auto-commit-mode) 132 | (insert "test") 133 | (save-buffer)) 134 | 135 | (expect (gac-relative-file-name temp-file) 136 | :to-equal "testing.txt"))) 137 | 138 | (it "should handle ‘[’ in the file name" 139 | (let* ((temp-file (expand-file-name "[test-test.txt" temp-dir)) 140 | (buffer (find-file-noselect temp-file))) 141 | (with-current-buffer buffer 142 | (git-auto-commit-mode) 143 | (insert "test") 144 | (save-buffer)) 145 | 146 | (expect (gac-relative-file-name temp-file) 147 | :to-equal "[test-test.txt")))) 148 | 149 | (describe "Getting a commit message" 150 | (it "should default to the relative file name" 151 | (let* ((temp-file (expand-file-name "test.txt" temp-dir)) 152 | (buffer (find-file-noselect temp-file))) 153 | (with-current-buffer buffer 154 | (git-auto-commit-mode) 155 | (insert "test") 156 | (save-buffer)) 157 | 158 | (expect (git-auto-commit-mode-tests--get-last-commit-message) 159 | :to-equal "test.txt"))) 160 | 161 | (it "should use the message specified in ‘gac-default-message’" 162 | (let* ((temp-file (expand-file-name "test.txt" temp-dir)) 163 | (buffer (find-file-noselect temp-file)) 164 | (gac-default-message "I made a commit!")) 165 | (with-current-buffer buffer 166 | (git-auto-commit-mode) 167 | (insert "test") 168 | (save-buffer)) 169 | 170 | (expect (git-auto-commit-mode-tests--get-last-commit-message) 171 | :to-equal "I made a commit!"))) 172 | 173 | (it "should use the function result if ‘gac-default-message’ is a function" 174 | (let* ((temp-file (expand-file-name "test.txt" temp-dir)) 175 | (buffer (find-file-noselect temp-file)) 176 | (gac-default-message 177 | (lambda (f) 178 | (concat "wip " (gac-relative-file-name f))))) 179 | (with-current-buffer buffer 180 | (git-auto-commit-mode) 181 | (insert "test") 182 | (save-buffer)) 183 | 184 | (expect (git-auto-commit-mode-tests--get-last-commit-message) 185 | :to-equal "wip test.txt"))))) 186 | 187 | (provide 'git-auto-commit-mode-tests) 188 | ;;; git-auto-commit-mode-tests.el ends here 189 | --------------------------------------------------------------------------------