From fb10b4906aadaeff295883d171c05246943e5571 Mon Sep 17 00:00:00 2001 From: Hennadii Chernyshchyk Date: Sat, 10 Sep 2022 14:05:32 +0300 Subject: Initial commit --- .luacheckrc | 9 + COPYING | 674 +++++++++++++++++++++++++++++++++++++++++++ README.md | 127 ++++++++ lua/tasks/config.lua | 32 ++ lua/tasks/constants.lua | 5 + lua/tasks/init.lua | 142 +++++++++ lua/tasks/module/cargo.lua | 171 +++++++++++ lua/tasks/module/cmake.lua | 272 +++++++++++++++++ lua/tasks/project_config.lua | 29 ++ lua/tasks/runner.lua | 226 +++++++++++++++ lua/tasks/subcommands.lua | 79 +++++ lua/tasks/utils.lua | 100 +++++++ plugin/tasks.lua | 8 + stylua.toml | 5 + 14 files changed, 1879 insertions(+) create mode 100644 .luacheckrc create mode 100755 COPYING create mode 100644 README.md create mode 100644 lua/tasks/config.lua create mode 100644 lua/tasks/constants.lua create mode 100644 lua/tasks/init.lua create mode 100644 lua/tasks/module/cargo.lua create mode 100644 lua/tasks/module/cmake.lua create mode 100644 lua/tasks/project_config.lua create mode 100644 lua/tasks/runner.lua create mode 100644 lua/tasks/subcommands.lua create mode 100644 lua/tasks/utils.lua create mode 100644 plugin/tasks.lua create mode 100644 stylua.toml diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..ba5be9f --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,9 @@ +std = luajit + +ignore = { + '631', -- Line is too long. +} + +globals = { + 'vim', +} diff --git a/COPYING b/COPYING new file mode 100755 index 0000000..ec117b8 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..baf5881 --- /dev/null +++ b/README.md @@ -0,0 +1,127 @@ +# Neovim Tasks + +A Neovim 0.7+ plugin that provides a statefull task system focused on integration with build systems. + +Tasks in this plugin are provided by modules that implement functionality for a specific build system. Modules can have custom parameters which user can set via `:Task set_module_param` (like current target or build type). Tasks consists of one or more commands and have `args` and `env` parameters to set arguments and environment variable respectively. All this settings are serializable and will be stored in configuration file in your project directory. + +## Dependencies + +- Necessary + - [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) for internal helpers. +- Optional + - [nvim-dap](https://github.com/mfussenegger/nvim-dap) - for debugging. + +## Features + +- Output directly into quickfix for fast navigation. +- Tasks provided by modules which can have custom parameters. +- Modules are lazy loaded. +- Module for a task name could be determined automatically based on its condition. +- Tasks can run through debugger. +- Tasks can be chained and react on the previous output. +- Task and module parameters are serializable and specific to the current working directly. +- Tasks arguments could be read from parameters and / or extended via additional temporary arguments passed to `:Task` command. + +## Available modules + +- [CMake](https://cmake.org) via [cmake-file-api](https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#codemodel-version-2). +- [Cargo](https://doc.rust-lang.org/cargo). + +You can also write [your own module](#modules-creation-and-configuration). + +## Commands + +Use the command `:Task` with one of the following arguments: + +| Argument(s) | Description | +| ---------------------------------------- | ---------------------------------------------------------------------------- | +| `start ` | Starting a task from a module. | +| `set_module_param ` | Set parameter for a module. All parameters are module-specific. | +| `set_task_param ` | Set parameter for a task from a module. The parameter can be `arg` or `env`. | +| `cancel` | Cancel currently running task. | + +Modules and tasks will be autocompleted. + +Module name can be `auto`, in which case the first module that satisfies the condition will be used. + +## Configuration + +To configure the plugin, you can call `require('tasks').setup(values)`, where `values` is a dictionary with the parameters you want to override. Here are the defaults: + +```lua +local Path = require('plenary.path') +require('tasks').setup({ + default_params = { -- Default module parameters with which `neovim.json` will be created. + cmake = { + cmd = 'cmake', -- CMake executable to use, can be changed using `:Task set_module_param cmake cmd`. + build_dir = tostring(Path:new('{cwd}', 'build', '{os}-{build_type}')), -- Build directory. The expressions `{cwd}`, `{os}` and `{build_type}` will be expanded with the corresponding text values. Could be a function that return the path to the build directory. + build_type = 'Debug', -- Build type, can be changed using `:Task set_module_param cmake build_type`. + dap_name = 'lldb', -- DAP configuration name from `require('dap').configurations`. If there is no such configuration, a new one with this name as `type` will be created. + args = { -- Task default arguments. + configure = { '-D', 'CMAKE_EXPORT_COMPILE_COMMANDS=1', '-G', 'Ninja' }, + }, + }, + }, + save_before_run = true, -- If true, all files will be saved before executing a task. + params_file = 'neovim.json', -- JSON file to store module and task parameters. + quickfix = { + pos = 'botright', -- Default quickfix position. + height = 12, -- Default height. + }, + dap_open_command = function() return require('dap').repl.open() end, -- Command to run after starting DAP session. You can set it to `false` if you don't want to open anything or `require('dapui').open` if you are using https://github.com/rcarriga/nvim-dap-ui +``` + +## Usage examples + +### CMake + +1. Open a CMake project. +2. Run `configuration` task using `:Task start cmake configure`. +3. Select a target by specifying module parameter with `:Task set_module_param cmake target`. All module parameters are specific to modules. Since CMake can't run targets like Cargo, we introduced a parameter to select the same target for building (appropriate arguments will be passed to CMake automatically) and running. +4. Optionally set arguments using `:Task set_task_param cmake run`. +5. Build and run the project via `:Task start cmake run` or build and debug using `:Task start cmake debug`. You can pass additional arguments to these commands, which will be temporarily added to the arguments from the previous step. + +### Cargo + +1. Open a Cargo project. +2. Optionally set arguments using `:Task set_task_param cargo run`. +3. Optionally set global cargo arguments using `:Task set_task_param cargo global_cargo_args`. +4. Build and run the project via `:Task start cargo run` or build and debug using `:Task start cargo debug`. + +Cargo module doesn't have a `target` param which specific to CMake because `cargo run` automatically pick the binary. If there is multiple binaries, you can set which one you want to run using `--bin` or `--project` in step 2 as you do in CLI. + +## Modules creation and configuration + +To create a module just put a lua file under `lua/tasks/modules` in your configuration or submit your module as a PR. In this module you need to return a table with the following fields: + +```lua +{ + params = { + -- A table of parameter names. Possible values: + 'parameter_name1', -- A string parameter, on setting user will be prompted with vim.ui.input. + parameter_name2 = { 'one', 'two' }, -- A table with possible balues, on setting user will be promted with vim.ui.select to pick one of these values. + parameter_name3 = func, -- A function that generates a string or a table. + } + condition = function() return Path:new('file'):exists() end -- A function that returns `true` if this module could be applied to this directory. Used when `auto` is used as module name. + tasks = { + -- A table of module tasks. Possible values: + task_name1 = { + -- Required parameters: + cmd = 'command' -- Command to execute. + -- Optional parameters: + cwd = 'directory' -- Command working directory. Default to current working directory. + after_success = callback -- A callback to execute on success. + dap_name = 'dap_name' -- A debug adapter name. If exists, the task will be launched through the adapter. Usually taken from a module parameter. Implies ignoring all streams below. + -- Disable a stream output to quickfix. If both are disabled, quickfix will not show up. If you want to capture output of a stream in a next task, you need to disable it. + ignore_stdout = true, + ignore_stderr = true, + }, + task_name2 = func1, -- A function that returns a table as above. Accepts configuration for this module and previous job. + task_name3 = { func2, func3 }, -- A list of functions as above. Tasks will be executed in chain. + } +} +``` + +For a more complex example take a look at [cargo.lua](lua/tasks/module/cargo.lua). + +You can also edit existing modules in right in your config. Just import a module using `require('tasks.modules.module_name')` and add/remove/modify any fields from the above. diff --git a/lua/tasks/config.lua b/lua/tasks/config.lua new file mode 100644 index 0000000..0d5da61 --- /dev/null +++ b/lua/tasks/config.lua @@ -0,0 +1,32 @@ +local Path = require('plenary.path') + +local config = { + defaults = { + default_params = { + cmake = { + cmd = 'cmake', + build_dir = tostring(Path:new('{cwd}', 'build', '{os}-{build_type}')), + build_type = 'Debug', + dap_name = 'lldb', + args = { + configure = { '-D', 'CMAKE_EXPORT_COMPILE_COMMANDS=1', '-G', 'Ninja' }, + }, + }, + cargo = { + dap_name = 'lldb', + }, + }, + save_before_run = true, + params_file = 'neovim.json', + quickfix = { + pos = 'botright', + height = 12, + only_on_error = false, + }, + dap_open_command = function() return require('dap').repl.open() end, + }, +} + +setmetatable(config, { __index = config.defaults }) + +return config diff --git a/lua/tasks/constants.lua b/lua/tasks/constants.lua new file mode 100644 index 0000000..4e236b2 --- /dev/null +++ b/lua/tasks/constants.lua @@ -0,0 +1,5 @@ +local constants = { + task_params = { 'args', 'env' }, -- Parameters available for all tasks +} + +return constants diff --git a/lua/tasks/init.lua b/lua/tasks/init.lua new file mode 100644 index 0000000..4b6c893 --- /dev/null +++ b/lua/tasks/init.lua @@ -0,0 +1,142 @@ +local config = require('tasks.config') +local runner = require('tasks.runner') +local constants = require('tasks.constants') +local utils = require('tasks.utils') +local ProjectConfig = require('tasks.project_config') +local tasks = {} + +--- Apply user settings. +---@param values table +function tasks.setup(values) setmetatable(config, { __index = vim.tbl_deep_extend('force', config.defaults, values) }) end + +--- Execute a task from a module. +---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition. +---@param task_name string +---@vararg string additional arguments that will be passed to the last task. +function tasks.start(module_type, task_name, ...) + local current_job_name = runner.get_current_job_name() + if current_job_name then + utils.notify(string.format('Another job is currently running: "%s"', current_job_name), vim.log.levels.ERROR) + return + end + + local module, module_name = utils.get_module(module_type) + if not module then + return + end + + local commands = module.tasks[task_name] + if not commands then + utils.notify(string.format('Unable to find a task named "%s" in module "%s"', task_name, module_name), vim.log.levels.ERROR) + return + end + + if config.save_before_run then + vim.api.nvim_command('silent! wall') + end + + local project_config = ProjectConfig.new() + local module_config = project_config[module_name] + if not vim.tbl_islist(commands) then + commands = { commands } + end + runner.chain_commands(task_name, commands, module_config, { ... }) +end + +--- Set a module-specific parameter. Settings will be stored on disk. +---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition. +---@param param_name string +function tasks.set_module_param(module_type, param_name) + local module, module_name = utils.get_module(module_type) + if not module then + return + end + + if not module then + return + end + + local project_config = ProjectConfig.new() + local current_value = vim.tbl_get(project_config, module_name, param_name) + + local param = module.params[param_name] + if not param then + if vim.tbl_contains(module.params, param_name) then + -- Contains a string without a value, request for input + vim.ui.input({ prompt = string.format('Set "%s" for module "%s"', param_name, module_name), default = current_value }, function(input) + project_config[module_name][param_name] = input + project_config:write() + end) + else + utils.notify(string.format('No such parameter "%s" for module "%s"', param_name, module_name), vim.log.levels.ERROR) + end + return + end + + if vim.is_callable(param) then + param = param() + if not param then + return + end + end + + -- Put current value first + if current_value then + for index, value in ipairs(param) do + if value == current_value then + table.remove(param, index) + break + end + end + table.insert(param, 1, current_value) + end + + vim.ui.select(param, { prompt = string.format('Select "%s"', param_name) }, function(choice, idx) + if not idx then + return + end + if not project_config[module_name] then + project_config[module_name] = {} + end + project_config[module_name][param_name] = choice + project_config:write() + end) +end + +--- Set a parameter for a module task. Settings will be stored on disk. +---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition. +---@param task_name string +---@param param_name string +function tasks.set_task_param(module_type, task_name, param_name) + local module, module_name = utils.get_module(module_type) + if not module then + return + end + if not vim.tbl_contains(constants.task_params, param_name) then + utils.notify(string.format('Unknown task parameter "%s"\nAvailable task parameters: %s', param_name, table.concat(constants.task_params, ', ')), vim.log.levels.ERROR) + return + end + + local project_config = ProjectConfig.new() + local current_value = vim.tbl_get(project_config, module_name, param_name, task_name) + current_value = current_value and utils.join_args(current_value) or '' + vim.ui.input({ prompt = string.format('Set "%s" for task "%s" from module "%s": ', param_name, task_name, module_name), default = current_value, completion = 'file' }, function(input) + if not project_config[module_name] then + project_config[module_name] = {} + end + if not project_config[module_name][param_name] then + project_config[module_name][param_name] = {} + end + project_config[module_name][param_name][task_name] = utils.split_args(input) + project_config:write() + end) +end + +--- Cancel last current task. +function tasks.cancel() + if not runner.cancel_job() then + utils.notify('No running process') + end +end + +return tasks diff --git a/lua/tasks/module/cargo.lua b/lua/tasks/module/cargo.lua new file mode 100644 index 0000000..3e21371 --- /dev/null +++ b/lua/tasks/module/cargo.lua @@ -0,0 +1,171 @@ +local utils = require('tasks.utils') +local Job = require('plenary.job') +local Path = require('plenary.path') +local cargo = {} + +-- Modified version of `errorformat` from the official Rust plugin for Vim: +-- https://github.com/rust-lang/rust.vim/blob/4aa69b84c8a58fcec6b6dad6fe244b916b1cf830/compiler/rustc.vim#L32 +-- https://github.com/rust-lang/rust.vim/blob/4aa69b84c8a58fcec6b6dad6fe244b916b1cf830/compiler/cargo.vim#L35 +-- We display all lines (not only error messages) since we show output in quickfix. +-- Zero-width look-ahead regex is used to avoid marking general messages as errors: %\%%(ignored text%\)%\@!. +local errorformat = [[%Eerror: %\%%(aborting %\|could not compile%\)%\@!%m,]] + .. [[%Eerror[E%n]: %m,]] + .. [[%Inote: %m,]] + .. [[%Wwarning: %\%%(%.%# warning%\)%\@!%m,]] + .. [[%C %#--> %f:%l:%c,]] + .. [[%E left:%m,%C right:%m %f:%l:%c,%Z,]] + .. [[%.%#panicked at \'%m\'\, %f:%l:%c]] + +--- Detects package name from command line arguments. +---@param args table +---@return string? +local function detect_package_name(args) + for index, value in ipairs(args) do + if value == '-p' or value == '--package' or value == '--bin' then + return args[index + 1] + end + end + return nil +end + +--- Returns only a packages that can be executed. +---@param packages table: Packages to filter. +---@return table +local function find_executable_packages(packages) + local executables = {} + for _, line in pairs(packages) do + local package = vim.json.decode(line) + if package.executable and package.executable ~= vim.NIL then + table.insert(executables, package) + end + end + return executables +end + +--- Finds executable package name from a list of packages. +---@param packages table +---@param args table?: Command line arguments that will be used to detect an executable if JSON message from cargo is missing this info. +---@return table? +local function get_executable_package(packages, args) + local executable_packages = find_executable_packages(packages) + if #executable_packages == 1 then + return executable_packages[1] + end + + -- Try to detect package name from arguments + local package_name = detect_package_name(args or {}) + if not package_name then + local available_names = {} + for _, package in ipairs(executable_packages) do + table.insert(available_names, package.target.name) + end + utils.notify( + 'Could not determine which binary to run\nUse the "--bin" or "--package" option to specify a binary\nAvailable binaries: ' .. table.concat(available_names, ', '), + vim.log.levels.ERROR + ) + return nil + end + + for _, package in ipairs(executable_packages) do + if package.target.name == package_name then + return package + end + end + + utils.notify(string.format('Unable to find package named "%s"', package_name), vim.log.levels.ERROR) + return nil +end + +---@return table: List of functions for each cargo subcommand that return a task table. +local function get_cargo_subcommands() + local cargo_subcommands = {} + + local job = Job:new({ + command = 'cargo', + args = { '--list' }, + enabled_recording = true, + }) + job:sync() + + if job.code ~= 0 or job.signal ~= 0 then + utils.notify('Unable to get list of available cargo subcommands', vim.log.levels.ERROR) + return {} + end + + local start_offset = 5 + for index, line in ipairs(job:result()) do + if index ~= 1 and not line:find('alias:') then + local subcommand_end = line:find(' ', start_offset) + local subcommand = line:sub(start_offset, subcommand_end and subcommand_end - 1 or nil) + cargo_subcommands[subcommand] = + function(module_config, _) return { cmd = 'cargo', args = vim.list_extend({ subcommand }, utils.split_args(module_config.global_cargo_args)), errorformat = errorformat } end + end + end + + return cargo_subcommands +end + +--- Task +---@return table? +local function build_test(module_config, _) + return { + cmd = 'cargo', + args = vim.list_extend({ 'test', '--no-run', '--message-format=json' }, utils.split_args(module_config.global_cargo_args)), + errorformat = errorformat, + ignore_stdout = true, + } +end + +--- Task +---@param module_config table +---@param previous_job table +---@return table? +local function debug_test(module_config, previous_job) + local package = get_executable_package(previous_job:result(), vim.tbl_get(module_config, 'args', 'debug_test')) + if not package then + return + end + + return { + cmd = package.executable, + dap_name = module_config.dap_name, + errorformat = errorformat, + } +end + +--- Task +---@param module_config table +---@return table? +local function build(module_config, _) + return { + cmd = 'cargo', + args = vim.list_extend({ 'build', '--message-format=json' }, utils.split_args(module_config.global_cargo_args)), + ignore_stdout = true, + } +end + +--- Task +---@param module_config table +---@param previous_job table +---@return table? +local function debug(module_config, previous_job) + local package = get_executable_package(previous_job:result(), vim.tbl_get(module_config, 'args', 'debug')) + if not package then + return + end + + return { + cmd = package.executable, + dap_name = module_config.dap_name, + errorformat = errorformat, + } +end + +cargo.params = { + 'dap_name', + 'global_cargo_args', +} +cargo.condition = function() return Path:new('Cargo.toml'):exists() end +cargo.tasks = vim.tbl_extend('force', get_cargo_subcommands(), { debug_test = { build_test, debug_test }, debug = { build, debug } }) + +return cargo diff --git a/lua/tasks/module/cmake.lua b/lua/tasks/module/cmake.lua new file mode 100644 index 0000000..4900aec --- /dev/null +++ b/lua/tasks/module/cmake.lua @@ -0,0 +1,272 @@ +local Path = require('plenary.path') +local utils = require('tasks.utils') +local scandir = require('plenary.scandir') +local ProjectConfig = require('tasks.project_config') +local os = require('ffi').os:lower() +local cmake = {} + +--- Parses build dir expression. +---@param dir string: Path with expressions to replace. +---@param build_type string +---@return table +local function parse_dir(dir, build_type) + local parsed_dir = dir:gsub('{cwd}', vim.loop.cwd()) + parsed_dir = parsed_dir:gsub('{os}', os) + parsed_dir = parsed_dir:gsub('{build_type}', build_type:lower()) + return Path:new(parsed_dir) +end + +--- Returns reply directory that contains targets information. +---@param build_dir table +---@return unknown +local function get_reply_dir(build_dir) return build_dir / '.cmake' / 'api' / 'v1' / 'reply' end + +--- Reads information about target. +---@param codemodel_target table +---@param reply_dir table +---@return table +local function get_target_info(codemodel_target, reply_dir) return vim.json.decode((reply_dir / codemodel_target['jsonFile']):read()) end + +--- Creates query files that to acess information about targets after CMake configuration. +---@param build_dir table +---@return boolean: Returns `true` on success. +local function make_query_files(build_dir) + local query_dir = build_dir / '.cmake' / 'api' / 'v1' / 'query' + if not query_dir:mkdir({ parents = true }) then + utils.notify(string.format('Unable to create "%s"', query_dir.filename), vim.log.levels.ERROR) + return false + end + + local codemodel_file = query_dir / 'codemodel-v2' + if not codemodel_file:is_file() then + if not codemodel_file:touch() then + utils.notify(string.format('Unable to create "%s"', codemodel_file.filename), vim.log.levels.ERROR) + return false + end + end + return true +end + +--- Reads targets information. +---@param reply_dir table +---@return table? +local function get_codemodel_targets(reply_dir) + local found_files = scandir.scan_dir(reply_dir.filename, { search_pattern = 'codemodel*' }) + if #found_files == 0 then + utils.notify('Unable to find codemodel file', vim.log.levels.ERROR) + return nil + end + local codemodel = Path:new(found_files[1]) + local codemodel_json = vim.json.decode(codemodel:read()) + return codemodel_json['configurations'][1]['targets'] +end + +---@return table? +local function get_target_names() + local project_config = ProjectConfig.new() + local build_dir = parse_dir(project_config.cmake.build_dir, project_config.cmake.build_type) + if not build_dir:is_dir() then + utils.notify(string.format('Build directory "%s" does not exist, you need to run "configure" task first', build_dir), vim.log.levels.ERROR) + return nil + end + + local reply_dir = get_reply_dir(build_dir) + local codemodel_targets = get_codemodel_targets(reply_dir) + if not codemodel_targets then + return nil + end + + local targets = {} + for _, target in ipairs(codemodel_targets) do + local target_info = get_target_info(target, reply_dir) + local target_name = target_info['name'] + if target_name:find('_autogen') == nil then + table.insert(targets, target_name) + end + end + + return targets +end + +--- Finds path to an executable. +---@param build_dir table +---@param name string +---@param reply_dir table +---@return unknown? +local function get_executable_path(build_dir, name, reply_dir) + for _, target in ipairs(get_codemodel_targets(reply_dir)) do + if name == target['name'] then + local target_info = get_target_info(target, reply_dir) + if target_info['type'] ~= 'EXECUTABLE' then + utils.notify(string.format('Specified target "%s" is not an executable', name), vim.log.levels.ERROR) + return nil + end + + local target_path = Path:new(target_info['artifacts'][1]['path']) + if not target_path:is_absolute() then + target_path = build_dir / target_path + end + + return target_path + end + end + + utils.notify(string.format('Unable to find target named "%s"', name), vim.log.levels.ERROR) + return nil +end + +--- Copies compile_commands.json file from build directory to the current working directory for LSP integration. +local function copy_compile_commands() + local project_config = ProjectConfig.new() + local filename = 'compile_commands.json' + local source = parse_dir(project_config.cmake.build_dir, project_config.cmake.build_type) / filename + local destination = Path:new(vim.loop.cwd(), filename) + source:copy({ destination = destination.filename }) +end + +--- Task +---@param module_config table +---@return table? +local function configure(module_config, _) + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + build_dir:mkdir({ parents = true }) + if not make_query_files(build_dir) then + return nil + end + + return { + cmd = module_config.cmd, + args = { '-B', build_dir.filename, '-D', 'CMAKE_BUILD_TYPE=' .. module_config.build_type }, + after_success = copy_compile_commands, + } +end + +--- Task +---@param module_config table +---@return table +local function build(module_config, _) + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + + local args = { '--build', build_dir.filename } + if module_config.target then + vim.list_extend(args, { '--target', module_config.target }) + end + + return { + cmd = module_config.cmd, + args = args, + after_success = copy_compile_commands, + } +end + +--- Task +---@param module_config table +---@return table +local function build_all(module_config, _) + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + + return { + cmd = module_config.cmd, + args = { '--build', build_dir.filename }, + after_success = copy_compile_commands, + } +end + +--- Task +---@param module_config table +---@return table? +local function run(module_config, _) + if not module_config.target then + utils.notify('No selected target, please set "target" parameter', vim.log.levels.ERROR) + return nil + end + + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + if not build_dir:is_dir() then + utils.notify(string.format('Build directory "%s" does not exist, you need to run "configure" task first', build_dir), vim.log.levels.ERROR) + return nil + end + + local target_path = get_executable_path(build_dir, module_config.target, get_reply_dir(build_dir)) + if not target_path then + return + end + + if not target_path:is_file() then + utils.notify(string.format('Selected target "%s" is not built', target_path.filename), vim.log.levels.ERROR) + return nil + end + + return { + cmd = target_path.filename, + cwd = target_path:parent().filename, + } +end + +--- Task +---@param module_config table +---@return table? +local function debug(module_config, _) + if module_config.build_type ~= 'Debug' and module_config.build_type ~= 'RelWithDebInfo' then + utils.notify( + string.format('For debugging your "build_type" param should be set to "Debug" or "RelWithDebInfo", but your current build type is "%s"'), + module_config.build_type, + vim.log.levels.ERROR + ) + return nil + end + + local command = run(module_config, nil) + if not command then + return nil + end + + command.dap_name = module_config.dap_name + return command +end + +--- Task +---@param module_config table +---@return table +local function clean(module_config, _) + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + + return { + cmd = module_config.cmd, + args = { '--build', build_dir.filename, '--target', 'clean' }, + after_success = copy_compile_commands, + } +end + +--- Task +---@param module_config table +---@return table +local function open_build_dir(module_config, _) + local build_dir = parse_dir(module_config.build_dir, module_config.build_type) + + return { + cmd = os == 'windows' and 'start' or 'xdg-open', + args = { build_dir.filename }, + ignore_stdout = true, + ignore_stderr = true, + } +end + +cmake.params = { + target = get_target_names, + build_type = { 'Debug', 'Release', 'RelWithDebInfo', 'MinSizeRel' }, + 'cmake', + 'dap_name', +} +cmake.condition = function() return Path:new('CMakeLists.txt'):exists() end +cmake.tasks = { + configure = configure, + build = build, + build_all = build_all, + run = { build, run }, + debug = debug, + clean = clean, + open_build_dir = open_build_dir, +} + +return cmake diff --git a/lua/tasks/project_config.lua b/lua/tasks/project_config.lua new file mode 100644 index 0000000..2d366c6 --- /dev/null +++ b/lua/tasks/project_config.lua @@ -0,0 +1,29 @@ +local config = require('tasks.config') +local Path = require('plenary.path') + +--- Contains all fields from configuration. +---@class ProjectConfig +local ProjectConfig = {} +ProjectConfig.__index = ProjectConfig + +--- Reads project configuration JSON into a table. +---@return ProjectConfig +function ProjectConfig.new() + local project_config = {} + local params_file = Path:new(config.params_file) + if params_file:is_file() then + project_config = vim.json.decode(params_file:read()) + else + project_config = {} + end + project_config = vim.tbl_extend('keep', project_config, config.default_params) + return setmetatable(project_config, ProjectConfig) +end + +--- Writes all values as JSON to disk. +function ProjectConfig:write() + local params_file = Path:new(config.params_file) + params_file:write(vim.json.encode(self), 'w') +end + +return ProjectConfig diff --git a/lua/tasks/runner.lua b/lua/tasks/runner.lua new file mode 100644 index 0000000..21bf765 --- /dev/null +++ b/lua/tasks/runner.lua @@ -0,0 +1,226 @@ +local config = require('tasks.config') +local Job = require('plenary.job') +local runner = {} + +local last_job + +---@param lines table +---@param errorformat string? +local function append_to_quickfix(lines, errorformat) + vim.fn.setqflist({}, 'a', { efm = errorformat, lines = lines }) + -- Scrolls the quickfix buffer if not active + if vim.bo.buftype ~= 'quickfix' then + vim.api.nvim_command('cbottom') + end +end + +---@param errorformat? string +---@return function: A coroutine that reads job data into quickfix. +local function read_to_quickfix(errorformat) + -- Modified from https://github.com/nvim-lua/plenary.nvim/blob/968a4b9afec0c633bc369662e78f8c5db0eba249/lua/plenary/job.lua#L287 + -- We use our own implementation to process data in chunks because + -- default Plenary callback processes every line which is very slow for adding to quickfix. + return coroutine.wrap(function(err, data, is_complete) + -- We repeat forever as a coroutine so that we can keep calling this. + local lines = {} + local result_index = 1 + local result_line = nil + local found_newline = nil + + while true do + if data then + data = data:gsub('\r', '') + + local processed_index = 1 + local data_length = #data + 1 + + repeat + local start = data:find('\n', processed_index, true) or data_length + local line = data:sub(processed_index, start - 1) + found_newline = start ~= data_length + + -- Concat to last line if there was something there already. + -- This happens when "data" is broken into chunks and sometimes + -- the content is sent without any newlines. + if result_line then + result_line = result_line .. line + + -- Only put in a new line when we actually have new data to split. + -- This is generally only false when we do end with a new line. + -- It prevents putting in a "" to the end of the results. + elseif start ~= processed_index or found_newline then + result_line = line + + -- Otherwise, we don't need to do anything. + end + + if found_newline then + if not result_line then + return vim.api.nvim_err_writeln('Broken data thing due to: ' .. tostring(result_line) .. ' ' .. tostring(data)) + end + + table.insert(lines, err and err or result_line) + + result_index = result_index + 1 + result_line = nil + end + + processed_index = start + 1 + until not found_newline + end + + if is_complete and not found_newline then + table.insert(lines, err and err or result_line) + end + + if #lines ~= 0 then + -- Move lines to another variable and send them to quickfix + local processed_lines = lines + lines = {} + vim.schedule(function() append_to_quickfix(processed_lines, errorformat) end) + end + + if data == nil or is_complete then + return + end + + err, data, is_complete = coroutine.yield() + end + end) +end + +--- Run specified commands in chain. +---@param task_name string: Name of a task to read properties. +---@param commands table: Commands to chain. +---@param module_config table: Module configuration. +---@param addition_args table?: Additional arguments that will be applied to the last command. +---@param previous_job table?: Previous job to read data from, used by this function for recursion. +function runner.chain_commands(task_name, commands, module_config, addition_args, previous_job) + local command = commands[1] + if vim.is_callable(command) then + command = command(module_config, previous_job) + if not command then + return + end + end + + local cwd = command.cwd or vim.loop.cwd() + local args = command.args and command.args or {} + local env = vim.tbl_extend('force', vim.loop.os_environ(), command.env and command.env or {}) + if #commands == 1 then + -- Apply task parameters only to the last command + vim.list_extend(args, addition_args) + vim.list_extend(args, vim.tbl_get(module_config, 'args', task_name) or {}) + env = vim.tbl_extend('force', env, vim.tbl_get(module_config, 'env', task_name) or {}) + end + + if command.dap_name then + vim.schedule(function() + local dap = require('dap') + local dap_config = dap.configurations[command.dap_name] -- Try to get an existing configuration + dap.run(vim.tbl_extend('force', dap_config and dap_config or { type = command.dap_name }, { + name = command.cmd, + request = 'launch', + program = command.cmd, + args = args, + })) + if config.dap_open_command then + vim.api.nvim_command('cclose') + config.dap_open_command() + end + last_job = dap + end) + return + end + + local quickfix_output = not command.ignore_stdout and not command.ignore_stderr + local job = Job:new({ + command = command.cmd, + args = args, + cwd = cwd, + env = env, + enable_recording = #commands ~= 1, + on_start = quickfix_output and vim.schedule_wrap(function() + vim.fn.setqflist({}, ' ', { title = command.cmd .. ' ' .. table.concat(args, ' ') }) + vim.api.nvim_command(string.format('%s copen %d', config.quickfix.pos, config.quickfix.height)) + vim.api.nvim_command('wincmd p') + end) or nil, + on_exit = vim.schedule_wrap(function(_, code, signal) + if quickfix_output then + append_to_quickfix({ 'Exited with code ' .. (signal == 0 and code or 128 + signal) }) + end + if code == 0 and signal == 0 and command.after_success then + command.after_success() + end + end), + }) + + job:start() + if not command.ignore_stdout then + job.stdout:read_start(read_to_quickfix(command.errorformat)) + end + if not command.ignore_stderr then + job.stderr:read_start(read_to_quickfix(command.errorformat)) + end + + if #commands ~= 1 then + job:after_success(function() runner.chain_commands(task_name, vim.list_slice(commands, 2), module_config, addition_args, job) end) + end + last_job = job +end + +---@return string? +function runner.get_current_job_name() + if not last_job then + return nil + end + + -- Check if this job was run through debugger. + if last_job.session then + local session = last_job.session() + if not session then + return nil + end + return session.config.program + end + + if last_job.is_shutdown then + return nil + end + + return last_job.cmd +end + +---@return boolean: `true` if a job was canceled or `false` if there is no active job. +function runner.cancel_job() + if not last_job then + return false + end + + -- Check if this job was run through debugger. + if last_job.session then + if not last_job.session() then + return false + end + last_job.terminate() + return true + end + + if last_job.is_shutdown then + return false + end + + last_job:shutdown(1, 9) + + if vim.fn.has('win32') == 1 then + -- Kill all children. + for _, pid in ipairs(vim.api.nvim_get_proc_children(last_job.pid)) do + vim.loop.kill(pid, 9) + end + else + vim.loop.kill(last_job.pid, 9) + end + return true +end + +return runner diff --git a/lua/tasks/subcommands.lua b/lua/tasks/subcommands.lua new file mode 100644 index 0000000..a4ec9ca --- /dev/null +++ b/lua/tasks/subcommands.lua @@ -0,0 +1,79 @@ +local tasks = require('tasks') +local utils = require('tasks.utils') +local constants = require('tasks.constants') +local subcommands = {} + +--- Completes `:Task` command. +---@param arg string: Current argument under cursor. +---@param cmd_line string: All arguments. +---@return table: List of all commands matched with `arg`. +function subcommands.complete(arg, cmd_line) + local matches = {} + + local words = vim.split(cmd_line, ' ', { trimempty = true }) + if not vim.endswith(cmd_line, ' ') then + -- Last word is not fully typed, don't count it + table.remove(words, #words) + end + + if #words == 1 then + for subcommand in pairs(tasks) do + if vim.startswith(subcommand, arg) and subcommand ~= 'setup' then + table.insert(matches, subcommand) + end + end + elseif #words == 2 then + if words[2] == 'start' or words[2] == 'set_task_param' or words[2] == 'set_module_param' then + local module_names = utils.get_module_names() + table.insert(module_names, 'auto') -- Special value for automatic module detection + for _, module_name in ipairs(module_names) do + if vim.startswith(module_name, arg) then + table.insert(matches, module_name) + end + end + end + elseif #words == 3 then + if words[2] == 'start' or words[2] == 'set_task_param' or words[2] == 'set_module_param' then + local ok, module = pcall(require, 'tasks.module.' .. words[3]) + if ok then + for key, value in pairs(words[2] == 'set_module_param' and module.params or module.tasks) do + local name = type(key) == 'number' and value or key -- Handle arrays + if vim.startswith(name, arg) then + table.insert(matches, name) + end + end + end + end + elseif #words == 4 then + if words[2] == 'set_task_param' then + for _, param_name in ipairs(constants.task_params) do + if vim.startswith(param_name, arg) then + table.insert(matches, param_name) + end + end + end + end + + return matches +end + +--- Run specified subcommand received from completion. +---@param subcommand table +function subcommands.run(subcommand) + local subcommand_func = tasks[subcommand.fargs[1]] + if not subcommand_func then + utils.notify(string.format('No such subcommand named "%s"', subcommand.fargs[1]), vim.log.levels.ERROR) + return + end + local subcommand_info = debug.getinfo(subcommand_func) + if subcommand_info.isvararg and #subcommand.fargs - 1 < subcommand_info.nparams then + utils.notify(string.format('Subcommand %s should have at least %s argument(s)', subcommand.fargs[1], subcommand_info.nparams + 1), vim.log.levels.ERROR) + return + elseif not subcommand_info.isvararg and #subcommand.fargs - 1 ~= subcommand_info.nparams then + utils.notify(string.format('Subcommand %s should have %s argument(s)', subcommand.fargs[1], subcommand_info.nparams + 1), vim.log.levels.ERROR) + return + end + subcommand_func(unpack(subcommand.fargs, 2)) +end + +return subcommands diff --git a/lua/tasks/utils.lua b/lua/tasks/utils.lua new file mode 100644 index 0000000..983bde7 --- /dev/null +++ b/lua/tasks/utils.lua @@ -0,0 +1,100 @@ +local scandir = require('plenary.scandir') +local Path = require('plenary.path') +local utils = {} + +local args_regex = vim.regex([[\s\%(\%([^'"]*\(['"]\)[^'"]*\1\)*[^'"]*$\)\@=]]) + +--- A small wrapper around `vim.notify` that adds plugin title. +---@param msg string +---@param log_level number +function utils.notify(msg, log_level) vim.notify(msg, log_level, { title = 'Tasks' }) end + +--- Splits command line arguments respecting quotes. +---@param args string? +---@return table +function utils.split_args(args) + if not args then + return {} + end + + -- Split on spaces unless in quotes. + local splitted_args = {} + local match_beg + while true do + match_beg = args_regex:match_str(args) + if match_beg then + table.insert(splitted_args, args:sub(1, match_beg)) + args = args:sub(match_beg + 2) + else + -- Insert last arg left. + table.insert(splitted_args, args) + break + end + end + + -- Remove quotes + for i, arg in ipairs(splitted_args) do + splitted_args[i] = arg:gsub('"', ''):gsub("'", '') + end + return splitted_args +end + +--- Joins command line arguments respecting spaces by putting double quotes around them. +---@param args table? +---@return string +function utils.join_args(args) + if not args then + return '' + end + + -- Add quotes if argument contain spaces + for index, arg in ipairs(args) do + if arg:find(' ') then + args[index] = '"' .. arg .. '"' + end + end + + return table.concat(args, ' ') +end + +---@return table +function utils.get_module_names() + local module_dir = Path:new(debug.getinfo(1).source:sub(2)):parent() / 'module' + + local modules = {} + for _, entry in ipairs(scandir.scan_dir(module_dir.filename, { depth = 1 })) do + -- Strip full path and extension + local extension_len = 4 + local parent_offset = 2 + table.insert(modules, entry:sub(#Path:new(entry):parent().filename + parent_offset, #entry - extension_len)) + end + + return modules +end + +--- Find a module by name +---@param module_type string name of a module or `auto` string to pick a first module that match a condition. +---@return table?, string?: module and its name. +function utils.get_module(module_type) + if module_type == 'auto' then + for _, name in ipairs(utils.get_module_names()) do + local module = require('tasks.module.' .. name) + if module.condition() then + return module, name + end + end + + utils.notify('Unable to autodetect module for this working directory', vim.log.levels.ERROR) + return nil, nil + end + + local module = require('tasks.module.' .. module_type) + if not module then + utils.notify('Unable to find a module named ' .. module_type, vim.log.levels.ERROR) + return nil, nil + end + + return module, module_type +end + +return utils diff --git a/plugin/tasks.lua b/plugin/tasks.lua new file mode 100644 index 0000000..bcbd305 --- /dev/null +++ b/plugin/tasks.lua @@ -0,0 +1,8 @@ +if vim.version().minor < 7 then + require('tasks.utils').notify('Neovim 0.7+ is required for tasks plugin', vim.log.levels.ERROR) + return +end + +local subcommands = require('tasks.subcommands') + +vim.api.nvim_create_user_command('Task', subcommands.run, { nargs = '*', complete = subcommands.complete, desc = 'Run or configure a task' }) diff --git a/stylua.toml b/stylua.toml new file mode 100644 index 0000000..28b63a9 --- /dev/null +++ b/stylua.toml @@ -0,0 +1,5 @@ +column_width = 200 +indent_type = 'Spaces' +indent_width = 2 +quote_style = 'AutoPreferSingle' +collapse_simple_statement = 'FunctionOnly' -- cgit v1.2.3