aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHennadii Chernyshchyk <genaloner@gmail.com>2022-09-10 14:05:32 +0300
committerHennadii Chernyshchyk <genaloner@gmail.com>2022-09-10 17:48:06 +0300
commitfb10b4906aadaeff295883d171c05246943e5571 (patch)
treeeae589c4aeb613b8a2e8a1daf678f008f01069b9
downloadneovim-tasks-fb10b4906aadaeff295883d171c05246943e5571.tar.gz
neovim-tasks-fb10b4906aadaeff295883d171c05246943e5571.zip
Initial commit
-rw-r--r--.luacheckrc9
-rwxr-xr-xCOPYING674
-rw-r--r--README.md127
-rw-r--r--lua/tasks/config.lua32
-rw-r--r--lua/tasks/constants.lua5
-rw-r--r--lua/tasks/init.lua142
-rw-r--r--lua/tasks/module/cargo.lua171
-rw-r--r--lua/tasks/module/cmake.lua272
-rw-r--r--lua/tasks/project_config.lua29
-rw-r--r--lua/tasks/runner.lua226
-rw-r--r--lua/tasks/subcommands.lua79
-rw-r--r--lua/tasks/utils.lua100
-rw-r--r--plugin/tasks.lua8
-rw-r--r--stylua.toml5
14 files changed, 1879 insertions, 0 deletions
diff --git a/.luacheckrc b/.luacheckrc
new file mode 100644
index 0000000..ba5be9f
--- /dev/null
+++ b/.luacheckrc
@@ -0,0 +1,9 @@
1std = luajit
2
3ignore = {
4 '631', -- Line is too long.
5}
6
7globals = {
8 'vim',
9}
diff --git a/COPYING b/COPYING
new file mode 100755
index 0000000..ec117b8
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,674 @@
1 GNU GENERAL PUBLIC LICENSE
2 Version 3, 29 June 2007
3
4 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
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
11software and other kinds of works.
12
13 The licenses for most software and other practical works are designed
14to take away your freedom to share and change the works. By contrast,
15the GNU General Public License is intended to guarantee your freedom to
16share and change all versions of a program--to make sure it remains free
17software for all its users. We, the Free Software Foundation, use the
18GNU General Public License for most of our software; it applies also to
19any other work released this way by its authors. You can apply it to
20your programs, too.
21
22 When we speak of free software, we are referring to freedom, not
23price. Our General Public Licenses are designed to make sure that you
24have the freedom to distribute copies of free software (and charge for
25them if you wish), that you receive source code or can get it if you
26want it, that you can change the software or use pieces of it in new
27free programs, and that you know you can do these things.
28
29 To protect your rights, we need to prevent others from denying you
30these rights or asking you to surrender the rights. Therefore, you have
31certain responsibilities if you distribute copies of the software, or if
32you modify it: responsibilities to respect the freedom of others.
33
34 For example, if you distribute copies of such a program, whether
35gratis or for a fee, you must pass on to the recipients the same
36freedoms that you received. You must make sure that they, too, receive
37or can get the source code. And you must show them these terms so they
38know 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
42giving you legal permission to copy, distribute and/or modify it.
43
44 For the developers' and authors' protection, the GPL clearly explains
45that there is no warranty for this free software. For both users' and
46authors' sake, the GPL requires that modified versions be marked as
47changed, so that their problems will not be attributed erroneously to
48authors of previous versions.
49
50 Some devices are designed to deny users access to install or run
51modified versions of the software inside them, although the manufacturer
52can do so. This is fundamentally incompatible with the aim of
53protecting users' freedom to change the software. The systematic
54pattern of such abuse occurs in the area of products for individuals to
55use, which is precisely where it is most unacceptable. Therefore, we
56have designed this version of the GPL to prohibit the practice for those
57products. If such problems arise substantially in other domains, we
58stand ready to extend this provision to those domains in future versions
59of the GPL, as needed to protect the freedom of users.
60
61 Finally, every program is threatened constantly by software patents.
62States should not allow patents to restrict development and use of
63software on general-purpose computers, but in those that do, we wish to
64avoid the special danger that patents applied to a free program could
65make it effectively proprietary. To prevent this, the GPL assures that
66patents cannot be used to render the program non-free.
67
68 The precise terms and conditions for copying, distribution and
69modification 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
78works, such as semiconductor masks.
79
80 "The Program" refers to any copyrightable work licensed under this
81License. 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
85in a fashion requiring copyright permission, other than the making of an
86exact copy. The resulting work is called a "modified version" of the
87earlier work or a work "based on" the earlier work.
88
89 A "covered work" means either the unmodified Program or a work based
90on the Program.
91
92 To "propagate" a work means to do anything with it that, without
93permission, would make you directly or secondarily liable for
94infringement under applicable copyright law, except executing it on a
95computer or modifying a private copy. Propagation includes copying,
96distribution (with or without modification), making available to the
97public, and in some countries other activities as well.
98
99 To "convey" a work means any kind of propagation that enables other
100parties to make or receive copies. Mere interaction with a user through
101a computer network, with no transfer of a copy, is not conveying.
102
103 An interactive user interface displays "Appropriate Legal Notices"
104to the extent that it includes a convenient and prominently visible
105feature that (1) displays an appropriate copyright notice, and (2)
106tells the user that there is no warranty for the work (except to the
107extent that warranties are provided), that licensees may convey the
108work under this License, and how to view a copy of this License. If
109the interface presents a list of user commands or options, such as a
110menu, 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
115for making modifications to it. "Object code" means any non-source
116form of a work.
117
118 A "Standard Interface" means an interface that either is an official
119standard defined by a recognized standards body, or, in the case of
120interfaces specified for a particular programming language, one that
121is widely used among developers working in that language.
122
123 The "System Libraries" of an executable work include anything, other
124than the work as a whole, that (a) is included in the normal form of
125packaging a Major Component, but which is not part of that Major
126Component, and (b) serves only to enable use of the work with that
127Major Component, or to implement a Standard Interface for which an
128implementation 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
132produce 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
135the source code needed to generate, install, and (for an executable
136work) run the object code and to modify the work, including scripts to
137control those activities. However, it does not include the work's
138System Libraries, or general-purpose tools or generally available free
139programs which are used unmodified in performing those activities but
140which are not part of the work. For example, Corresponding Source
141includes interface definition files associated with source files for
142the work, and the source code for shared libraries and dynamically
143linked subprograms that the work is specifically designed to require,
144such as by intimate data communication or control flow between those
145subprograms and other parts of the work.
146
147 The Corresponding Source need not include anything that users
148can regenerate automatically from other parts of the Corresponding
149Source.
150
151 The Corresponding Source for a work in source code form is that
152same work.
153
154 2. Basic Permissions.
155
156 All rights granted under this License are granted for the term of
157copyright on the Program, and are irrevocable provided the stated
158conditions are met. This License explicitly affirms your unlimited
159permission to run the unmodified Program. The output from running a
160covered work is covered by this License only if the output, given its
161content, constitutes a covered work. This License acknowledges your
162rights 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
165convey, without conditions so long as your license otherwise remains
166in force. You may convey covered works to others for the sole purpose
167of having them make modifications exclusively for you, or provide you
168with facilities for running those works, provided that you comply with
169the terms of this License in conveying all material for which you do
170not control copyright. Those thus making or running the covered works
171for you must do so exclusively on your behalf, under your direction
172and control, on terms that prohibit them from making any copies of
173your copyrighted material outside their relationship with you.
174
175 Conveying under any other circumstances is permitted solely under
176the conditions stated below. Sublicensing is not allowed; section 10
177makes 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
182measure under any applicable law fulfilling obligations under article
18311 of the WIPO copyright treaty adopted on 20 December 1996, or
184similar laws prohibiting or restricting circumvention of such
185measures.
186
187 When you convey a covered work, you waive any legal power to forbid
188circumvention of technological measures to the extent such circumvention
189is effected by exercising rights under this License with respect to
190the covered work, and you disclaim any intention to limit operation or
191modification of the work as a means of enforcing, against the work's
192users, your or third parties' legal rights to forbid circumvention of
193technological measures.
194
195 4. Conveying Verbatim Copies.
196
197 You may convey verbatim copies of the Program's source code as you
198receive it, in any medium, provided that you conspicuously and
199appropriately publish on each copy an appropriate copyright notice;
200keep intact all notices stating that this License and any
201non-permissive terms added in accord with section 7 apply to the code;
202keep intact all notices of the absence of any warranty; and give all
203recipients 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,
206and 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
211produce it from the Program, in the form of source code under the
212terms 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
236works, which are not by their nature extensions of the covered work,
237and which are not combined with it such as to form a larger program,
238in or on a volume of a storage or distribution medium, is called an
239"aggregate" if the compilation and its resulting copyright are not
240used to limit the access or legal rights of the compilation's users
241beyond what the individual works permit. Inclusion of a covered work
242in an aggregate does not cause this License to apply to the other
243parts 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
248of sections 4 and 5, provided that you also convey the
249machine-readable Corresponding Source under the terms of this License,
250in 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
294from the Corresponding Source as a System Library, need not be
295included in conveying the object code work.
296
297 A "User Product" is either (1) a "consumer product", which means any
298tangible personal property which is normally used for personal, family,
299or household purposes, or (2) anything designed or sold for incorporation
300into a dwelling. In determining whether a product is a consumer product,
301doubtful cases shall be resolved in favor of coverage. For a particular
302product received by a particular user, "normally used" refers to a
303typical or common use of that class of product, regardless of the status
304of the particular user or of the way in which the particular user
305actually uses, or expects or is expected to use, the product. A product
306is a consumer product regardless of whether the product has substantial
307commercial, industrial or non-consumer uses, unless such uses represent
308the only significant mode of use of the product.
309
310 "Installation Information" for a User Product means any methods,
311procedures, authorization keys, or other information required to install
312and execute modified versions of a covered work in that User Product from
313a modified version of its Corresponding Source. The information must
314suffice to ensure that the continued functioning of the modified object
315code is in no case prevented or interfered with solely because
316modification has been made.
317
318 If you convey an object code work under this section in, or with, or
319specifically for use in, a User Product, and the conveying occurs as
320part of a transaction in which the right of possession and use of the
321User Product is transferred to the recipient in perpetuity or for a
322fixed term (regardless of how the transaction is characterized), the
323Corresponding Source conveyed under this section must be accompanied
324by the Installation Information. But this requirement does not apply
325if neither you nor any third party retains the ability to install
326modified object code on the User Product (for example, the work has
327been installed in ROM).
328
329 The requirement to provide Installation Information does not include a
330requirement to continue to provide support service, warranty, or updates
331for a work that has been modified or installed by the recipient, or for
332the User Product in which it has been modified or installed. Access to a
333network may be denied when the modification itself materially and
334adversely affects the operation of the network or violates the rules and
335protocols for communication across the network.
336
337 Corresponding Source conveyed, and Installation Information provided,
338in accord with this section must be in a format that is publicly
339documented (and with an implementation available to the public in
340source code form), and must require no special password or key for
341unpacking, reading or copying.
342
343 7. Additional Terms.
344
345 "Additional permissions" are terms that supplement the terms of this
346License by making exceptions from one or more of its conditions.
347Additional permissions that are applicable to the entire Program shall
348be treated as though they were included in this License, to the extent
349that they are valid under applicable law. If additional permissions
350apply only to part of the Program, that part may be used separately
351under those permissions, but the entire Program remains governed by
352this License without regard to the additional permissions.
353
354 When you convey a copy of a covered work, you may at your option
355remove any additional permissions from that copy, or from any part of
356it. (Additional permissions may be written to require their own
357removal in certain cases when you modify the work.) You may place
358additional permissions on material, added by you to a covered work,
359for which you have or can give appropriate copyright permission.
360
361 Notwithstanding any other provision of this License, for material you
362add to a covered work, you may (if authorized by the copyright holders of
363that 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
389restrictions" within the meaning of section 10. If the Program as you
390received it, or any part of it, contains a notice stating that it is
391governed by this License along with a term that is a further
392restriction, you may remove that term. If a license document contains
393a further restriction but permits relicensing or conveying under this
394License, you may add to a covered work material governed by the terms
395of that license document, provided that the further restriction does
396not survive such relicensing or conveying.
397
398 If you add terms to a covered work in accord with this section, you
399must place, in the relevant source files, a statement of the
400additional terms that apply to those files, or a notice indicating
401where to find the applicable terms.
402
403 Additional terms, permissive or non-permissive, may be stated in the
404form of a separately written license, or stated as exceptions;
405the above requirements apply either way.
406
407 8. Termination.
408
409 You may not propagate or modify a covered work except as expressly
410provided under this License. Any attempt otherwise to propagate or
411modify it is void, and will automatically terminate your rights under
412this License (including any patent licenses granted under the third
413paragraph of section 11).
414
415 However, if you cease all violation of this License, then your
416license from a particular copyright holder is reinstated (a)
417provisionally, unless and until the copyright holder explicitly and
418finally terminates your license, and (b) permanently, if the copyright
419holder fails to notify you of the violation by some reasonable means
420prior to 60 days after the cessation.
421
422 Moreover, your license from a particular copyright holder is
423reinstated permanently if the copyright holder notifies you of the
424violation by some reasonable means, this is the first time you have
425received notice of violation of this License (for any work) from that
426copyright holder, and you cure the violation prior to 30 days after
427your receipt of the notice.
428
429 Termination of your rights under this section does not terminate the
430licenses of parties who have received copies or rights from you under
431this License. If your rights have been terminated and not permanently
432reinstated, you do not qualify to receive new licenses for the same
433material 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
438run a copy of the Program. Ancillary propagation of a covered work
439occurring solely as a consequence of using peer-to-peer transmission
440to receive a copy likewise does not require acceptance. However,
441nothing other than this License grants you permission to propagate or
442modify any covered work. These actions infringe copyright if you do
443not accept this License. Therefore, by modifying or propagating a
444covered 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
449receives a license from the original licensors, to run, modify and
450propagate that work, subject to this License. You are not responsible
451for enforcing compliance by third parties with this License.
452
453 An "entity transaction" is a transaction transferring control of an
454organization, or substantially all assets of one, or subdividing an
455organization, or merging organizations. If propagation of a covered
456work results from an entity transaction, each party to that
457transaction who receives a copy of the work also receives whatever
458licenses to the work the party's predecessor in interest had or could
459give under the previous paragraph, plus a right to possession of the
460Corresponding Source of the work from the predecessor in interest, if
461the predecessor has it or can get it with reasonable efforts.
462
463 You may not impose any further restrictions on the exercise of the
464rights granted or affirmed under this License. For example, you may
465not impose a license fee, royalty, or other charge for exercise of
466rights granted under this License, and you may not initiate litigation
467(including a cross-claim or counterclaim in a lawsuit) alleging that
468any patent claim is infringed by making, using, selling, offering for
469sale, 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
474License of the Program or a work on which the Program is based. The
475work thus licensed is called the contributor's "contributor version".
476
477 A contributor's "essential patent claims" are all patent claims
478owned or controlled by the contributor, whether already acquired or
479hereafter acquired, that would be infringed by some manner, permitted
480by this License, of making, using, or selling its contributor version,
481but do not include claims that would be infringed only as a
482consequence of further modification of the contributor version. For
483purposes of this definition, "control" includes the right to grant
484patent sublicenses in a manner consistent with the requirements of
485this License.
486
487 Each contributor grants you a non-exclusive, worldwide, royalty-free
488patent license under the contributor's essential patent claims, to
489make, use, sell, offer for sale, import and otherwise run, modify and
490propagate the contents of its contributor version.
491
492 In the following three paragraphs, a "patent license" is any express
493agreement or commitment, however denominated, not to enforce a patent
494(such as an express permission to practice a patent or covenant not to
495sue for patent infringement). To "grant" such a patent license to a
496party means to make such an agreement or commitment not to enforce a
497patent against the party.
498
499 If you convey a covered work, knowingly relying on a patent license,
500and the Corresponding Source of the work is not available for anyone
501to copy, free of charge and under the terms of this License, through a
502publicly available network server or other readily accessible means,
503then you must either (1) cause the Corresponding Source to be so
504available, or (2) arrange to deprive yourself of the benefit of the
505patent license for this particular work, or (3) arrange, in a manner
506consistent with the requirements of this License, to extend the patent
507license to downstream recipients. "Knowingly relying" means you have
508actual knowledge that, but for the patent license, your conveying the
509covered work in a country, or your recipient's use of the covered work
510in a country, would infringe one or more identifiable patents in that
511country that you have reason to believe are valid.
512
513 If, pursuant to or in connection with a single transaction or
514arrangement, you convey, or propagate by procuring conveyance of, a
515covered work, and grant a patent license to some of the parties
516receiving the covered work authorizing them to use, propagate, modify
517or convey a specific copy of the covered work, then the patent license
518you grant is automatically extended to all recipients of the covered
519work and works based on it.
520
521 A patent license is "discriminatory" if it does not include within
522the scope of its coverage, prohibits the exercise of, or is
523conditioned on the non-exercise of one or more of the rights that are
524specifically granted under this License. You may not convey a covered
525work if you are a party to an arrangement with a third party that is
526in the business of distributing software, under which you make payment
527to the third party based on the extent of your activity of conveying
528the work, and under which the third party grants, to any of the
529parties who would receive the covered work from you, a discriminatory
530patent license (a) in connection with copies of the covered work
531conveyed by you (or copies made from those copies), or (b) primarily
532for and in connection with specific products or compilations that
533contain the covered work, unless you entered into that arrangement,
534or that patent license was granted, prior to 28 March 2007.
535
536 Nothing in this License shall be construed as excluding or limiting
537any implied license or other defenses to infringement that may
538otherwise 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
543otherwise) that contradict the conditions of this License, they do not
544excuse you from the conditions of this License. If you cannot convey a
545covered work so as to satisfy simultaneously your obligations under this
546License and any other pertinent obligations, then as a consequence you may
547not convey it at all. For example, if you agree to terms that obligate you
548to collect a royalty for further conveying from those to whom you convey
549the Program, the only way you could satisfy both those terms and this
550License 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
555permission to link or combine any covered work with a work licensed
556under version 3 of the GNU Affero General Public License into a single
557combined work, and to convey the resulting work. The terms of this
558License will continue to apply to the part which is the covered work,
559but the special requirements of the GNU Affero General Public License,
560section 13, concerning interaction through a network will apply to the
561combination as such.
562
563 14. Revised Versions of this License.
564
565 The Free Software Foundation may publish revised and/or new versions of
566the GNU General Public License from time to time. Such new versions will
567be similar in spirit to the present version, but may differ in detail to
568address new problems or concerns.
569
570 Each version is given a distinguishing version number. If the
571Program specifies that a certain numbered version of the GNU General
572Public License "or any later version" applies to it, you have the
573option of following the terms and conditions either of that numbered
574version or of any later version published by the Free Software
575Foundation. If the Program does not specify a version number of the
576GNU General Public License, you may choose any version ever published
577by the Free Software Foundation.
578
579 If the Program specifies that a proxy can decide which future
580versions of the GNU General Public License can be used, that proxy's
581public statement of acceptance of a version permanently authorizes you
582to choose that version for the Program.
583
584 Later license versions may give you additional or different
585permissions. However, no additional obligations are imposed on any
586author or copyright holder as a result of your choosing to follow a
587later version.
588
589 15. Disclaimer of Warranty.
590
591 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598ALL 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
603WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610SUCH DAMAGES.
611
612 17. Interpretation of Sections 15 and 16.
613
614 If the disclaimer of warranty and limitation of liability provided
615above cannot be given local legal effect according to their terms,
616reviewing courts shall apply local law that most closely approximates
617an absolute waiver of all civil liability in connection with the
618Program, unless a warranty or assumption of liability accompanies a
619copy 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
626possible use to the public, the best way to achieve this is to make it
627free 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
630to attach them to the start of each source file to most effectively
631state the exclusion of warranty; and each file should have at least
632the "copyright" line and a pointer to where the full notice is found.
633
634 <one line to give the program's name and a brief idea of what it does.>
635 Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
649
650Also 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
653notice like this when it starts in an interactive mode:
654
655 <program> Copyright (C) <year> <name of author>
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
660The hypothetical commands `show w' and `show c' should show the appropriate
661parts of the General Public License. Of course, your program's commands
662might 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,
665if any, to sign a "copyright disclaimer" for the program, if necessary.
666For more information on this, and how to apply and follow the GNU GPL, see
667<https://www.gnu.org/licenses/>.
668
669 The GNU General Public License does not permit incorporating your program
670into proprietary programs. If your program is a subroutine library, you
671may consider it more useful to permit linking proprietary applications with
672the library. If this is what you want to do, use the GNU Lesser General
673Public License instead of this License. But first, please read
674<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..baf5881
--- /dev/null
+++ b/README.md
@@ -0,0 +1,127 @@
1# Neovim Tasks
2
3A Neovim 0.7+ plugin that provides a statefull task system focused on integration with build systems.
4
5Tasks 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.
6
7## Dependencies
8
9- Necessary
10 - [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) for internal helpers.
11- Optional
12 - [nvim-dap](https://github.com/mfussenegger/nvim-dap) - for debugging.
13
14## Features
15
16- Output directly into quickfix for fast navigation.
17- Tasks provided by modules which can have custom parameters.
18- Modules are lazy loaded.
19- Module for a task name could be determined automatically based on its condition.
20- Tasks can run through debugger.
21- Tasks can be chained and react on the previous output.
22- Task and module parameters are serializable and specific to the current working directly.
23- Tasks arguments could be read from parameters and / or extended via additional temporary arguments passed to `:Task` command.
24
25## Available modules
26
27- [CMake](https://cmake.org) via [cmake-file-api](https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html#codemodel-version-2).
28- [Cargo](https://doc.rust-lang.org/cargo).
29
30You can also write [your own module](#modules-creation-and-configuration).
31
32## Commands
33
34Use the command `:Task` with one of the following arguments:
35
36| Argument(s) | Description |
37| ---------------------------------------- | ---------------------------------------------------------------------------- |
38| `start <module> <task>` | Starting a task from a module. |
39| `set_module_param <module> <param>` | Set parameter for a module. All parameters are module-specific. |
40| `set_task_param <module> <param> <task>` | Set parameter for a task from a module. The parameter can be `arg` or `env`. |
41| `cancel` | Cancel currently running task. |
42
43Modules and tasks will be autocompleted.
44
45Module name can be `auto`, in which case the first module that satisfies the condition will be used.
46
47## Configuration
48
49To 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:
50
51```lua
52local Path = require('plenary.path')
53require('tasks').setup({
54 default_params = { -- Default module parameters with which `neovim.json` will be created.
55 cmake = {
56 cmd = 'cmake', -- CMake executable to use, can be changed using `:Task set_module_param cmake cmd`.
57 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.
58 build_type = 'Debug', -- Build type, can be changed using `:Task set_module_param cmake build_type`.
59 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.
60 args = { -- Task default arguments.
61 configure = { '-D', 'CMAKE_EXPORT_COMPILE_COMMANDS=1', '-G', 'Ninja' },
62 },
63 },
64 },
65 save_before_run = true, -- If true, all files will be saved before executing a task.
66 params_file = 'neovim.json', -- JSON file to store module and task parameters.
67 quickfix = {
68 pos = 'botright', -- Default quickfix position.
69 height = 12, -- Default height.
70 },
71 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
72```
73
74## Usage examples
75
76### CMake
77
781. Open a CMake project.
792. Run `configuration` task using `:Task start cmake configure`.
803. 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.
814. Optionally set arguments using `:Task set_task_param cmake run`.
825. 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.
83
84### Cargo
85
861. Open a Cargo project.
872. Optionally set arguments using `:Task set_task_param cargo run`.
883. Optionally set global cargo arguments using `:Task set_task_param cargo global_cargo_args`.
894. Build and run the project via `:Task start cargo run` or build and debug using `:Task start cargo debug`.
90
91Cargo 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.
92
93## Modules creation and configuration
94
95To 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:
96
97```lua
98{
99 params = {
100 -- A table of parameter names. Possible values:
101 'parameter_name1', -- A string parameter, on setting user will be prompted with vim.ui.input.
102 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.
103 parameter_name3 = func, -- A function that generates a string or a table.
104 }
105 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.
106 tasks = {
107 -- A table of module tasks. Possible values:
108 task_name1 = {
109 -- Required parameters:
110 cmd = 'command' -- Command to execute.
111 -- Optional parameters:
112 cwd = 'directory' -- Command working directory. Default to current working directory.
113 after_success = callback -- A callback to execute on success.
114 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.
115 -- 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.
116 ignore_stdout = true,
117 ignore_stderr = true,
118 },
119 task_name2 = func1, -- A function that returns a table as above. Accepts configuration for this module and previous job.
120 task_name3 = { func2, func3 }, -- A list of functions as above. Tasks will be executed in chain.
121 }
122}
123```
124
125For a more complex example take a look at [cargo.lua](lua/tasks/module/cargo.lua).
126
127You 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 @@
1local Path = require('plenary.path')
2
3local config = {
4 defaults = {
5 default_params = {
6 cmake = {
7 cmd = 'cmake',
8 build_dir = tostring(Path:new('{cwd}', 'build', '{os}-{build_type}')),
9 build_type = 'Debug',
10 dap_name = 'lldb',
11 args = {
12 configure = { '-D', 'CMAKE_EXPORT_COMPILE_COMMANDS=1', '-G', 'Ninja' },
13 },
14 },
15 cargo = {
16 dap_name = 'lldb',
17 },
18 },
19 save_before_run = true,
20 params_file = 'neovim.json',
21 quickfix = {
22 pos = 'botright',
23 height = 12,
24 only_on_error = false,
25 },
26 dap_open_command = function() return require('dap').repl.open() end,
27 },
28}
29
30setmetatable(config, { __index = config.defaults })
31
32return 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 @@
1local constants = {
2 task_params = { 'args', 'env' }, -- Parameters available for all tasks
3}
4
5return 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 @@
1local config = require('tasks.config')
2local runner = require('tasks.runner')
3local constants = require('tasks.constants')
4local utils = require('tasks.utils')
5local ProjectConfig = require('tasks.project_config')
6local tasks = {}
7
8--- Apply user settings.
9---@param values table
10function tasks.setup(values) setmetatable(config, { __index = vim.tbl_deep_extend('force', config.defaults, values) }) end
11
12--- Execute a task from a module.
13---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition.
14---@param task_name string
15---@vararg string additional arguments that will be passed to the last task.
16function tasks.start(module_type, task_name, ...)
17 local current_job_name = runner.get_current_job_name()
18 if current_job_name then
19 utils.notify(string.format('Another job is currently running: "%s"', current_job_name), vim.log.levels.ERROR)
20 return
21 end
22
23 local module, module_name = utils.get_module(module_type)
24 if not module then
25 return
26 end
27
28 local commands = module.tasks[task_name]
29 if not commands then
30 utils.notify(string.format('Unable to find a task named "%s" in module "%s"', task_name, module_name), vim.log.levels.ERROR)
31 return
32 end
33
34 if config.save_before_run then
35 vim.api.nvim_command('silent! wall')
36 end
37
38 local project_config = ProjectConfig.new()
39 local module_config = project_config[module_name]
40 if not vim.tbl_islist(commands) then
41 commands = { commands }
42 end
43 runner.chain_commands(task_name, commands, module_config, { ... })
44end
45
46--- Set a module-specific parameter. Settings will be stored on disk.
47---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition.
48---@param param_name string
49function tasks.set_module_param(module_type, param_name)
50 local module, module_name = utils.get_module(module_type)
51 if not module then
52 return
53 end
54
55 if not module then
56 return
57 end
58
59 local project_config = ProjectConfig.new()
60 local current_value = vim.tbl_get(project_config, module_name, param_name)
61
62 local param = module.params[param_name]
63 if not param then
64 if vim.tbl_contains(module.params, param_name) then
65 -- Contains a string without a value, request for input
66 vim.ui.input({ prompt = string.format('Set "%s" for module "%s"', param_name, module_name), default = current_value }, function(input)
67 project_config[module_name][param_name] = input
68 project_config:write()
69 end)
70 else
71 utils.notify(string.format('No such parameter "%s" for module "%s"', param_name, module_name), vim.log.levels.ERROR)
72 end
73 return
74 end
75
76 if vim.is_callable(param) then
77 param = param()
78 if not param then
79 return
80 end
81 end
82
83 -- Put current value first
84 if current_value then
85 for index, value in ipairs(param) do
86 if value == current_value then
87 table.remove(param, index)
88 break
89 end
90 end
91 table.insert(param, 1, current_value)
92 end
93
94 vim.ui.select(param, { prompt = string.format('Select "%s"', param_name) }, function(choice, idx)
95 if not idx then
96 return
97 end
98 if not project_config[module_name] then
99 project_config[module_name] = {}
100 end
101 project_config[module_name][param_name] = choice
102 project_config:write()
103 end)
104end
105
106--- Set a parameter for a module task. Settings will be stored on disk.
107---@param module_type string: Name of a module or `auto` string to pick a first module that match a condition.
108---@param task_name string
109---@param param_name string
110function tasks.set_task_param(module_type, task_name, param_name)
111 local module, module_name = utils.get_module(module_type)
112 if not module then
113 return
114 end
115 if not vim.tbl_contains(constants.task_params, param_name) then
116 utils.notify(string.format('Unknown task parameter "%s"\nAvailable task parameters: %s', param_name, table.concat(constants.task_params, ', ')), vim.log.levels.ERROR)
117 return
118 end
119
120 local project_config = ProjectConfig.new()
121 local current_value = vim.tbl_get(project_config, module_name, param_name, task_name)
122 current_value = current_value and utils.join_args(current_value) or ''
123 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)
124 if not project_config[module_name] then
125 project_config[module_name] = {}
126 end
127 if not project_config[module_name][param_name] then
128 project_config[module_name][param_name] = {}
129 end
130 project_config[module_name][param_name][task_name] = utils.split_args(input)
131 project_config:write()
132 end)
133end
134
135--- Cancel last current task.
136function tasks.cancel()
137 if not runner.cancel_job() then
138 utils.notify('No running process')
139 end
140end
141
142return 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 @@
1local utils = require('tasks.utils')
2local Job = require('plenary.job')
3local Path = require('plenary.path')
4local cargo = {}
5
6-- Modified version of `errorformat` from the official Rust plugin for Vim:
7-- https://github.com/rust-lang/rust.vim/blob/4aa69b84c8a58fcec6b6dad6fe244b916b1cf830/compiler/rustc.vim#L32
8-- https://github.com/rust-lang/rust.vim/blob/4aa69b84c8a58fcec6b6dad6fe244b916b1cf830/compiler/cargo.vim#L35
9-- We display all lines (not only error messages) since we show output in quickfix.
10-- Zero-width look-ahead regex is used to avoid marking general messages as errors: %\%%(ignored text%\)%\@!.
11local errorformat = [[%Eerror: %\%%(aborting %\|could not compile%\)%\@!%m,]]
12 .. [[%Eerror[E%n]: %m,]]
13 .. [[%Inote: %m,]]
14 .. [[%Wwarning: %\%%(%.%# warning%\)%\@!%m,]]
15 .. [[%C %#--> %f:%l:%c,]]
16 .. [[%E left:%m,%C right:%m %f:%l:%c,%Z,]]
17 .. [[%.%#panicked at \'%m\'\, %f:%l:%c]]
18
19--- Detects package name from command line arguments.
20---@param args table
21---@return string?
22local function detect_package_name(args)
23 for index, value in ipairs(args) do
24 if value == '-p' or value == '--package' or value == '--bin' then
25 return args[index + 1]
26 end
27 end
28 return nil
29end
30
31--- Returns only a packages that can be executed.
32---@param packages table: Packages to filter.
33---@return table
34local function find_executable_packages(packages)
35 local executables = {}
36 for _, line in pairs(packages) do
37 local package = vim.json.decode(line)
38 if package.executable and package.executable ~= vim.NIL then
39 table.insert(executables, package)
40 end
41 end
42 return executables
43end
44
45--- Finds executable package name from a list of packages.
46---@param packages table
47---@param args table?: Command line arguments that will be used to detect an executable if JSON message from cargo is missing this info.
48---@return table?
49local function get_executable_package(packages, args)
50 local executable_packages = find_executable_packages(packages)
51 if #executable_packages == 1 then
52 return executable_packages[1]
53 end
54
55 -- Try to detect package name from arguments
56 local package_name = detect_package_name(args or {})
57 if not package_name then
58 local available_names = {}
59 for _, package in ipairs(executable_packages) do
60 table.insert(available_names, package.target.name)
61 end
62 utils.notify(
63 'Could not determine which binary to run\nUse the "--bin" or "--package" option to specify a binary\nAvailable binaries: ' .. table.concat(available_names, ', '),
64 vim.log.levels.ERROR
65 )
66 return nil
67 end
68
69 for _, package in ipairs(executable_packages) do
70 if package.target.name == package_name then
71 return package
72 end
73 end
74
75 utils.notify(string.format('Unable to find package named "%s"', package_name), vim.log.levels.ERROR)
76 return nil
77end
78
79---@return table: List of functions for each cargo subcommand that return a task table.
80local function get_cargo_subcommands()
81 local cargo_subcommands = {}
82
83 local job = Job:new({
84 command = 'cargo',
85 args = { '--list' },
86 enabled_recording = true,
87 })
88 job:sync()
89
90 if job.code ~= 0 or job.signal ~= 0 then
91 utils.notify('Unable to get list of available cargo subcommands', vim.log.levels.ERROR)
92 return {}
93 end
94
95 local start_offset = 5
96 for index, line in ipairs(job:result()) do
97 if index ~= 1 and not line:find('alias:') then
98 local subcommand_end = line:find(' ', start_offset)
99 local subcommand = line:sub(start_offset, subcommand_end and subcommand_end - 1 or nil)
100 cargo_subcommands[subcommand] =
101 function(module_config, _) return { cmd = 'cargo', args = vim.list_extend({ subcommand }, utils.split_args(module_config.global_cargo_args)), errorformat = errorformat } end
102 end
103 end
104
105 return cargo_subcommands
106end
107
108--- Task
109---@return table?
110local function build_test(module_config, _)
111 return {
112 cmd = 'cargo',
113 args = vim.list_extend({ 'test', '--no-run', '--message-format=json' }, utils.split_args(module_config.global_cargo_args)),
114 errorformat = errorformat,
115 ignore_stdout = true,
116 }
117end
118
119--- Task
120---@param module_config table
121---@param previous_job table
122---@return table?
123local function debug_test(module_config, previous_job)
124 local package = get_executable_package(previous_job:result(), vim.tbl_get(module_config, 'args', 'debug_test'))
125 if not package then
126 return
127 end
128
129 return {
130 cmd = package.executable,
131 dap_name = module_config.dap_name,
132 errorformat = errorformat,
133 }
134end
135
136--- Task
137---@param module_config table
138---@return table?
139local function build(module_config, _)
140 return {
141 cmd = 'cargo',
142 args = vim.list_extend({ 'build', '--message-format=json' }, utils.split_args(module_config.global_cargo_args)),
143 ignore_stdout = true,
144 }
145end
146
147--- Task
148---@param module_config table
149---@param previous_job table
150---@return table?
151local function debug(module_config, previous_job)
152 local package = get_executable_package(previous_job:result(), vim.tbl_get(module_config, 'args', 'debug'))
153 if not package then
154 return
155 end
156
157 return {
158 cmd = package.executable,
159 dap_name = module_config.dap_name,
160 errorformat = errorformat,
161 }
162end
163
164cargo.params = {
165 'dap_name',
166 'global_cargo_args',
167}
168cargo.condition = function() return Path:new('Cargo.toml'):exists() end
169cargo.tasks = vim.tbl_extend('force', get_cargo_subcommands(), { debug_test = { build_test, debug_test }, debug = { build, debug } })
170
171return 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 @@
1local Path = require('plenary.path')
2local utils = require('tasks.utils')
3local scandir = require('plenary.scandir')
4local ProjectConfig = require('tasks.project_config')
5local os = require('ffi').os:lower()
6local cmake = {}
7
8--- Parses build dir expression.
9---@param dir string: Path with expressions to replace.
10---@param build_type string
11---@return table
12local function parse_dir(dir, build_type)
13 local parsed_dir = dir:gsub('{cwd}', vim.loop.cwd())
14 parsed_dir = parsed_dir:gsub('{os}', os)
15 parsed_dir = parsed_dir:gsub('{build_type}', build_type:lower())
16 return Path:new(parsed_dir)
17end
18
19--- Returns reply directory that contains targets information.
20---@param build_dir table
21---@return unknown
22local function get_reply_dir(build_dir) return build_dir / '.cmake' / 'api' / 'v1' / 'reply' end
23
24--- Reads information about target.
25---@param codemodel_target table
26---@param reply_dir table
27---@return table
28local function get_target_info(codemodel_target, reply_dir) return vim.json.decode((reply_dir / codemodel_target['jsonFile']):read()) end
29
30--- Creates query files that to acess information about targets after CMake configuration.
31---@param build_dir table
32---@return boolean: Returns `true` on success.
33local function make_query_files(build_dir)
34 local query_dir = build_dir / '.cmake' / 'api' / 'v1' / 'query'
35 if not query_dir:mkdir({ parents = true }) then
36 utils.notify(string.format('Unable to create "%s"', query_dir.filename), vim.log.levels.ERROR)
37 return false
38 end
39
40 local codemodel_file = query_dir / 'codemodel-v2'
41 if not codemodel_file:is_file() then
42 if not codemodel_file:touch() then
43 utils.notify(string.format('Unable to create "%s"', codemodel_file.filename), vim.log.levels.ERROR)
44 return false
45 end
46 end
47 return true
48end
49
50--- Reads targets information.
51---@param reply_dir table
52---@return table?
53local function get_codemodel_targets(reply_dir)
54 local found_files = scandir.scan_dir(reply_dir.filename, { search_pattern = 'codemodel*' })
55 if #found_files == 0 then
56 utils.notify('Unable to find codemodel file', vim.log.levels.ERROR)
57 return nil
58 end
59 local codemodel = Path:new(found_files[1])
60 local codemodel_json = vim.json.decode(codemodel:read())
61 return codemodel_json['configurations'][1]['targets']
62end
63
64---@return table?
65local function get_target_names()
66 local project_config = ProjectConfig.new()
67 local build_dir = parse_dir(project_config.cmake.build_dir, project_config.cmake.build_type)
68 if not build_dir:is_dir() then
69 utils.notify(string.format('Build directory "%s" does not exist, you need to run "configure" task first', build_dir), vim.log.levels.ERROR)
70 return nil
71 end
72
73 local reply_dir = get_reply_dir(build_dir)
74 local codemodel_targets = get_codemodel_targets(reply_dir)
75 if not codemodel_targets then
76 return nil
77 end
78
79 local targets = {}
80 for _, target in ipairs(codemodel_targets) do
81 local target_info = get_target_info(target, reply_dir)
82 local target_name = target_info['name']
83 if target_name:find('_autogen') == nil then
84 table.insert(targets, target_name)
85 end
86 end
87
88 return targets
89end
90
91--- Finds path to an executable.
92---@param build_dir table
93---@param name string
94---@param reply_dir table
95---@return unknown?
96local function get_executable_path(build_dir, name, reply_dir)
97 for _, target in ipairs(get_codemodel_targets(reply_dir)) do
98 if name == target['name'] then
99 local target_info = get_target_info(target, reply_dir)
100 if target_info['type'] ~= 'EXECUTABLE' then
101 utils.notify(string.format('Specified target "%s" is not an executable', name), vim.log.levels.ERROR)
102 return nil
103 end
104
105 local target_path = Path:new(target_info['artifacts'][1]['path'])
106 if not target_path:is_absolute() then
107 target_path = build_dir / target_path
108 end
109
110 return target_path
111 end
112 end
113
114 utils.notify(string.format('Unable to find target named "%s"', name), vim.log.levels.ERROR)
115 return nil
116end
117
118--- Copies compile_commands.json file from build directory to the current working directory for LSP integration.
119local function copy_compile_commands()
120 local project_config = ProjectConfig.new()
121 local filename = 'compile_commands.json'
122 local source = parse_dir(project_config.cmake.build_dir, project_config.cmake.build_type) / filename
123 local destination = Path:new(vim.loop.cwd(), filename)
124 source:copy({ destination = destination.filename })
125end
126
127--- Task
128---@param module_config table
129---@return table?
130local function configure(module_config, _)
131 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
132 build_dir:mkdir({ parents = true })
133 if not make_query_files(build_dir) then
134 return nil
135 end
136
137 return {
138 cmd = module_config.cmd,
139 args = { '-B', build_dir.filename, '-D', 'CMAKE_BUILD_TYPE=' .. module_config.build_type },
140 after_success = copy_compile_commands,
141 }
142end
143
144--- Task
145---@param module_config table
146---@return table
147local function build(module_config, _)
148 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
149
150 local args = { '--build', build_dir.filename }
151 if module_config.target then
152 vim.list_extend(args, { '--target', module_config.target })
153 end
154
155 return {
156 cmd = module_config.cmd,
157 args = args,
158 after_success = copy_compile_commands,
159 }
160end
161
162--- Task
163---@param module_config table
164---@return table
165local function build_all(module_config, _)
166 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
167
168 return {
169 cmd = module_config.cmd,
170 args = { '--build', build_dir.filename },
171 after_success = copy_compile_commands,
172 }
173end
174
175--- Task
176---@param module_config table
177---@return table?
178local function run(module_config, _)
179 if not module_config.target then
180 utils.notify('No selected target, please set "target" parameter', vim.log.levels.ERROR)
181 return nil
182 end
183
184 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
185 if not build_dir:is_dir() then
186 utils.notify(string.format('Build directory "%s" does not exist, you need to run "configure" task first', build_dir), vim.log.levels.ERROR)
187 return nil
188 end
189
190 local target_path = get_executable_path(build_dir, module_config.target, get_reply_dir(build_dir))
191 if not target_path then
192 return
193 end
194
195 if not target_path:is_file() then
196 utils.notify(string.format('Selected target "%s" is not built', target_path.filename), vim.log.levels.ERROR)
197 return nil
198 end
199
200 return {
201 cmd = target_path.filename,
202 cwd = target_path:parent().filename,
203 }
204end
205
206--- Task
207---@param module_config table
208---@return table?
209local function debug(module_config, _)
210 if module_config.build_type ~= 'Debug' and module_config.build_type ~= 'RelWithDebInfo' then
211 utils.notify(
212 string.format('For debugging your "build_type" param should be set to "Debug" or "RelWithDebInfo", but your current build type is "%s"'),
213 module_config.build_type,
214 vim.log.levels.ERROR
215 )
216 return nil
217 end
218
219 local command = run(module_config, nil)
220 if not command then
221 return nil
222 end
223
224 command.dap_name = module_config.dap_name
225 return command
226end
227
228--- Task
229---@param module_config table
230---@return table
231local function clean(module_config, _)
232 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
233
234 return {
235 cmd = module_config.cmd,
236 args = { '--build', build_dir.filename, '--target', 'clean' },
237 after_success = copy_compile_commands,
238 }
239end
240
241--- Task
242---@param module_config table
243---@return table
244local function open_build_dir(module_config, _)
245 local build_dir = parse_dir(module_config.build_dir, module_config.build_type)
246
247 return {
248 cmd = os == 'windows' and 'start' or 'xdg-open',
249 args = { build_dir.filename },
250 ignore_stdout = true,
251 ignore_stderr = true,
252 }
253end
254
255cmake.params = {
256 target = get_target_names,
257 build_type = { 'Debug', 'Release', 'RelWithDebInfo', 'MinSizeRel' },
258 'cmake',
259 'dap_name',
260}
261cmake.condition = function() return Path:new('CMakeLists.txt'):exists() end
262cmake.tasks = {
263 configure = configure,
264 build = build,
265 build_all = build_all,
266 run = { build, run },
267 debug = debug,
268 clean = clean,
269 open_build_dir = open_build_dir,
270}
271
272return 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 @@
1local config = require('tasks.config')
2local Path = require('plenary.path')
3
4--- Contains all fields from configuration.
5---@class ProjectConfig
6local ProjectConfig = {}
7ProjectConfig.__index = ProjectConfig
8
9--- Reads project configuration JSON into a table.
10---@return ProjectConfig
11function ProjectConfig.new()
12 local project_config = {}
13 local params_file = Path:new(config.params_file)
14 if params_file:is_file() then
15 project_config = vim.json.decode(params_file:read())
16 else
17 project_config = {}
18 end
19 project_config = vim.tbl_extend('keep', project_config, config.default_params)
20 return setmetatable(project_config, ProjectConfig)
21end
22
23--- Writes all values as JSON to disk.
24function ProjectConfig:write()
25 local params_file = Path:new(config.params_file)
26 params_file:write(vim.json.encode(self), 'w')
27end
28
29return 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 @@
1local config = require('tasks.config')
2local Job = require('plenary.job')
3local runner = {}
4
5local last_job
6
7---@param lines table
8---@param errorformat string?
9local function append_to_quickfix(lines, errorformat)
10 vim.fn.setqflist({}, 'a', { efm = errorformat, lines = lines })
11 -- Scrolls the quickfix buffer if not active
12 if vim.bo.buftype ~= 'quickfix' then
13 vim.api.nvim_command('cbottom')
14 end
15end
16
17---@param errorformat? string
18---@return function: A coroutine that reads job data into quickfix.
19local function read_to_quickfix(errorformat)
20 -- Modified from https://github.com/nvim-lua/plenary.nvim/blob/968a4b9afec0c633bc369662e78f8c5db0eba249/lua/plenary/job.lua#L287
21 -- We use our own implementation to process data in chunks because
22 -- default Plenary callback processes every line which is very slow for adding to quickfix.
23 return coroutine.wrap(function(err, data, is_complete)
24 -- We repeat forever as a coroutine so that we can keep calling this.
25 local lines = {}
26 local result_index = 1
27 local result_line = nil
28 local found_newline = nil
29
30 while true do
31 if data then
32 data = data:gsub('\r', '')
33
34 local processed_index = 1
35 local data_length = #data + 1
36
37 repeat
38 local start = data:find('\n', processed_index, true) or data_length
39 local line = data:sub(processed_index, start - 1)
40 found_newline = start ~= data_length
41
42 -- Concat to last line if there was something there already.
43 -- This happens when "data" is broken into chunks and sometimes
44 -- the content is sent without any newlines.
45 if result_line then
46 result_line = result_line .. line
47
48 -- Only put in a new line when we actually have new data to split.
49 -- This is generally only false when we do end with a new line.
50 -- It prevents putting in a "" to the end of the results.
51 elseif start ~= processed_index or found_newline then
52 result_line = line
53
54 -- Otherwise, we don't need to do anything.
55 end
56
57 if found_newline then
58 if not result_line then
59 return vim.api.nvim_err_writeln('Broken data thing due to: ' .. tostring(result_line) .. ' ' .. tostring(data))
60 end
61
62 table.insert(lines, err and err or result_line)
63
64 result_index = result_index + 1
65 result_line = nil
66 end
67
68 processed_index = start + 1
69 until not found_newline
70 end
71
72 if is_complete and not found_newline then
73 table.insert(lines, err and err or result_line)
74 end
75
76 if #lines ~= 0 then
77 -- Move lines to another variable and send them to quickfix
78 local processed_lines = lines
79 lines = {}
80 vim.schedule(function() append_to_quickfix(processed_lines, errorformat) end)
81 end
82
83 if data == nil or is_complete then
84 return
85 end
86
87 err, data, is_complete = coroutine.yield()
88 end
89 end)
90end
91
92--- Run specified commands in chain.
93---@param task_name string: Name of a task to read properties.
94---@param commands table: Commands to chain.
95---@param module_config table: Module configuration.
96---@param addition_args table?: Additional arguments that will be applied to the last command.
97---@param previous_job table?: Previous job to read data from, used by this function for recursion.
98function runner.chain_commands(task_name, commands, module_config, addition_args, previous_job)
99 local command = commands[1]
100 if vim.is_callable(command) then
101 command = command(module_config, previous_job)
102 if not command then
103 return
104 end
105 end
106
107 local cwd = command.cwd or vim.loop.cwd()
108 local args = command.args and command.args or {}
109 local env = vim.tbl_extend('force', vim.loop.os_environ(), command.env and command.env or {})
110 if #commands == 1 then
111 -- Apply task parameters only to the last command
112 vim.list_extend(args, addition_args)
113 vim.list_extend(args, vim.tbl_get(module_config, 'args', task_name) or {})
114 env = vim.tbl_extend('force', env, vim.tbl_get(module_config, 'env', task_name) or {})
115 end
116
117 if command.dap_name then
118 vim.schedule(function()
119 local dap = require('dap')
120 local dap_config = dap.configurations[command.dap_name] -- Try to get an existing configuration
121 dap.run(vim.tbl_extend('force', dap_config and dap_config or { type = command.dap_name }, {
122 name = command.cmd,
123 request = 'launch',
124 program = command.cmd,
125 args = args,
126 }))
127 if config.dap_open_command then
128 vim.api.nvim_command('cclose')
129 config.dap_open_command()
130 end
131 last_job = dap
132 end)
133 return
134 end
135
136 local quickfix_output = not command.ignore_stdout and not command.ignore_stderr
137 local job = Job:new({
138 command = command.cmd,
139 args = args,
140 cwd = cwd,
141 env = env,
142 enable_recording = #commands ~= 1,
143 on_start = quickfix_output and vim.schedule_wrap(function()
144 vim.fn.setqflist({}, ' ', { title = command.cmd .. ' ' .. table.concat(args, ' ') })
145 vim.api.nvim_command(string.format('%s copen %d', config.quickfix.pos, config.quickfix.height))
146 vim.api.nvim_command('wincmd p')
147 end) or nil,
148 on_exit = vim.schedule_wrap(function(_, code, signal)
149 if quickfix_output then
150 append_to_quickfix({ 'Exited with code ' .. (signal == 0 and code or 128 + signal) })
151 end
152 if code == 0 and signal == 0 and command.after_success then
153 command.after_success()
154 end
155 end),
156 })
157
158 job:start()
159 if not command.ignore_stdout then
160 job.stdout:read_start(read_to_quickfix(command.errorformat))
161 end
162 if not command.ignore_stderr then
163 job.stderr:read_start(read_to_quickfix(command.errorformat))
164 end
165
166 if #commands ~= 1 then
167 job:after_success(function() runner.chain_commands(task_name, vim.list_slice(commands, 2), module_config, addition_args, job) end)
168 end
169 last_job = job
170end
171
172---@return string?
173function runner.get_current_job_name()
174 if not last_job then
175 return nil
176 end
177
178 -- Check if this job was run through debugger.
179 if last_job.session then
180 local session = last_job.session()
181 if not session then
182 return nil
183 end
184 return session.config.program
185 end
186
187 if last_job.is_shutdown then
188 return nil
189 end
190
191 return last_job.cmd
192end
193
194---@return boolean: `true` if a job was canceled or `false` if there is no active job.
195function runner.cancel_job()
196 if not last_job then
197 return false
198 end
199
200 -- Check if this job was run through debugger.
201 if last_job.session then
202 if not last_job.session() then
203 return false
204 end
205 last_job.terminate()
206 return true
207 end
208
209 if last_job.is_shutdown then
210 return false
211 end
212
213 last_job:shutdown(1, 9)
214
215 if vim.fn.has('win32') == 1 then
216 -- Kill all children.
217 for _, pid in ipairs(vim.api.nvim_get_proc_children(last_job.pid)) do
218 vim.loop.kill(pid, 9)
219 end
220 else
221 vim.loop.kill(last_job.pid, 9)
222 end
223 return true
224end
225
226return 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 @@
1local tasks = require('tasks')
2local utils = require('tasks.utils')
3local constants = require('tasks.constants')
4local subcommands = {}
5
6--- Completes `:Task` command.
7---@param arg string: Current argument under cursor.
8---@param cmd_line string: All arguments.
9---@return table: List of all commands matched with `arg`.
10function subcommands.complete(arg, cmd_line)
11 local matches = {}
12
13 local words = vim.split(cmd_line, ' ', { trimempty = true })
14 if not vim.endswith(cmd_line, ' ') then
15 -- Last word is not fully typed, don't count it
16 table.remove(words, #words)
17 end
18
19 if #words == 1 then
20 for subcommand in pairs(tasks) do
21 if vim.startswith(subcommand, arg) and subcommand ~= 'setup' then
22 table.insert(matches, subcommand)
23 end
24 end
25 elseif #words == 2 then
26 if words[2] == 'start' or words[2] == 'set_task_param' or words[2] == 'set_module_param' then
27 local module_names = utils.get_module_names()
28 table.insert(module_names, 'auto') -- Special value for automatic module detection
29 for _, module_name in ipairs(module_names) do
30 if vim.startswith(module_name, arg) then
31 table.insert(matches, module_name)
32 end
33 end
34 end
35 elseif #words == 3 then
36 if words[2] == 'start' or words[2] == 'set_task_param' or words[2] == 'set_module_param' then
37 local ok, module = pcall(require, 'tasks.module.' .. words[3])
38 if ok then
39 for key, value in pairs(words[2] == 'set_module_param' and module.params or module.tasks) do
40 local name = type(key) == 'number' and value or key -- Handle arrays
41 if vim.startswith(name, arg) then
42 table.insert(matches, name)
43 end
44 end
45 end
46 end
47 elseif #words == 4 then
48 if words[2] == 'set_task_param' then
49 for _, param_name in ipairs(constants.task_params) do
50 if vim.startswith(param_name, arg) then
51 table.insert(matches, param_name)
52 end
53 end
54 end
55 end
56
57 return matches
58end
59
60--- Run specified subcommand received from completion.
61---@param subcommand table
62function subcommands.run(subcommand)
63 local subcommand_func = tasks[subcommand.fargs[1]]
64 if not subcommand_func then
65 utils.notify(string.format('No such subcommand named "%s"', subcommand.fargs[1]), vim.log.levels.ERROR)
66 return
67 end
68 local subcommand_info = debug.getinfo(subcommand_func)
69 if subcommand_info.isvararg and #subcommand.fargs - 1 < subcommand_info.nparams then
70 utils.notify(string.format('Subcommand %s should have at least %s argument(s)', subcommand.fargs[1], subcommand_info.nparams + 1), vim.log.levels.ERROR)
71 return
72 elseif not subcommand_info.isvararg and #subcommand.fargs - 1 ~= subcommand_info.nparams then
73 utils.notify(string.format('Subcommand %s should have %s argument(s)', subcommand.fargs[1], subcommand_info.nparams + 1), vim.log.levels.ERROR)
74 return
75 end
76 subcommand_func(unpack(subcommand.fargs, 2))
77end
78
79return 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 @@
1local scandir = require('plenary.scandir')
2local Path = require('plenary.path')
3local utils = {}
4
5local args_regex = vim.regex([[\s\%(\%([^'"]*\(['"]\)[^'"]*\1\)*[^'"]*$\)\@=]])
6
7--- A small wrapper around `vim.notify` that adds plugin title.
8---@param msg string
9---@param log_level number
10function utils.notify(msg, log_level) vim.notify(msg, log_level, { title = 'Tasks' }) end
11
12--- Splits command line arguments respecting quotes.
13---@param args string?
14---@return table
15function utils.split_args(args)
16 if not args then
17 return {}
18 end
19
20 -- Split on spaces unless in quotes.
21 local splitted_args = {}
22 local match_beg
23 while true do
24 match_beg = args_regex:match_str(args)
25 if match_beg then
26 table.insert(splitted_args, args:sub(1, match_beg))
27 args = args:sub(match_beg + 2)
28 else
29 -- Insert last arg left.
30 table.insert(splitted_args, args)
31 break
32 end
33 end
34
35 -- Remove quotes
36 for i, arg in ipairs(splitted_args) do
37 splitted_args[i] = arg:gsub('"', ''):gsub("'", '')
38 end
39 return splitted_args
40end
41
42--- Joins command line arguments respecting spaces by putting double quotes around them.
43---@param args table?
44---@return string
45function utils.join_args(args)
46 if not args then
47 return ''
48 end
49
50 -- Add quotes if argument contain spaces
51 for index, arg in ipairs(args) do
52 if arg:find(' ') then
53 args[index] = '"' .. arg .. '"'
54 end
55 end
56
57 return table.concat(args, ' ')
58end
59
60---@return table
61function utils.get_module_names()
62 local module_dir = Path:new(debug.getinfo(1).source:sub(2)):parent() / 'module'
63
64 local modules = {}
65 for _, entry in ipairs(scandir.scan_dir(module_dir.filename, { depth = 1 })) do
66 -- Strip full path and extension
67 local extension_len = 4
68 local parent_offset = 2
69 table.insert(modules, entry:sub(#Path:new(entry):parent().filename + parent_offset, #entry - extension_len))
70 end
71
72 return modules
73end
74
75--- Find a module by name
76---@param module_type string name of a module or `auto` string to pick a first module that match a condition.
77---@return table?, string?: module and its name.
78function utils.get_module(module_type)
79 if module_type == 'auto' then
80 for _, name in ipairs(utils.get_module_names()) do
81 local module = require('tasks.module.' .. name)
82 if module.condition() then
83 return module, name
84 end
85 end
86
87 utils.notify('Unable to autodetect module for this working directory', vim.log.levels.ERROR)
88 return nil, nil
89 end
90
91 local module = require('tasks.module.' .. module_type)
92 if not module then
93 utils.notify('Unable to find a module named ' .. module_type, vim.log.levels.ERROR)
94 return nil, nil
95 end
96
97 return module, module_type
98end
99
100return 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 @@
1if vim.version().minor < 7 then
2 require('tasks.utils').notify('Neovim 0.7+ is required for tasks plugin', vim.log.levels.ERROR)
3 return
4end
5
6local subcommands = require('tasks.subcommands')
7
8vim.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 @@
1column_width = 200
2indent_type = 'Spaces'
3indent_width = 2
4quote_style = 'AutoPreferSingle'
5collapse_simple_statement = 'FunctionOnly'