kristoferssolo/solorice
1
0
Fork 0
mirror of https://github.com/kristoferssolo/solorice.git synced 2026-02-04 06:32:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use dotter

Browse Source
This commit is contained in:
Kristofers Solo
2024-08-28 09:02:07 +03:00
parent d888080cc7
commit a42ded1119
1200 changed files with 1231 additions and 2261 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
config/yazi/plugins/augment-command.yazi/DO_NOT_MODIFY_ANYTHING_IN_THIS_DIRECTORY Normal file
View File

674
config/yazi/plugins/augment-command.yazi/LICENSE Normal file
View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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
<https://www.gnu.org/licenses/>.
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
<https://www.gnu.org/licenses/why-not-lgpl.html>.

334
config/yazi/plugins/augment-command.yazi/README.md Normal file
View File

@@ -0,0 +1,334 @@
# augment-command.yazi
A [Yazi](https://github.com/sxyazi/yazi)
plugin that enhances Yazi's default commands.
This plugin is inspired by the
[Yazi tips page](https://yazi-rs.github.io/docs/tips),
the [bypass.yazi](https://github.com/Rolv-Apneseth/bypass.yazi) plugin
and the [fast-enter.yazi](https://github.com/ourongxing/fast-enter.yazi) plugin.
## Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [What about the commands are augmented?](#what-about-the-commands-are-augmented)
- [Augmented commands](#augmented-commands)
- [New commands](#new-commands)
- [Usage](#usage)
- [Windows support?](#windows-support)
- [Licence](#licence)
## Requirements
- [Yazi](https://github.com/sxyazi/yazi) v0.2.4+
- [Unarchiver (unar)](https://theunarchiver.com/command-line)
- [ls](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation)
- Linux or macOS
## Installation
### Yazi v0.2.5 and before (manual installation)
```sh
git clone https://github.com/hankertrix/augment-command.yazi ~/.config/yazi/plugins/augment-command.yazi
```
### Yazi nightly (latest Git commit) (package manager)
```sh
# Add the plugin
ya pack -a hankertrix/augment-command
# Install plugin
ya pack -i
# Update plugin
ya pack -u
```
## Configuration
| Configuration | Values | Default | Description |
| ----------------------------------- | -------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prompt` | `true` or `false` | `false` | Create a prompt to choose between hovered and selected items when both exist. If this option is disabled, selected items will only be operated on when the hovered item is selected, otherwise the hovered item will be the default item that is operated on. |
| `default_item_group_for_prompt` | `hovered`, `selected` or `none` | `hovered` | The default item group to operate on when the prompt is submitted without any value. `hovered` means the hovered item is operated on, `selected` means the selected items are operated on, and `none` just cancels the operation. |
| `smart_enter` | `true` or `false` | `true` | Use one command to open files or enter a directory. With this option set, the `enter` and `open` commands will both call the `enter` command when a directory is hovered and call the `open` command when a regular file is hovered. |
| `smart_paste` | `true` or `false` | `false` | Paste items into a directory without entering it. The behaviour is exactly the same as the [smart-paste tip on Yazi's documentation](https://yazi-rs.github.io/docs/tips#smart-paste). Setting this option to `false` will use the default `paste` behaviour. You can also enable smart pasting by passing the `--smart` flag to the paste command. |
| `enter_archives` | `true` or `false` | `true` | Automatically extract and enter archive files. This option requires [Unarchiver (unar)](https://theunarchiver.com/command-line) to be installed. |
| `extract_behaviour` | `overwrite`, `rename`, or `skip` | `skip` | Determines how unar deals with existing files when extracting an archive. `overwrite` results in unar overwriting existing files when extracting. `rename` results in unar renaming the new files with the same name as existing files. `skip` results in unar skipping files that have the same name as existing files. Use the `man unar` command for more information. |
| `must_have_hovered_item` | `true` or `false` | `true` | This option stops the plugin from executing any commands when there is no hovered item. |
| `skip_single_subdirectory_on_enter` | `true` or `false` | `true` | Skip directories when there is only one subdirectory and no other files when entering directories. This behaviour can be turned off by passing the `--no-skip` flag to the `enter` or `open` commands. |
| `skip_single_subdirectory_on_leave` | `true` or `false` | `true` | Skip directories when there is only one subdirectory and no other files when leaving directories. This behaviour can be turned off by passing the `--no-skip` flag to the `leave` command. |
| `ignore_hidden_items` | `true` or `false` | `false` | Ignore hidden items when determining whether a directory only has one subdirectory and no other items. Setting this option to `false` will mean that hidden items in a directory will stop the plugin from skipping the single subdirectory. |
| `wraparound_file_navigation` | `true` or `false` | `false` | Wrap around from the bottom to the top or from the top to the bottom when using the `arrow` command to navigate. |
To configure this plugin, add the code below to your `~/.config/yazi/init.lua` file:
```lua
-- ~/.config/yazi/init.lua
-- Using the default configuration
require("augment-command"):setup({
prompt = false,
default_item_group_for_prompt = "hovered",
smart_enter = true,
smart_paste = false,
enter_archives = true,
extract_behaviour = "skip",
must_have_hovered_item = true,
skip_single_subdirectory_on_enter = true,
skip_single_subdirectory_on_leave = true,
ignore_hidden_items = false,
wraparound_file_navigation = false,
})
```
Note that you don't have to do this if you want to use the default configuration.
You also can leave out configuration options that you would like to be left as default,
for example:
```lua
-- ~/.config/yazi/init.lua
-- Custom configuration
require("augment-command"):setup({
prompt = true,
default_item_group_for_prompt = "none",
extract_behaviour = "overwrite",
ignore_hidden_items = true,
wraparound_file_navigation = true,
})
```
## What about the commands are augmented?
All commands that can operate on multiple files and directories,
like `open`, `rename` and `remove`,
as well as the new commands `editor` and `pager`,
now determine an item group to operate on.
By default, the command will operate on the hovered item,
unless the hovered item is also selected,
then it will operate on the selected items.
- When `must_have_hovered_item` is set to `true`,
having no hovered item means the plugin will cancel the operation.
- When `must_have_hovered_item` is set to `false` and
there are selected items, the selected items will be operated on.
- With `prompt` is set to `true`,
the plugin will always prompt you to
choose an item group when there are
both selected items and a hovered item.
## Augmented commands
### Open (`open`)
- When `smart_enter` is set to `true`,
calls the `enter` command when the hovered item is a directory.
- `--no-skip` flag, which only applies
when `smart_enter` is used as it is passed to the `enter` command.
More details about this flag can be found at the documentation
for the [enter command](#enter-enter).
- Automatically extracts and enters archive files,
with support for skipping directories
that contain only one subdirectory in the extracted archive.
This can be disabled by setting `enter_archives` to `false` in the configuration.
This feature requires
[unarchiver (unar)](https://theunarchiver.com/command-line)
to be installed as well as the
[ls](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) command.
### Enter (`enter`)
- When `smart_enter` is set to `true`,
calls the `open` command when the hovered item is a file.
- Automatically skips directories that
contain only one subdirectory when entering directories.
This can be turned off by setting
`skip_single_subdirectory_on_enter` to `false` in the configuration.
This feature requires the
[ls](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) command.
- `--no-skip` flag. It stops the plugin from skipping directories
that contain only one subdirectory when entering directories,
even when `skip_single_subdirectory_on_enter` is set to `true`.
This allows you to set a key to navigate into directories
without skipping the directories that contain only one subdirectory.
### Leave (`leave`)
- Automatically skips directories that
contain only one subdirectory when leaving directories.
This can be turned off by
setting `skip_single_subdirectory_on_leave` to `false`
in the configuration.
This feature requires the
[ls](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) command.
- `--no-skip` flag. It stops the plugin
from skipping directories that contain only one subdirectory,
even when `skip_single_subdirectory_on_leave` is set to `true`.
This allows you to set a key to navigate into directories
without skipping the directories that contain only one subdirectory.
### Rename (`rename`)
- Unfortunately, to use the augmented `rename` command,
you need to use the latest Git version of Yazi as
[this commit](https://github.com/sxyazi/yazi/commit/9961251248c74202d8310085102d5809c279757c)
adds the necessary `--hovered` flag.
- If you don't use the latest Git version of Yazi,
it just behaves like the provided `rename` command
and the prompts don't do anything.
### Remove (`remove`)
- Unfortunately, to use the augmented `remove` command,
you need to use the latest Git version of Yazi as
[this commit](https://github.com/sxyazi/yazi/commit/9961251248c74202d8310085102d5809c279757c)
adds the necessary `--hovered` flag.
- If you don't use the latest Git version of Yazi,
it just behaves like the provided `remove` command
and the prompts don't do anything.
### Paste (`paste`)
- When `smart_paste` is set to `true`,
the `paste` command will paste items
into a hovered directory without entering it.
If the hovered item is not a directory,
the command pastes in the current directory instead.
- `--smart` flag to enable pasting in a hovered directory
without entering the directory.
This flag will cause the `paste` command to paste items
into a hovered directory even when `smart_paste` is set to `false`.
This allows you to set a key to use smart paste
instead of using smart paste for every paste command.
### Arrow (`arrow`)
- When `wraparound_file_navigation` is set to `true`,
the arrow command will wrap around from the bottom to the top or
from the top to the bottom when navigating.
Otherwise, it'll behave like the default `arrow` command.
## New commands
### Parent-arrow (`parent-arrow`)
- This command behaves like the `arrow` command,
but in the parent directory.
It allows you to navigate the parent directory
without leaving the current directory.
- When `wraparound_file_navigation` is set to `true`,
this command will also wrap around from the bottom to the top or
from top to the bottom when navigating in the parent directory.
For this feature to work, you will need the
[ls](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) command.
You will also need to have your directories
sorted first for this feature to work,
i.e. in your `~/.config/yazi/yazi.toml` file:
```toml
# ~/.config/yazi/yazi.toml
[manager]
sort_dir_first = true
```
- You can also replicate this using this series of commands below,
but it doesn't work as well,
and doesn't support wraparound navigation:
```toml
# ~/.config/yazi/keymap.toml
# Use K to move up in the parent directory
[[manager.prepend_keymap]]
on = [ "K" ]
run = [ "leave", "arrow -1", "enter" ]
desc = "Move up in the parent directory"
# Use J to move down in the parent directory
[[manager.prepend_keymap]]
on = [ "J" ]
run = [ "leave", "arrow 1", "enter" ]
desc = "Move down in the parent directory"
```
### Editor (`editor`)
- This command opens the default editor set by the `$EDITOR` environment variable.
### Pager (`pager`)
- This command opens the default pager set by the `$PAGER` environment variable.
## Usage
Add the commands that you would like to use to your `keymap.toml` file,
located at `~/.config/yazi/keymap.toml`,
in this format:
```toml
# ~/.config/yazi/keymap.toml
[[manager.prepend_keymap]]
on = [ "key" ]
run = "plugin augment-command --args='command arguments --flags --options=42'"
desc = "Description"
```
For example, to use the augmented `enter` command:
```toml
# ~/.config/yazi/keymap.toml
[[manager.prepend_keymap]]
on = [ "l" ]
run = "plugin augment-command --args='enter'"
desc = "Enter a directory and skip directories with only a single subdirectory"
```
All the default arguments, flags and options provided by Yazi are also supported, for example:
```toml
# ~/.config/yazi/keymap.toml
[[manager.prepend_keymap]]
on = [ "k" ]
run = "plugin augment-command --args='arrow -1'"
desc = "Move cursor up"
[[manager.prepend_keymap]]
on = [ "r" ]
run = "plugin augment-command --args='rename --cursor=before_ext'"
desc = "Rename a file or directory"
[[manager.prepend_keymap]]
on = [ "D" ]
run = "plugin augment-command --args='remove --permanently'"
desc = "Permanently delete the files"
```
For the default descriptions of the commands,
you can refer to
[Yazi's `keymap.toml` file](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/keymap.toml).
Essentially, all you need to do to use this plugin
is to wrap a Yazi command in single quotes,
like `'enter'`,
then add `plugin augment-command --args=`
in front of it, which results in
`plugin augment-command --args='enter'`.
### Full configuration example
For a full configuration example,
you can take a look at
[my `keymap.toml` file](https://github.com/hankertrix/Dotfiles/blob/master/.config/yazi/keymap.toml).
## Windows support?
Pull requests for Windows support are welcome!
## Licence
This plugin is licenced under the GNU GPL v3 licence.
You can view the full licence in the `LICENSE` file.

993
config/yazi/plugins/augment-command.yazi/init.lua Normal file
View File

@@ -0,0 +1,993 @@
-- Plugin to make some Yazi commands smarter
-- Written in Lua 5.4
-- The enum for which group of items to operate on
local ItemGroup = {
Hovered = "hovered",
Selected = "selected",
None = "none",
Prompt = "prompt",
}
-- The enum for the archive extraction behaviour
local ExtractBehaviour = {
Overwrite = "overwrite",
Rename = "rename",
Skip = "skip",
}
-- The enum for the flags for the archive extraction behaviour
local ExtractBehaviourFlags = {
[ExtractBehaviour.Overwrite] = "-f",
[ExtractBehaviour.Rename] = "-r",
[ExtractBehaviour.Skip] = "-s",
}
-- The enum for the supported commands
local Commands = {
Open = "open",
Enter = "enter",
Leave = "leave",
Rename = "rename",
Remove = "remove",
Paste = "paste",
Arrow = "arrow",
ParentArrow = "parent-arrow",
Editor = "editor",
Pager = "pager",
}
-- The default configuration for the plugin
local DEFAULT_CONFIG = {
prompt = false,
default_item_group_for_prompt = ItemGroup.Hovered,
smart_enter = true,
smart_paste = false,
enter_archives = true,
extract_behaviour = ExtractBehaviour.Skip,
must_have_hovered_item = true,
skip_single_subdirectory_on_enter = true,
skip_single_subdirectory_on_leave = true,
ignore_hidden_items = false,
wraparound_file_navigation = false,
}
-- The default notification options for this plugin
local DEFAULT_NOTIFICATION_OPTIONS = {
title = "Augment Command Plugin",
timeout = 5.0
}
-- The default input options for this plugin
local DEFAULT_INPUT_OPTIONS = {
position = { "top-center", y = 2, w = 50 }
}
-- The table of input options for the prompt
local INPUT_OPTIONS_TABLE = {
[ItemGroup.Hovered] = "(H/s)",
[ItemGroup.Selected] = "(h/S)",
[ItemGroup.None] = "(h/s)",
}
-- The list of archive mime types
local ARCHIVE_MIME_TYPES = {
"application/zip",
"application/gzip",
"application/x-tar",
"application/x-bzip",
"application/x-bzip2",
"application/x-7z-compressed",
"application/x-rar",
"application/x-xz",
}
-- The pattern to get the double dash from the front of the argument
local double_dash_pattern = "^%-%-"
-- The pattern to get the parent directory of the current directory
local get_parent_directory_pattern = "(.*)/.*"
-- The pattern to get if a file path is a directory
local is_directory_pattern = "(.*)/$"
-- The pattern to get the filename of a file
local get_filename_pattern = "(.*)%.[^%.]+$"
-- Function to merge tables.
-- The tables given later in the argument list WILL OVERRIDE
-- the tables given earlier in the argument list.
local function merge_tables(...)
-- Initialise a new table
local new_table = {}
-- Iterates over the tables given
for _, table in ipairs({...}) do
-- Iterate over all of the keys and values
for key, value in pairs(table) do
-- Set the key in the new table to the value given
new_table[key] = value
end
end
-- Return the new table
return new_table
end
-- Function to check if a list contains a given value
local function list_contains(list, value)
-- Iterate over all of the items in the list
for _, item in ipairs(list) do
-- If the item is equal to the given value,
-- then return true
if item == value then return true end
end
-- Otherwise, return false if the item isn't in the list
return false
end
-- Function to split a string into a list
local function string_split(given_string, separator)
-- If the separator isn't given, set it to the whitespace character
if separator == nil then
separator = "%s"
end
-- Initialise the list of splitted strings
local splitted_strings = {}
-- Iterate over all of the strings found by pattern
for string in string.gmatch(given_string, "([^" .. separator .. "]+)") do
-- Add the string to the list of splitted strings
table.insert(splitted_strings, string)
end
-- Return the list of splitted strings
return splitted_strings
end
-- Function to parse the arguments given.
-- This function takes the arguments passed to the entry function
local function parse_args(args)
-- The table of options to pass to ya.manager_emit
local options = {}
-- Iterates over the arguments given
for index, argument in ipairs(args) do
-- If the index isn't 1,
-- which means it is the arguments to the command given
if index ~= 1 then
-- If the argument doesn't start with a double dash
if not argument:match(double_dash_pattern) then
-- Try to convert the argument to a number
local number_argument = tonumber(argument)
-- Add the argument to the list of options
table.insert(
options,
number_argument and number_argument or argument
)
-- Continue the loop
goto continue
end
-- Otherwise, remove the double dash from the front of the argument
local cleaned_argument =
argument:gsub(double_dash_pattern, "")
-- Replace all of the dashes with underscores
cleaned_argument = cleaned_argument:gsub("%-", "_")
-- Split the arguments at the = character
local arg_name, arg_value = table.unpack(
string_split(cleaned_argument, "=")
)
-- If the argument value is nil
if arg_value == nil then
-- Set the argument name to the cleaned argument
arg_name = cleaned_argument
-- Set the argument value to true
arg_value = true
-- Otherwise
else
-- Try to convert the argument value to a number
local number_arg_value = tonumber(arg_value)
-- Set the argument value to the number
-- if the the argument value can be converted to a number
arg_value = number_arg_value and number_arg_value or arg_value
end
-- Add the argument name and value to the options
options[arg_name] = arg_value
end
-- The label to continue the loop
::continue::
end
-- Return the table of options
return options
end
-- Function to initialise the configuration
local initialise_config = ya.sync(function(state, opts)
-- Merge the default configuration with the given one
-- and set it to the state.
state.config = merge_tables(DEFAULT_CONFIG, opts)
-- Return the configuration object for async functions
return state.config
end)
-- Function to get the configuration from an async function
local get_config = ya.sync(function(state)
-- Returns the configuration object
return state.config
end)
-- Function to get the current working directory
local get_current_directory = ya.sync(function(_)
return tostring(cx.active.current.cwd)
end)
-- Function to get the parent working directory
local get_parent_directory = ya.sync(function(_)
-- Get the parent directory
local parent_directory = cx.active.parent
-- If the parent directory doesn't exist,
-- return nil
if not parent_directory then return nil end
-- Otherwise, return the path of the parent directory
return tostring(parent_directory.cwd)
end)
-- Function to get the hovered item path
local get_hovered_item_path = ya.sync(function(_)
-- Get the hovered item
local hovered_item = cx.active.current.hovered
-- If the hovered item exists
if hovered_item then
-- Return the path of the hovered item
return tostring(cx.active.current.hovered.url)
-- Otherwise, return nil
else return nil end
end)
-- Function to get if the hovered item is a directory
local hovered_item_is_dir = ya.sync(function(_)
-- Get the hovered item
local hovered_item = cx.active.current.hovered
-- Return if the hovered item exists and is a directory
return hovered_item and hovered_item.cha.is_dir
end)
-- Function to get if the hovered item is an archive
local hovered_item_is_archive = ya.sync(function(_)
-- Get the hovered item
local hovered_item = cx.active.current.hovered
-- Return if the hovered item exists and is an archive
return hovered_item and list_contains(
ARCHIVE_MIME_TYPES, hovered_item:mime()
)
end)
-- Function to choose which group of items to operate on.
-- It returns ItemGroup.Hovered for the hovered item,
-- ItemGroup.Selected for the selected items,
-- and ItemGroup.Prompt to tell the calling function
-- to prompt the user.
local get_item_group_from_state = ya.sync(function(state)
-- Get the hovered item
local hovered_item = cx.active.current.hovered
-- The boolean representing that there are no selected items
local no_selected_items = #cx.active.selected == 0
-- If there is no hovered item
if not hovered_item then
-- If there are no selected items, exit the function
if no_selected_items then return
-- Otherwise, if the configuration is set to have a hovered item,
-- exit the function
elseif state.config.must_have_hovered_item then return
-- Otherwise, return the enum for the selected items
else return ItemGroup.Selected end
-- Otherwise, there is a hovered item
-- and if there are no selected items,
-- return the enum for the hovered item.
elseif no_selected_items then return ItemGroup.Hovered
-- Otherwise if there are selected items and the user wants a prompt,
-- then tells the calling function to prompt them
elseif state.config.prompt then
return ItemGroup.Prompt
-- Otherwise, if the hovered item is selected,
-- then return the enum for the selected items
elseif hovered_item:is_selected() then return ItemGroup.Selected
-- Otherwise, return the enum for the hovered item
else return ItemGroup.Hovered end
end)
-- Function to prompt the user for their desired item group
local function prompt_for_desired_item_group()
-- Get the configuration
local config = get_config()
-- Get the default item group
local default_item_group = config.default_item_group_for_prompt
-- Get the input options
local input_options = INPUT_OPTIONS_TABLE[default_item_group]
-- If the default item group is None, then set it to nil
if default_item_group == ItemGroup.None then
default_item_group = nil
end
-- Prompt the user for their input
local user_input, event = ya.input(merge_tables(DEFAULT_INPUT_OPTIONS, {
title = "Operate on hovered or selected items? " .. input_options
}))
-- Lowercase the user's input
user_input = user_input:lower()
-- If the user did not confirm the input, exit the function
if event ~= 1 then return
-- Otherwise, if the user's input starts with "h",
-- return the item group representing the hovered item
elseif user_input:find("^h") then return ItemGroup.Hovered
-- Otherwise, if the user's input starts with "s",
-- return the item group representing the selected items
elseif user_input:find("^s") then return ItemGroup.Selected
-- Otherwise, return the default item group
else return default_item_group end
end
-- Function to get the item group
local function get_item_group()
-- Get the item group from the state
local item_group = get_item_group_from_state()
-- If the item group isn't the prompt one,
-- then return the item group immediately
if item_group ~= ItemGroup.Prompt then return item_group
-- Otherwise, prompt the user for the desired item group
else return prompt_for_desired_item_group() end
end
-- The ls command to get the items in the directory
local function ls_command(directory, ignore_hidden_items)
return Command("ls")
:args({
directory,
ignore_hidden_items and "-1p" or "-1pA",
"--group-directories-first",
})
:stdout(Command.PIPED)
:stderr(Command.PIPED)
:output()
end
-- Function to skip child directories with only one directory
local function skip_single_child_directories(args, config, initial_directory)
-- If the user doesn't want to skip single subdirectories on enter,
-- or one of the arguments passed is no skip,
-- then exit the function
if not config.skip_single_subdirectory_on_enter or args.no_skip then
return
end
-- Initialise the directory variable to the initial directory given
local directory = initial_directory
-- Start an infinite loop
while true do
-- Run the ls command to get the items in the directory
local output, _ = ls_command(directory, config.ignore_hidden_items)
-- If there is no output, then break out of the loop
if not output then break end
-- Get the list of items in the directory
local directory_items = string_split(output.stdout, "\n")
-- If the number of directory items is not 1,
-- then break out of the loop
if #directory_items ~= 1 then break end
-- Otherwise, get the item in the directory
local directory_item = table.unpack(directory_items)
-- Match the directory item against the pattern to
-- check if it is a directory
directory_item = directory_item:match(is_directory_pattern)
-- If the directory item isn't a directory, break the loop
if directory_item == nil then break end
-- Otherwise, set the directory to the inner directory
directory = directory .. "/" .. directory_item
end
-- Emit the change directory command to change to the directory variable
ya.manager_emit("cd", { directory })
end
-- Function to handle the open command
local function handle_open(args, config, command_table)
-- Call the function to get the item group
local item_group = get_item_group()
-- If no item group is returned, exit the function
if not item_group then return end
-- If the item group is the selected items,
-- then execute the command and exit the function
if item_group == ItemGroup.Selected then
-- Emit the command and exit the function
return ya.manager_emit("open", args)
end
-- Otherwise, the item group is the hovered item.
-- Get the function to handle the enter command.
local enter_command = command_table[Commands.Enter]
-- If the hovered item is a directory
if hovered_item_is_dir() then
-- If smart enter is wanted,
-- calls the function to enter the directory
-- and exit the function
if config.smart_enter then
return enter_command(args, config, command_table)
-- Otherwise, just exit the function
else return end
end
-- Otherwise, if the hovered item is not an archive,
-- or entering archives isn't wanted
if not hovered_item_is_archive() or not config.enter_archives then
-- Simply emit the open command and exit the function
return ya.manager_emit("open", args)
end
-- Otherwise, the hovered item is an archive
-- and entering archives is wanted,
-- so get the path of the hovered item
local archive_path = get_hovered_item_path()
-- If the archive path somehow doesn't exist, then exit the function
if not archive_path then return end
-- Run the command to extract the archive
local output, err = Command("unar")
:args({
"-d",
ExtractBehaviourFlags[config.extract_behaviour],
archive_path
})
:stdout(Command.PIPED)
:stderr(Command.PIPED)
:output()
-- If the command isn't successful, notify the user
if not output then
return ya.notify(merge_tables(DEFAULT_NOTIFICATION_OPTIONS, {
content = "Failed to extract archive at: "
.. archive_path
.. "\nError code: "
.. tostring(err),
level = "error"
}))
end
-- Get the filename of the archive
local archive_filename = archive_path:match(get_filename_pattern)
-- Enter the archive directory
ya.manager_emit("cd", { archive_filename })
-- Calls the function to skip child directories
-- with only a single directory inside
skip_single_child_directories(args, config, archive_filename)
end
-- Function to handle the enter command
local function handle_enter(args, config, command_table)
-- Get the function for the open command
local open_command = command_table[Commands.Open]
-- If the hovered item is not a directory
if not hovered_item_is_dir() and config.smart_enter then
-- If smart enter is wanted,
-- call the function for the open command
-- and exit the function
if config.smart_enter then
return open_command(args, config, command_table)
-- Otherwise, just exit the function
else return end
end
-- Otherwise, always emit the enter command,
ya.manager_emit("enter", args)
-- Calls the function to skip child directories
-- with only a single directory inside
skip_single_child_directories(args, config, get_current_directory())
end
-- Function to handle the leave command
local function handle_leave(args, config)
-- Always emit the leave command
ya.manager_emit("leave", args)
-- If the user doesn't want to skip single subdirectories on leave,
-- or one of the arguments passed is no skip,
-- then exit the function
if not config.skip_single_subdirectory_on_leave or args.no_skip then
return
end
-- Otherwise, initialise the directory to the current directory
local directory = get_current_directory()
-- Otherwise, start an infinite loop
while true do
-- Run the ls command to get the items in the directory
local output, _ = ls_command(directory, config.ignore_hidden_items)
-- If there is no output, then break out of the loop
if not output then break end
-- Get the list of items in the directory
local directory_items = string_split(output.stdout, "\n")
-- If the number of directory items is not 1,
-- then break out of the loop
if #directory_items ~= 1 then break end
-- Otherwise, set the new directory
-- to the parent of the current directory
directory = directory:match(get_parent_directory_pattern)
end
-- Emit the change directory command to change to the directory variable
ya.manager_emit("cd", { directory })
end
-- Function to handle the a command
local function handle_command(command, args)
-- Call the function to get the item group
local item_group = get_item_group()
-- If no item group is returned, exit the function
if not item_group then return end
-- If the item group is the selected items
if item_group == ItemGroup.Selected then
-- Emit the command to operate on the selected items
ya.manager_emit(command, args)
-- If the item group is the hovered item
elseif item_group == ItemGroup.Hovered then
-- Emit the command with the hovered option
ya.manager_emit(command, merge_tables(args, { hovered = true }))
-- Otherwise, exit the function
else return end
end
-- Function to handle a shell command
local function handle_shell_command(command, args)
-- Call the function to get the item group
local item_group = get_item_group()
-- If no item group is returned, exit the function
if not item_group then return end
-- If the item group is the selected items
if item_group == ItemGroup.Selected then
-- Merge the arguments for the shell command with additional ones
args = merge_tables({
command .. " $@",
confirm = true,
block = true,
}, args)
-- Emit the command to operate the selected items
ya.manager_emit("shell", args)
-- If the item group is the hovered item
elseif item_group == ItemGroup.Hovered then
-- Merge the arguments for the shell command with additional ones
args = merge_tables({
command .. " $0",
confirm = true,
block = true,
}, args)
-- Emit the command to operate on the hovered item
ya.manager_emit("shell", args)
-- Otherwise, exit the function
else return end
end
-- Function to handle the paste command
local function handle_paste(args, config)
-- If the hovered item is a directory and smart paste is wanted
if hovered_item_is_dir() and (config.smart_paste or args.smart) then
-- Enter the directory
ya.manager_emit("enter", {})
-- Paste the items inside the directory
ya.manager_emit("paste", args)
-- Leave the directory
ya.manager_emit("leave", {})
-- Otherwise, just paste the items inside the current directory
else
ya.manager_emit("paste", args)
end
end
-- Function to do the wraparound for the arrow command
local wraparound_arrow = ya.sync(function(_, args)
-- Get the current tab
local current_tab = cx.active.current
-- Get the step from the arguments given
local step = table.remove(args, 1)
-- Get the number of files in the current tab
local number_of_files = #current_tab.files
-- If there are no files in the current tab, exit the function
if number_of_files == 0 then return end
-- Get the new cursor index,
-- which is the current cursor position plus the step given
-- to the arrow function, modulus the number of files in
-- the current tab
local new_cursor_index = (current_tab.cursor + step) % number_of_files
-- Emit the arrow function with the new cursor index minus
-- the current cursor index to determine how to move the cursor
ya.manager_emit("arrow", merge_tables(
args,
{ new_cursor_index - current_tab.cursor }
))
end)
-- Function to handle the arrow command
local function handle_arrow(args, config)
-- If wraparound file navigation isn't wanted,
-- then execute the arrow command
if not config.wraparound_file_navigation then
ya.manager_emit("arrow", args)
-- Otherwise, call the wraparound arrow function
else wraparound_arrow(args) end
end
-- Function to execute the parent arrow command
local execute_parent_arrow_command = ya.sync(
function(state, args, number_of_directories)
-- Gets the parent directory
local parent_directory = cx.active.parent
-- If the parent directory doesn't exist,
-- then exit the function
if not parent_directory then return end
-- Get the step from the arguments given
local step = table.remove(args, 1)
-- Initialise the new cursor index
-- to the current parent cursor index
local new_cursor_index = parent_directory.cursor
-- Otherwise, if wraparound file navigation is wanted
-- and the number of directories is given and isn't 0
if
state.config.wraparound_file_navigation
and number_of_directories
and number_of_directories ~= 0
then
-- Get the new cursor index by adding the step,
-- and modding the whole thing by the number of
-- directories given.
new_cursor_index = (parent_directory.cursor + step)
% number_of_directories
else
-- Otherwise, get the new cursor index normally.
new_cursor_index = parent_directory.cursor + step
end
-- Increment the cursor index by 1.
-- The cursor index needs to be increased by 1
-- as the cursor index is 0-based, while Lua
-- tables are 1-based.
new_cursor_index = new_cursor_index + 1
-- Get the target directory
local target_directory = parent_directory.files[new_cursor_index]
-- If the target directory exists and is a directory
if target_directory and target_directory.cha.is_dir then
-- Emit the command to change directory
-- to the target directory
ya.manager_emit("cd", { target_directory.url })
end
end
)
-- Function to handle the parent arrow command
local function handle_parent_arrow(args, config)
-- If wraparound file navigation isn't wanted,
-- then execute the parent arrow command and exit the function
if not config.wraparound_file_navigation then
return execute_parent_arrow_command(args)
end
-- Otherwise, get the path of the parent directory
local parent_directory_path = get_parent_directory()
-- If there is no parent directory, exit the function
if not parent_directory_path then return end
-- Call the ls command to get the number of directories
local output, _ = ls_command(
parent_directory_path,
config.ignore_hidden_items
)
-- If there is no output, exit the function
if not output then return end
-- Get the item in the parent directory
local directory_items = string_split(output.stdout, "\n")
-- Initialise the number of directories
local number_of_directories = 0
-- Iterate over the directory items
for _, item in ipairs(directory_items) do
-- If the item is a directory
if item:match(is_directory_pattern) then
-- Increment the number of directories by 1
number_of_directories = number_of_directories + 1
-- Otherwise, break out of the loop,
-- as the directories are grouped together
else break end
end
-- Call the function to execute the parent arrow command
execute_parent_arrow_command(args, number_of_directories)
end
-- Function to handle the pager command
local function handle_pager(args)
-- Call the function to get the item group
local item_group = get_item_group()
-- If no item group is returned, exit the function
if not item_group then return end
-- If the item group is the selected items,
-- then execute the command and exit the function
if item_group == ItemGroup.Selected then
-- Combine the arguments with additional ones
args = merge_tables({
"$PAGER $@",
confirm = true,
block = true
}, args)
-- Emit the command and exit the function
return ya.manager_emit("shell", args)
end
-- Otherwise, the item group is the hovered item,
-- and if the hovered item is a directory, exit the function
if hovered_item_is_dir() then return
-- Otherwise
else
-- Combine the arguments with additional ones
args = merge_tables({
"$PAGER $0",
confirm = true,
block = true
}, args)
-- Emit the command and exit the function
return ya.manager_emit("shell", args)
end
end
-- Function to run the commands given
local function run_command_func(command, args, config)
-- The command table
local command_table = {
[Commands.Open] = handle_open,
[Commands.Enter] = handle_enter,
[Commands.Leave] = handle_leave,
[Commands.Rename] = function(_)
handle_command("rename", args)
end,
[Commands.Remove] = function(_)
handle_command("remove", args)
end,
[Commands.Paste] = handle_paste,
[Commands.Arrow] = handle_arrow,
[Commands.ParentArrow] = handle_parent_arrow,
[Commands.Editor] = function(_)
handle_shell_command("$EDITOR", args)
end,
[Commands.Pager] = handle_pager,
}
-- Get the function for the command
local command_func = command_table[command]
-- If the function isn't found, notify the user and exit the function
if not command_func then
return ya.notify(
merge_tables(DEFAULT_NOTIFICATION_OPTIONS, {
content = "Unknown command: " .. command,
level = "error"
})
)
end
-- Parse the arguments and set it to the args variable
args = parse_args(args)
-- Otherwise, call the function for the command
command_func(args, config, command_table)
end
-- The setup function to setup the plugin
local function setup(_, opts)
-- Initialise the configuration with the default configuration
initialise_config(opts)
end
-- The function to be called to use the plugin
local function entry(_, args)
-- Gets the command passed to the plugin
local command = args[1]
-- If the command isn't given, exit the function
if not command then return end
-- Gets the configuration object
local config = get_config()
-- If the configuration hasn't been initialised,
-- then initialise the configuration
if not config then
config = initialise_config()
end
-- Call the function to handle the commands
run_command_func(command, args, config)
end
-- Returns the table required for Yazi to run the plugin
return {
setup = setup,
entry = entry,
}