commit 4addd3e668a112f765331b9d06e8049eab42505e Author: Bryan Date: Mon Sep 16 22:48:49 2024 -0600 Initial commit. Forked from https://github.com/LintaoAmons/cd-project.nvim/commit/d18efcb42a39bcbc12d4dd5544da0524696d3379 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6fd0a37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,41 @@ +# Compiled Lua sources +luac.out + +# luarocks build files +*.src.rock +*.zip +*.tar.gz + +# Object files +*.o +*.os +*.ko +*.obj +*.elf + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo +*.def +*.exp + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + diff --git a/.stylua.toml b/.stylua.toml new file mode 100644 index 0000000..9393cf9 --- /dev/null +++ b/.stylua.toml @@ -0,0 +1,5 @@ +column_width = 120 +line_endings = "Unix" +indent_type = "Spaces" +indent_width = 2 +quote_style = "AutoPreferDouble" diff --git a/HOOK_EXAMPLES.md b/HOOK_EXAMPLES.md new file mode 100644 index 0000000..820ff84 --- /dev/null +++ b/HOOK_EXAMPLES.md @@ -0,0 +1,19 @@ +## Print hint after switch project + +```lua +{ + callback = function(_) + vim.cmd("Telescope find_files") + end, +} +``` + +## Open Telescope to find files right after switch project + +```lua +{ + callback = function(_) + vim.cmd("Telescope find_files") + end, +} +``` diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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..7448263 --- /dev/null +++ b/README.md @@ -0,0 +1,109 @@ +# cd-project.nvim + +I tried quite a lot `Project Management` plugins. + +In the end, + +I found all I need is an easier way to `cd` to another project directory. + +## How it works? + +This plugin did nothing but provide a simpler way to add, persist and switch to directories. + +![HowItWorks](https://github.com/LintaoAmons/cd-project.nvim/assets/95092244/6fa66d86-38c0-4ea8-ad5e-a6ed14c263ef) + +## Install and Config +> [My config as ref](https://github.com/LintaoAmons/CoolStuffes/blob/main/nvim/.config/nvim/lua/plugins/editor-enhance/project.lua) + +- Simple version + +```lua +-- using lazy.nvim +return { "LintaoAmons/cd-project.nvim" } +``` + +- All config options + +```lua +-- using lazy.nvim +return { + "LintaoAmons/cd-project.nvim", + -- Don't need call the setup function if you think you are good with the default configuration + tag = "v0.6.1", -- Optional, You can also use tag to pin the plugin version for stability + init = function() -- use init if you want enable auto_register_project, otherwise config is good + require("cd-project").setup({ + -- this json file is acting like a database to update and read the projects in real time. + -- So because it's just a json file, you can edit directly to add more paths you want manually + projects_config_filepath = vim.fs.normalize(vim.fn.stdpath("config") .. "/cd-project.nvim.json"), + -- this controls the behaviour of `CdProjectAdd` command about how to get the project directory + project_dir_pattern = { ".git", ".gitignore", "Cargo.toml", "package.json", "go.mod" }, + choice_format = "both", -- optional, you can switch to "name" or "path" + projects_picker = "vim-ui", -- optional, you can switch to `telescope` + auto_register_project = false, -- optional, toggle on/off the auto add project behaviour + -- do whatever you like by hooks + hooks = { + { + callback = function(dir) + vim.notify("switched to dir: " .. dir) + end, + }, + { + callback = function(_) + vim.cmd("Telescope find_files") + end, + }, + { + callback = function(dir) + vim.notify("switched to dir: " .. dir) + end, -- required, action when trigger the hook + name = "cd hint", -- optional + order = 1, -- optional, the exection order if there're multiple hooks to be trigger at one point + pattern = "cd-project.nvim", -- optional, trigger hook if contains pattern + trigger_point = "DISABLE", -- optional, enum of trigger_points, default to `AFTER_CD` + match_rule = function(dir) -- optional, a function return bool. if have this fields, then pattern will be ignored + return true + end, + }, + } + }) + end, + } +``` + +> [Hook examples](./HOOK_EXAMPLES.md) + +## Commands and Apis + +| Command | Description | +| -------------------- | --------------------------------------------------------------------------- | +| `CdProject` | change working directory | +| `CdProjectTab` | change working directory in tab | +| `CdProjectAdd` | add current project's directory to the database(json file) | +| `CdProjectBack` | quickly switch between current project and previous project | +| `CdProjectManualAdd` | Manually add a path and optionally give it a name | +| `CdSearchAndAdd` | fuzzy find directories in $HOME using telescope and optional give it a name | + +You can call the Apis provided by the plugin, to integrate into your own work flow + +```lua +require("cd-project.api").some_method() +``` + +you can find the exported Apis at [./lua/cd-project/api.lua](./lua/cd-project/api.lua) + +- [ ] Remember the buffer and cursor location while switch to the project + +## CONTRIBUTING + +Don't hesitate to ask me anything about the codebase if you want to contribute. + +By [telegram](https://t.me/+ssgpiHyY9580ZWFl) or [微信: CateFat](https://lintao-index.pages.dev/assets/images/wechat-437d6c12efa9f89bab63c7fe07ce1927.png) + +## Some Other Neovim Stuff + +- [my neovim config](https://github.com/LintaoAmons/CoolStuffes/tree/main/nvim/.config/nvim) +- [scratch.nvim](https://github.com/LintaoAmons/scratch.nvim) +- [cd-project.nvim](https://github.com/LintaoAmons/cd-project.nvim) +- [bookmarks.nvim](https://github.com/LintaoAmons/bookmarks.nvim) +- [context-menu.nvim](https://github.com/LintaoAmons/context-menu.nvim) + diff --git a/lua/.luarc.json b/lua/.luarc.json new file mode 100644 index 0000000..13985b8 --- /dev/null +++ b/lua/.luarc.json @@ -0,0 +1,8 @@ +{ + "workspace.library": [ + "/Users/lintao/.local/share/nvim/lazy/neodev.nvim/types/stable", + "/opt/homebrew/Cellar/neovim/0.9.4/share/nvim/runtime/lua", + "/Volumes/t7ex/Documents/oatnil/release/cd-project.nvim/lua", + "${3rd}/luv/library" + ] +} \ No newline at end of file diff --git a/lua/cd-project/adapter/init.lua b/lua/cd-project/adapter/init.lua new file mode 100644 index 0000000..9249d23 --- /dev/null +++ b/lua/cd-project/adapter/init.lua @@ -0,0 +1,44 @@ +-- TODO: refator to picker + +local function cd_project_in_tab() + local projects_picker = vim.g.cd_project_config.projects_picker + if projects_picker == "telescope" then + return require("cd-project.adapter.telescope").cd_project_in_tab() + end + + require("cd-project.adapter.vim-ui").cd_project_in_tab() +end + +local function cd_project() + local projects_picker = vim.g.cd_project_config.projects_picker + if projects_picker == "telescope" then + return require("cd-project.adapter.telescope").cd_project() + end + + require("cd-project.adapter.vim-ui").cd_project() +end + +local function manual_cd_project() + require("cd-project.adapter.vim-ui").manual_cd_project() +end + +local function telescope_search_and_add() + local projects_picker = vim.g.cd_project_config.projects_picker + if projects_picker == "telescope" then + return require("cd-project.adapter.telescope").search_and_add() + end +end + +local function delete_project() + require("cd-project.adapter.telescope").project_picker(function(project) + require("cd-project.api").delete_project(project) + end) +end + +return { + cd_project = cd_project, + cd_project_in_tab = cd_project_in_tab, + manual_cd_project = manual_cd_project, + telescope_search_and_add = telescope_search_and_add, + delete_project = delete_project, +} diff --git a/lua/cd-project/adapter/telescope.lua b/lua/cd-project/adapter/telescope.lua new file mode 100644 index 0000000..b2f6fe8 --- /dev/null +++ b/lua/cd-project/adapter/telescope.lua @@ -0,0 +1,189 @@ +local utils = require("cd-project.utils") +local success, _ = pcall(require, "telescope.pickers") +if not success then + utils.log_error("telescope not installed") + return +end +local pickers = require("telescope.pickers") +local finders = require("telescope.finders") +local conf = require("telescope.config").values +local actions = require("telescope.actions") +local action_state = require("telescope.actions.state") + +local repo = require("cd-project.project-repo") +local api = require("cd-project.api") + +---@param callback fun(project: CdProject.Project): nil +---@param opts? table +local function project_picker(callback, opts) + opts = opts or {} + -- TODO: a format function + local projects = repo.get_projects() + local maxLength = 0 + for _, project in ipairs(projects) do + if #project.name > maxLength then + maxLength = #project.name + end + end + + pickers + .new(opts, { + attach_mappings = function(prompt_bufnr) + actions.select_default:replace(function() + actions.close(prompt_bufnr) + ---@type CdProject.Project + local selected_project = action_state.get_selected_entry().value + callback(selected_project) + end) + return true + end, + prompt_title = "[CdProject]", + finder = finders.new_table({ + results = projects, + ---@param project CdProject.Project + entry_maker = function(project) + return { + value = project, + display = utils.format_entry(project, maxLength), + ordinal = project.path, + } + end, + }), + sorter = conf.generic_sorter(opts), + }) + :find() +end + +---@param opts? table +local cd_project = function(opts) + opts = opts or {} + local projects = repo.get_projects() + local maxLength = 0 + for _, project in ipairs(projects) do + if #project.name > maxLength then + maxLength = #project.name + end + end + + pickers + .new(opts, { + attach_mappings = function(prompt_bufnr) + actions.select_default:replace(function() + actions.close(prompt_bufnr) + ---@type CdProject.Project + local selected_project = action_state.get_selected_entry().value + api.cd_project(selected_project.path) + end) + return true + end, + prompt_title = "cd to project", + finder = finders.new_table({ + results = projects, + ---@param project CdProject.Project + entry_maker = function(project) + return { + value = project, + display = utils.format_entry(project, maxLength), + ordinal = project.path, + } + end, + }), + sorter = conf.generic_sorter(opts), + }) + :find() +end + +---@param opts? table +local cd_project_in_tab = function(opts) + opts = opts or {} + local projects = repo.get_projects() + local maxLength = 0 + for _, project in ipairs(projects) do + if #project.name > maxLength then + maxLength = #project.name + end + end + + pickers + .new(opts, { + attach_mappings = function(prompt_bufnr) + actions.select_default:replace(function() + actions.close(prompt_bufnr) + ---@type CdProject.Project + local selected_project = action_state.get_selected_entry().value + api.cd_project_in_tab(selected_project.path) + end) + return true + end, + prompt_title = "tcd to project", + finder = finders.new_table({ + results = projects, + ---@param project CdProject.Project + entry_maker = function(project) + return { + value = project, + display = utils.format_entry(project, maxLength), + ordinal = project.path, + } + end, + }), + sorter = conf.generic_sorter(opts), + }) + :find() +end + +local search_and_add = function(opts) + opts = opts or {} + + local find_command = utils.check_for_find_cmd() + if not find_command then + utils.log_error("You need to install fd or find.") + return + end + + vim.fn.jobstart(find_command, { + stdout_buffered = true, + on_stdout = function(_, data) + pickers + .new(opts, { + attach_mappings = function(prompt_bufnr) + actions.select_default:replace(function() + actions.close(prompt_bufnr) + local selected_dir = action_state.get_selected_entry().value + + vim.ui.input({ prompt = "Add a project name: " }, function(name) + if not name or name == "" then + vim.notify('No name given, using "' .. utils.get_tail_of_path(selected_dir) .. '" instead') + local project = api.build_project_obj(selected_dir) + if not project then + return + end + return api.add_project(project) + end + + local project = api.build_project_obj(selected_dir, name) + if not project then + return + end + return api.add_project(project) + end) + end) + return true + end, + prompt_title = "Select dir to add", + finder = finders.new_table({ + results = data, + }), + sorter = conf.file_sorter(opts), + }) + :find() + end, + }) +end + +return { + cd_project = cd_project, + cd_project_in_tab = cd_project_in_tab, + search_and_add = search_and_add, + project_picker = project_picker, +} diff --git a/lua/cd-project/adapter/vim-ui.lua b/lua/cd-project/adapter/vim-ui.lua new file mode 100644 index 0000000..03744a9 --- /dev/null +++ b/lua/cd-project/adapter/vim-ui.lua @@ -0,0 +1,81 @@ +local utils = require("cd-project.utils") +local api = require("cd-project.api") +local repo = require("cd-project.project-repo") + +---@param opts? table +local function cd_project(opts) + opts = opts or {} + local projects = repo.get_projects() + + local maxLength = 0 + for _, project in ipairs(projects) do + if #project.name > maxLength then + maxLength = #project.name + end + end + + vim.ui.select(projects, { + prompt = "Select a directory", + format_item = function(project) + return utils.format_entry(project, maxLength) + end, + }, function(selected) + if not selected then + return utils.log_error("Must select a valid dir") + end + api.cd_project(selected.path) + end) +end + +---@param opts? table +local function cd_project_in_tab(opts) + opts = opts or {} + local projects = repo.get_projects() + + local maxLength = 0 + for _, project in ipairs(projects) do + if #project.name > maxLength then + maxLength = #project.name + end + end + + vim.ui.select(projects, { + prompt = "Select a directory", + format_item = function(project) + return utils.format_entry(project, maxLength) + end, + }, function(selected) + if not selected then + return utils.log_error("Must select a valid dir") + end + api.cd_project_in_tab(selected.path) + end) +end + +local function manual_cd_project() + vim.ui.input({ prompt = "Add a project path: " }, function(path) + if not path or path == "" then + return utils.log_error("No path given, quitting.") + end + + vim.ui.input({ prompt = "Add a project name: " }, function(name) + if not name or name == "" then + name = utils.get_tail_of_path(path) + vim.notify('No name given, using "' .. name .. '" instead') + end + + local project = api.build_project_obj(path, name) + if not project then + return + end + + return api.add_project(project) + end) + end) +end + +return { + cd_project = cd_project, + cd_project_in_tab = cd_project_in_tab, + manual_cd_project = manual_cd_project, +} diff --git a/lua/cd-project/api.lua b/lua/cd-project/api.lua new file mode 100644 index 0000000..d1f6ba5 --- /dev/null +++ b/lua/cd-project/api.lua @@ -0,0 +1,193 @@ +local cd_hooks = require("cd-project.hooks") +local repo = require("cd-project.project-repo") +local utils = require("cd-project.utils") + +---@return string|nil +local function find_project_dir() + local found = vim.fs.find( + vim.g.cd_project_config.project_dir_pattern, + { upward = true, stop = vim.loop.os_homedir(), path = vim.fs.dirname(vim.fn.expand("%:p")) } + ) + + if #found == 0 then + return vim.loop.os_homedir() + end + + local project_dir = vim.fs.dirname(found[1]) + + if not project_dir or project_dir == "." or project_dir == "" or project_dir == " " then + project_dir = string.match(vim.fn.execute("pwd"), "^%s*(.-)%s*$") + end + + if not project_dir or project_dir == "." or project_dir == "" or project_dir == " " then + return nil + end + + return project_dir +end + +---@return string[] +local function get_project_paths() + local projects = repo.get_projects() + local paths = {} + for _, value in ipairs(projects) do + table.insert(paths, value.path) + end + return paths +end + +---@return string[] +local function get_project_names() + local projects = repo.get_projects() + local path_names = {} + for _, value in ipairs(projects) do + table.insert(path_names, value.name) + end + return path_names +end + +---@param path string +local function path_exists_in_tab(path) + for _, tabpage in ipairs(vim.api.nvim_list_tabpages()) do + local tab_cwd = vim.fn.getcwd(-1, vim.api.nvim_tabpage_get_number(tabpage)) + local normalized_path = utils.remove_trailing_slash(path) + local normalized_tab_cwd = utils.remove_trailing_slash(tab_cwd) + if normalized_path == normalized_tab_cwd then + return tabpage + end + end + return nil +end + +---@param dir string +local function cd_project_in_tab(dir) + vim.g.cd_project_last_project = vim.g.cd_project_current_project + vim.g.cd_project_current_project = dir + + local tabnr = path_exists_in_tab(dir) + if tabnr ~= nil then + -- Remain in current tab if current tab holds target dir + if vim.api.nvim_get_current_tabpage() == tabnr then + vim.notify( + "Dir already open in current tab (#" .. tabnr .. "). No action taken.", + vim.log.levels.INFO, + { title = "cd-project.nvim" } + ) + return + end + + -- Switch to tab that holds target dir + vim.api.nvim_set_current_tabpage(tabnr) + vim.notify( + "Dir already open in tab #" .. tabnr .. ". You have been redirected.", + vim.log.levels.INFO, + { title = "cd-project.nvim" } + ) + return + end + + vim.fn.execute("tabe | tcd " .. vim.fn.fnameescape(dir)) + + local hooks = cd_hooks.get_hooks(vim.g.cd_project_config.hooks, dir, "AFTER_CD") + for _, hook in ipairs(hooks) do + hook(dir) + end +end + +---@param dir string +local function cd_project(dir) + vim.g.cd_project_last_project = vim.g.cd_project_current_project + vim.g.cd_project_current_project = dir + vim.fn.execute("cd " .. vim.fn.fnameescape(dir)) + + local hooks = cd_hooks.get_hooks(vim.g.cd_project_config.hooks, dir, "AFTER_CD") + for _, hook in ipairs(hooks) do + hook(dir) + end +end + +---@param path string +---@param name? string +---@param desc? string|nil +---@return CdProject.Project|nil +local function build_project_obj(path, name, desc) + local normalized_path = vim.fn.expand(path) + if vim.fn.isdirectory(normalized_path) == 0 then + return utils.log_error(normalized_path .. " is not a directory") + end + + return { + path = normalized_path, + name = name or utils.get_tail_of_path(normalized_path), + desc = desc, + } +end + +---@param project CdProject.Project +---@param opts? {show_duplicate_hints: boolean} +local function add_project(project, opts) + local projects = repo.get_projects() + opts = opts or { show_duplicate_hints = true } + + if vim.tbl_contains(get_project_paths(), project.path) then + if opts.show_duplicate_hints then + vim.notify("Project already exists: " .. project.path, vim.log.levels.INFO, { title = "cd-project.nvim" }) + end + + return + end + + table.insert(projects, project) + repo.write_projects(projects) + vim.notify("Project added: \n" .. project.path, vim.log.levels.INFO, { title = "cd-project.nvim" }) +end + +---@param project CdProject.Project +local function delete_project(project) + local projects = repo.get_projects() + + local new_projects = vim.tbl_filter(function(p) + return p.name ~= project.name + end, projects) + repo.write_projects(new_projects) + vim.notify("Project deleted: \n" .. project.name, vim.log.levels.INFO, { title = "cd-project.nvim" }) +end + +---@param opts? {show_duplicate_hints: boolean} +local function add_current_project(opts) + local project_dir = find_project_dir() + opts = opts or { show_duplicate_hints = true } + + if not project_dir then + return utils.log_err("Can't find project path of current file") + end + + local project = build_project_obj(project_dir) + + if not project then + return + end + + add_project(project, opts) +end + +local function back() + local last_project = vim.g.cd_project_last_project + if not last_project then + vim.notify("Can't find last project. Haven't switch project yet.") + end + cd_project(last_project) +end + +return { + cd_project = cd_project, + cd_project_in_tab = cd_project_in_tab, + build_project_obj = build_project_obj, + get_project_paths = get_project_paths, + get_project_names = get_project_names, + add_current_project = add_current_project, + add_project = add_project, + delete_project = delete_project, + back = back, + find_project_dir = find_project_dir, +} diff --git a/lua/cd-project/auto.lua b/lua/cd-project/auto.lua new file mode 100644 index 0000000..38da777 --- /dev/null +++ b/lua/cd-project/auto.lua @@ -0,0 +1,21 @@ +local api = require("cd-project.api") +local auto_group_name = "CdProjectPlugin" + +local function setup() + vim.api.nvim_create_augroup(auto_group_name, { clear = true }) + vim.api.nvim_create_autocmd({ "VimEnter" }, { + group = auto_group_name, + callback = function(_) + api.add_current_project({ show_duplicate_hints = false }) + end, + }) +end + +local function clear() + vim.api.nvim_create_augroup(auto_group_name, { clear = true }) +end + +return { + setup = setup, + clear = clear, +} diff --git a/lua/cd-project/config.lua b/lua/cd-project/config.lua new file mode 100644 index 0000000..79313f6 --- /dev/null +++ b/lua/cd-project/config.lua @@ -0,0 +1,60 @@ +---@alias CdProject.Adapter "telescope"|"vim-ui" +---@alias CdProject.ChoiceFormat "name"|"path"|"both" + +---@class CdProject.Config +---@field projects_config_filepath string +---@field project_dir_pattern string[] +---@field choice_format? CdProject.ChoiceFormat +---@field projects_picker? CdProject.Adapter +---@field hooks? CdProject.Hook[] +---@field format_json? boolean + +---@type CdProject.Config +local default_config = { + -- this json file is acting like a database to update and read the projects in real time. + -- So because it's just a json file, you can edit directly to add more paths you want manually + projects_config_filepath = vim.fs.normalize(vim.fn.stdpath("config") .. "/cd-project.nvim.json"), + -- this controls the behaviour of `CdProjectAdd` command about how to get the project directory + project_dir_pattern = { ".git", ".gitignore", "Cargo.toml", "package.json", "go.mod" }, + choice_format = "both", -- optional, you can switch to "name" or "path" + projects_picker = "vim-ui", -- optional, you can switch to `telescope` + auto_register_project = false, -- optional, toggle on/off the auto add project behaviour + -- do whatever you like by hooks + hooks = { + { + callback = function(dir) + vim.notify("switched to dir: " .. dir) + end, + }, + { + callback = function(dir) + vim.notify("switched to dir: " .. dir) + end, -- required, action when trigger the hook + name = "cd hint", -- optional + order = 1, -- optional, the exection order if there're multiple hooks to be trigger at one point + pattern = "cd-project.nvim", -- optional, trigger hook if contains pattern + trigger_point = "DISABLE", -- optional, enum of trigger_points, default to `AFTER_CD` + match_rule = function(dir) -- optional, a function return bool. if have this fields, then pattern will be ignored + return true + end, + }, + } +} + +local M = {} + +---@type CdProject.Config +vim.g.cd_project_config = default_config + +---@param user_config? CdProject.Config +M.setup = function(user_config) + local previous_config = vim.g.cd_project_config or default_config + vim.g.cd_project_config = vim.tbl_deep_extend("force", previous_config, user_config or {}) or default_config + if vim.g.cd_project_config.auto_register_project then + require("cd-project.auto").setup() + else + require("cd-project.auto").clear() + end +end + +return M diff --git a/lua/cd-project/hooks.lua b/lua/cd-project/hooks.lua new file mode 100644 index 0000000..3fbe40a --- /dev/null +++ b/lua/cd-project/hooks.lua @@ -0,0 +1,51 @@ +---@class CdProject.Hook +---@field callback fun(param: string) +---@field name? string +---@field order? number +---@field trigger_point? string +---@field pattern? string +---@field match_rule? fun(dir: string): boolean +--- +---@param hooks CdProject.Hook[] +---@param dir string +---@param point string +---@return function[] +local get_hooks = function(hooks, dir, point) + local matching_hooks = {} + for _, hook in ipairs(hooks) do + local matches = false + local trigger_point = hook.trigger_point or "AFTER_CD" + + -- Check if match_rule exists and returns true + if hook.match_rule == nil and hook.pattern == nil then + matches = true + elseif hook.match_rule and hook.match_rule(dir) and trigger_point == point then + matches = true + -- If no match_rule, check if pattern exists in dir + elseif hook.pattern and dir:find(hook.pattern) and trigger_point == point then + matches = true + end + + -- Add hook to matching_hooks if it matches + if matches then + table.insert(matching_hooks, hook) + end + end + + -- Sort hooks by order if order is defined + table.sort(matching_hooks, function(a, b) + return (a.order or 0) < (b.order or 0) + end) + + -- Extract and return the callback functions from the matching hooks + local callbacks = {} + for _, hook in ipairs(matching_hooks) do + table.insert(callbacks, hook.callback) + end + + return callbacks +end + +return { + get_hooks = get_hooks, +} diff --git a/lua/cd-project/init.lua b/lua/cd-project/init.lua new file mode 100644 index 0000000..9673c3e --- /dev/null +++ b/lua/cd-project/init.lua @@ -0,0 +1,4 @@ +return { + setup = require("cd-project.config").setup, + api = require("cd-project.api"), +} diff --git a/lua/cd-project/json.lua b/lua/cd-project/json.lua new file mode 100644 index 0000000..e3f8443 --- /dev/null +++ b/lua/cd-project/json.lua @@ -0,0 +1,45 @@ +---@param tbl table +---@param path string +local write_json_file = function(tbl, path) + local content = vim.fn.json_encode(tbl) -- Encoding table to JSON string + + local formatter = "jq" + if not (0 == vim.fn.executable(formatter)) then + local fmt_cmd = { formatter, "--sort-keys", "--monochrome-output" } + local result = vim.system(fmt_cmd, { stdin = content }):wait() + if result.code ~= 0 then + error("Failed to format JSON with " .. formatter .. ": " .. result.stderr) + return nil + end + content = result.stdout + end + + local file, err = io.open(path, "w") + if not file then + error("Could not open file: " .. err) + return nil + end + + file:write(content) + file:close() +end + +---@param path string +---@return table +local read_or_init_json_file = function(path) + local file, _ = io.open(path, "r") + if not file then + write_json_file({}, path) + return {} + end + + local content = file:read("*a") -- Read the entire content + file:close() + + return vim.fn.json_decode(content) or {} +end + +return { + write_json_file = write_json_file, + read_or_init_json_file = read_or_init_json_file, +} diff --git a/lua/cd-project/project-repo.lua b/lua/cd-project/project-repo.lua new file mode 100644 index 0000000..4394ff9 --- /dev/null +++ b/lua/cd-project/project-repo.lua @@ -0,0 +1,20 @@ +local json = require("cd-project.json") +---@class CdProject.Project +---@field path string +---@field name string +---@field desc string|nil + +---@return CdProject.Project[] +local get_projects = function() + return json.read_or_init_json_file(vim.g.cd_project_config.projects_config_filepath) +end + +---@param projects CdProject.Project[] +local write_projects = function(projects) + json.write_json_file(projects, vim.g.cd_project_config.projects_config_filepath) +end + +return { + get_projects = get_projects, + write_projects = write_projects, +} diff --git a/lua/cd-project/utils.lua b/lua/cd-project/utils.lua new file mode 100644 index 0000000..a8d763e --- /dev/null +++ b/lua/cd-project/utils.lua @@ -0,0 +1,79 @@ +---@param msg string +local function log_error(msg) + vim.notify(msg, vim.log.levels.ERROR, { title = "cd-project.nvim" }) +end + +---@param path string +local function get_tail_of_path(path) + -- Remove leading directories, keep the last part + local tail = path:match("([^/]+)$") + local parent = path:match("^.*%/([^/]+)/?$") -- Get the parent directory + -- if foo/ return foo + if parent and not tail then + return parent + -- if foo/bar, return bar + else + return tail -- Return only the tail if there is no parent + end +end + +---@param path string +local function remove_trailing_slash(path) + -- Remove trailing slash if it exists + return (path:gsub("(.)/*$", "%1")) +end + +---@param project CdProject.Project +---@param max_len integer +local function format_entry(project, max_len) + local format = vim.g.cd_project_config.choice_format + if format == "name" then + return project.name + end + if format == "path" then + return project.path + end + return string.format("%-" .. max_len .. "s", project.name) .. " | " .. project.path +end + +-- vague2k: We *could* check for the "find" command but then we would need to format +-- the telescope picker, which can lead to uneeded complexity. +-- +-- I feel like not checking for "find" is a worthy trade off +-- +-- TODO: Test on windows. I'm 98% sure fd handles path string formatting +local check_for_find_cmd = function() + -- if unix like system + if package.config:sub(1, 1) == "/" then + -- list of directories that should be excluded, that fill 1 of these 2 criteria + -- 1. Is reasonably unlikely that a user will not have a project worth adding in the directory + -- 2. Causes unreasonable hang times in executing command + -- a prime example would be the hidden "/Library" dir on macOS systems. + local find_command = (function() + if 1 == vim.fn.executable("fd") then + return "fd --type d --hidden -E Library -E .local -E .cache . ~" + elseif 1 == vim.fn.executable("fdfind") then + return "fdfind --type d --hidden -E Library -E .local -E .cache . ~" + end + end)() + return find_command + end + + -- any system that isn't unix like + local find_command = (function() + if 1 == vim.fn.executable("fd") then + return { "fd", "--type", "d", "--color", "never" } + elseif 1 == vim.fn.executable("fdfind") then + return { "fdfind", "--type", "d", "--color", "never" } + end + end)() + return find_command +end + +return { + log_error = log_error, + get_tail_of_path = get_tail_of_path, + remove_trailing_slash = remove_trailing_slash, + format_entry = format_entry, + check_for_find_cmd = check_for_find_cmd, +} diff --git a/plugin/cd-project.lua b/plugin/cd-project.lua new file mode 100644 index 0000000..580bf87 --- /dev/null +++ b/plugin/cd-project.lua @@ -0,0 +1,23 @@ +if vim.fn.has("nvim-0.7.0") == 0 then + vim.api.nvim_err_writeln("cd-project.nvim requires at least nvim-0.7") + return +end + +-- make sure this file is loaded only once +if vim.g.loaded_cd_project == 1 then + return +end +vim.g.loaded_cd_project = 1 + +require("cd-project").setup() +local adapter = require("cd-project.adapter") +local api = require("cd-project.api") +vim.g.cd_project_current_project = api.find_project_dir() + +vim.api.nvim_create_user_command("CdProject", adapter.cd_project, {}) +vim.api.nvim_create_user_command("CdProjectTab", adapter.cd_project_in_tab, {}) +vim.api.nvim_create_user_command("CdProjectAdd", api.add_current_project, {}) +vim.api.nvim_create_user_command("CdProjectManualAdd", adapter.manual_cd_project, {}) +vim.api.nvim_create_user_command("CdProjectSearchAndAdd", adapter.telescope_search_and_add, {}) +vim.api.nvim_create_user_command("CdProjectDelete", adapter.delete_project, {}) +vim.api.nvim_create_user_command("CdProjectBack", api.back, {})