doryan/dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add plugins for zsh

Browse Source
This commit is contained in:
doryan
2024-09-22 20:14:22 +04:00
parent f4c1c54e72
commit 6c85cc3b71
515 changed files with 30838 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
.zsh/zsh-you-should-use/.circleci/config.yml Normal file
View File

@@ -0,0 +1,95 @@
version: 2
test: &test
steps:
- checkout
- run:
name: Install Dependencies
command: apt-get update && apt-get install -y curl git ncurses-bin
- run:
name: Download requirements
command: |
mkdir -p ~/bin
curl -L https://raw.githubusercontent.com/molovo/revolver/master/revolver > ~/bin/revolver
curl -L https://github.com/molovo/zunit/releases/download/v0.8.2/zunit > ~/bin/zunit
chmod u+x ~/bin/{revolver,zunit}
- run:
name: Run Zunit
command: |
export TERM="xterm-256color"
export PATH="$HOME/bin:$PATH"
zunit --verbose
jobs:
lint:
docker:
- image: "python:3.7-stretch"
steps:
- checkout
- run:
name: run restructuredtext linter
command: |
pip install restructuredtext_lint pygments
rst-lint *.rst
test-zsh-5.1:
docker:
- image: "zshusers/zsh:5.1"
<<: *test
test-zsh-5.2:
docker:
- image: "zshusers/zsh:5.2"
<<: *test
test-zsh-5.3:
docker:
- image: "zshusers/zsh:5.3"
<<: *test
test-zsh-5.4:
docker:
- image: "zshusers/zsh:5.4"
<<: *test
test-zsh-5.5:
docker:
- image: "zshusers/zsh:5.5"
<<: *test
test-zsh-5.6:
docker:
- image: "zshusers/zsh:5.6"
<<: *test
test-zsh-5.7:
docker:
- image: "zshusers/zsh:5.7"
<<: *test
test-zsh-5.8:
docker:
- image: "zshusers/zsh:5.8"
<<: *test
test-zsh-5.9:
docker:
- image: "zshusers/zsh:5.9"
<<: *test
workflows:
version: 2
test:
jobs:
- lint
- test-zsh-5.1
- test-zsh-5.2
- test-zsh-5.3
- test-zsh-5.4
- test-zsh-5.5
- test-zsh-5.6
- test-zsh-5.7
- test-zsh-5.8
- test-zsh-5.9

3
.zsh/zsh-you-should-use/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
*.orig
*.swp
.venv

135
.zsh/zsh-you-should-use/CHANGELOG.md Normal file
View File

@@ -0,0 +1,135 @@
Changelog for zsh-you-should-use
================================
1.9.0
-----
* massive performance improvement to `check_alias_usage` #139 (Thanks @AtifChy!)
* remove dependency on `wc`
1.8.0
-----
* Fix bug in `check_alias_usage` command which would spam `entry=` to stdout
1.7.5
-----
* Minor optimization to the way global aliases are checked (#135)
1.7.4
-----
* Fix test failures when key and value are not split correctly (#132)
1.7.3
-----
* Fix further issue where local variables would leak into users environment
1.7.2
-----
* Fix issue where `key` and `entry` variables would leak into users environment
1.7.1
-----
* Fix issue where \ and % would not be escaped correctly in messages (Issue #98)
1.7.0
-----
* Add support for ignoring global aliases
1.6.1
-----
* Fix detection of substrings with global aliases (#91)
1.6.0
-----
* Revert smart alias expansion detection feature from 1.5.0 release as it is causing numerous regressions
1.5.2
-----
* Fix bug in 1.5.0 where an alias would be recommended even though it had just been typed by the user
1.5.1
-----
* Temporary revert of 1.5.0 which causes a major bug in alias detection (see #84)
1.5.0
-----
* Suggest better available aliases if a user uses another alias (issue #79)
1.4.0
-----
* Aliases reminders are no longer shown if running commands with sudo
1.3.0
-----
* Add `check_alias_usage` function to generate report of aliases being used by user
1.2.1
-----
* Fix minor bug where variables would pollute user's environment
1.2.0
-----
* Add support for ignoring aliases
1.1.0
-----
* git aliases with parameters are now correctly matched (Thanks @crater2150)
1.0.0
-----
* Add ability to display reminder message *before* or *after* a command is executed
0.7.3
-----
* Fix Default message format conflicting with autoswitch-virtualenv plugin
0.7.2
-----
* Use type builtin to check if tput command is available
0.7.1
-----
* Suppress error messages showing when tput is not installed
0.7.0
-----
* Use tput command instead of raw escape codes
0.6.0
-----
* Improved colouring for default message
0.5.1
-----
* Minor fixes and updates to README.
0.5.0
-----
* Add functions to temporarily disable (and re-enable) you-should-use
0.4.4
-----
* export you-should-use version
0.4.3
-----
* Use yellow messages by default
0.4.2
-----
* Specify LICENSE (GPLv3)
0.4.1
-----
* Only use default message format if `$YSU_MESSAGE_FORMAT` is unset
0.4.0
-----
* Introduce CHANGELOG
* Add ability to change message output on alias detection
* Add index to README for quick navigation
0.3.2
-----
* Fixed bug in best match algorithm (see #34)

20
.zsh/zsh-you-should-use/ISSUE_TEMPLATE.md Normal file
View File

@@ -0,0 +1,20 @@
# Issue Details
Please provide the following details when opening an issue:
## Operating System (uname -a)
## zsh version (zsh --version)
## you-should-use version (echo "$YSU_VERSION")
## How is zsh-you-should-use installed?
- [ ] zplug
- [ ] oh-my-zsh
- [ ] Antigen
- [ ] Other (please specify)
## Steps to reproduce the issue
## gist link to your zshrc

241
.zsh/zsh-you-should-use/LICENSE Normal file
View File

@@ -0,0 +1,241 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://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 <http://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 <http://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 <http://www.gnu.org/philosophy/why-not-lgpl.html>.

342
.zsh/zsh-you-should-use/README.rst Normal file
View File

@@ -0,0 +1,342 @@
You Should Use
==============
|CircleCI| |Version| |GPLv3|
Simple zsh plugin that reminds you that you should use one of your
existing aliases for a command you just typed.
Also supports detection of global and git aliases.
* Usage_
* Requirements_
* Installation_
Customization
* `Message Position`_
* `Displaying Results`_
* `Customising Messages`_
Advanced Features
* `Hardcore Mode`_
* `Check your Alias usage`_
* `Disable Hints for specific Aliases`_
* `Temporarily Disabling Messages`_
Contributing
* Contributing_
* `Running Tests`_
You can also view the CHANGELOG_ for a history of changes.
Usage
-----
You dont need to do anything. Once it's installed,
``zsh-you-should-use`` will let you know if you wrote a command with an
existing alias.
.. image:: img/alias.png
``you-should-use`` also detects global aliases:
.. image:: img/global.png
and Git aliases:
.. image:: img/git.png
Requirements
------------
``you-should-use`` officially supports zsh versions 5.1 onwards.
It is possible the plugin might work on even older versions.
However they would not have been tested as part of the CI test process.
Installation
------------
Add one of the following to your ``.zshrc`` file depending on your
package manager:
ZPlug_
::
zplug "MichaelAquilina/zsh-you-should-use"
Antigen_
::
antigen bundle "MichaelAquilina/zsh-you-should-use"
Zgen_
::
zgen load "MichaelAquilina/zsh-you-should-use"
oh-my-zsh_
Clone this repository into ``$ZSH_CUSTOM/custom/plugins``:
.. code-block:: sh
git clone https://github.com/MichaelAquilina/zsh-you-should-use.git $ZSH_CUSTOM/plugins/you-should-use
``$ZSH_CUSTOM`` is oh-my-zsh’s customization directory (`docs <https://github.com/robbyrussell/oh-my-zsh/wiki/Customization/>`__).
Then add ``you-should-use`` to the ``plugins`` array in your ``.zshrc``:
.. code-block:: sh
plugins=(
# ...
you-should-use
# ...
)
`Arch Linux`_
Install the ``zsh-you-should-use`` (AUR_) package::
yay -S zsh-you-should-use
Then add this line to your ``.zshrc``::
source /usr/share/zsh/plugins/zsh-you-should-use/you-should-use.plugin.zsh
Message Position
----------------
By default, ``you-should-use`` will display its reminder message *before*
a command has executed. However, you can choose to display the mesasge *after* a
command has executed by setting the value of ``YSU_MESSAGE_POSITION``.
::
export YSU_MESSAGE_POSITION="after"
Displaying Results
------------------
By default, ``you-should-use`` will display the best match from any
matching aliases found. However, you can change this behaviour so that
it displays *all* matches found by setting the value of ``YSU_MODE``.
- To only display best match (default): ``export YSU_MODE=BESTMATCH``
- To display all matches: ``export YSU_MODE=ALL``
Customising Messages
--------------------
By default, the following message is displayed in bold when an alias is found:
::
Found existing %alias_type for "%command". You should use: "%alias"
Where the following variables represent:
* ``%alias_type`` - the type of alias detected (alias, git alias, global alias)
* ``%command`` - the command that was typed by the user
* ``%alias`` - the matching alias that was found
This default message can be customised by setting the ``YSU_MESSAGE_FORMAT`` environment variable.
If for example, you wish to display your own custom message in red, you can add the
following to your ``~/.zshrc``:
::
export YSU_MESSAGE_FORMAT="$(tput setaf 1)Hey! I found this %alias_type for %command: %alias$(tput sgr0)"
``$(tput setaf 1)`` generates the escape code terminals use for red foreground text. ``$(tput sgr0)`` sets
the text back to a normal color.
You can read more about how you can use tput and terminal escape codes here:
http://wiki.bash-hackers.org/scripting/terminalcodes
Hardcore Mode
-------------
**For the brave and adventerous only** :godmode:
You can enable Hardcore mode to enforce the use of aliases. Enabling
this will cause zsh to refuse to execute commands you have entered if an
alternative alias for it exists. This is a handy way of forcing you to
use your aliases and help you turn those aliases into muscle memory.
Enable hardcore mode by setting the variable ``YSU_HARDCORE`` to 1.
::
export YSU_HARDCORE=1
Now if you type a command that has an alias defined and you didnt use
it, zsh will refuse to execute that command:
::
$ export YSU_HARDCORE=1
$ ls -lh
Found existing alias for "ls -lh". You should use: "ll"
You Should Use hardcore mode enabled. Use your aliases!
$ ll
total 8.0K
-rw-r--r-- 1 michael users 2.4K Jun 19 20:46 README.md
-rw-r--r-- 1 michael users 650 Jun 19 20:42 you-should-use.plugin.zsh
Check your Alias usage
----------------------
It's often useful to check how often we use our aliases so that we have an idea of which ones we
could probably get rid of (or remind ourselves of them if we forgot). ``zsh-you-should-use`` provides
a convenience function ``check_alias_usage`` which you can run to analyse your alias usage.
::
$ check_alias_usage
924: curl='curl --silent'
652: gco='git checkout'
199: json='jq '.' -C'
157: less='less -R'
100: ll='ls -lh --group-directories-first'
93: vim='nvim'
76: watch='watch '
61: v='vim'
60: md='mkdir'
39: gr='git rebase'
38: dc='docker-compose'
35: ls='ls --color=auto'
33: h='history'
28: dcr='docker-compose
``check_alias_usage`` analyses your history to generate this data for you. If your history is disabled
or if you limit your history to a certain amount of time, then the alias report generated will be a reflection
of the limited data available.
Optionally, you can limit how far ``check_alias_usage`` looks back in history by providing an optional numeric
parameter. This parameter specifies how many entries in the history to check when generating the report.
In the example below, history is limited to the last 200 entries when generating the alias report.
::
$ check_alias_usage 200
9: h='history'
3: gpoh='git push -u origin HEAD'
3: gco='git checkout'
2: v='vim'
2: ll='ls -lh --group-directories-first'
2: gpohw='gpoh && git web --pull-request'
2: gc='git commit'
2: gap='git add -p'
2: ap='ansible-playbook'
1: xopen='GDK_BACKEND=wayland xdg-open'
1: t='tig'
1: gw='git web'
1: gs='git status'
Disable Hints for specific Aliases
----------------------------------
You can tell ``you-should-use`` to permanently ignore certain aliases by including them in the ``YSU_IGNORED_ALIASES`` variable (which is an array):
::
$ ls -l
Found existing alias for "ls -l". You should use: "ll"
$ export YSU_IGNORED_ALIASES=("g" "ll")
$ ls -l
If you want to ignore global aliases, use the ``YSU_IGNORED_GLOBAL_ALIASES`` environment variable.
::
$ cd ../..
Found existing global alias for "../..". You should use: "..."
$ export YSU_IGNORED_GLOBAL_ALIASES=("...")
$ cd ../..
Temporarily Disabling Messages
------------------------------
You can temporarily disable you should use by running the command ``disable_you_should_use``.
When you want to re-enable messages, run the command ``enable_you_should_use``.
Contributing
------------
Pull requests and Feedback are welcome! :tada:
I have tried to cater for as many use cases that I can think of.
However, they are naturally tailored to to my own workflow and I could
be missing many others.
Because of this if there is a specific use case that does not work as
you would expect or if you have any suggestions to how the plugin should
behave, feel free to `open an
issue <https://github.com/MichaelAquilina/zsh-you-should-use/issues/new>`__
Running Tests
-------------
Install `zunit <https://zunit.xyz/>`__. Run ``zunit`` in the root
directory of the repo.
::
$ zunit
Launching ZUnit
ZUnit: 0.8.2
ZSH: zsh 5.3.1 (x86_64-suse-linux-gnu)
✔ ysu message correct output
✔ ysu global message correct output
✔ ysu git message correct output
NOTE: It is required that you use a minimum zunit version of 0.8.2
NOTE: The tests that run move your git configuration to a temporary
location during the test process so that your user configuration does
not interfere with tests. This will be restored at the end of each test
so there is no risk in losing your settings. If for some strange reason
zunit crashes or does not restore your git configuration automatically,
all you need to do is run ``mv ~/.gitconfig.bak ~/.gitconfig``
.. _Zplug: https://github.com/zplug/zplug
.. _Antigen: https://github.com/zsh-users/antigen
.. _ZGen: https://github.com/tarjoilija/zgen
.. _Fig: https://fig.io
.. _oh-my-zsh: https://github.com/robbyrussell/oh-my-zsh
.. _Arch Linux: https://www.archlinux.org/
.. _AUR: https://aur.archlinux.org/packages/zsh-you-should-use/
.. _CHANGELOG: CHANGELOG.md
.. |GPLv3| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
.. |CircleCI| image:: https://circleci.com/gh/MichaelAquilina/zsh-you-should-use.svg?style=svg
:target: https://circleci.com/gh/MichaelAquilina/zsh-you-should-use
.. |Version| image:: https://badge.fury.io/gh/MichaelAquilina%2Fzsh-you-should-use.svg
:target: https://badge.fury.io/gh/MichaelAquilina%2Fzsh-you-should-use

BIN
.zsh/zsh-you-should-use/img/alias.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
.zsh/zsh-you-should-use/img/git.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
.zsh/zsh-you-should-use/img/global.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

170
.zsh/zsh-you-should-use/tests/test_aliases.zunit Normal file
View File

@@ -0,0 +1,170 @@
#!/usr/bin/env zunit
@setup {
load "../you-should-use.plugin.zsh"
# Simplify format for tests
YSU_MESSAGE_FORMAT='Found existing %alias_type for "%command". You should use: "%alias"'
unset YSU_MESSAGE_POSITION
}
@teardown {
}
@test 'aliases no match' {
export YSU_MODE="ALL"
alias ls="less -R"
run _check_aliases "less"
assert "$output" is_empty
assert $state equals 0
}
@test 'aliases longer or the same length as their commands are ignored' {
export YSU_MODE="ALL"
alias longalias='ls -lA'
alias ls_-lA='ls -lA'
run _check_aliases "ls -lA"
assert "$output" is_empty
assert $state equals 0
}
@test 'aliases match - all with alphabetical ordering' {
export YSU_MODE="ALL"
alias c="git status -v"
alias a="git status"
alias b="git"
run _check_aliases "git status -v"
assert $lines[1] contains 'Found existing alias for "git status". You should use: "a"'
assert $lines[2] contains 'Found existing alias for "git". You should use: "b"'
assert $lines[3] contains 'Found existing alias for "git status -v". You should use: "c"'
assert $state equals 0
}
@test 'aliases bestmatch default' {
unset YSU_MODE
alias gs="git status"
alias g="git"
run _check_aliases "git status -v"
assert "$output" contains 'Found existing alias for "git status". You should use: "gs"'
assert $state equals 0
}
@test 'aliases bestmatch - chooses longest matching alias value' {
export YSU_MODE="BESTMATCH"
alias gs="git status"
alias g="git"
alias gsv="git status -v"
run _check_aliases "git status -v"
assert "$output" contains 'Found existing alias for "git status -v". You should use: "gsv"'
assert $state equals 0
}
@test 'aliases bestmatch - chooses longest matching alias value case 2' {
export YSU_MODE="BESTMATCH"
alias gco="git checkout"
alias gcom="git checkout master"
run _check_aliases "git checkout master"
assert "$output" contains 'Found existing alias for "git checkout master". You should use: "gcom"'
assert $state equals 0
}
@test 'aliases bestmatch - chooses shortest alias key on equal value lengths' {
export YSU_MODE="BESTMATCH"
alias v="vim"
alias nvim="vim"
run _check_aliases "vim"
assert "$output" contains 'Found existing alias for "vim". You should use: "v"'
assert $state equals 0
}
@test 'aliases ignore if sudo' {
unset YSU_MODE
alias gs="git status"
run _check_aliases "sudo git status -v"
assert "$output" is_empty
assert $state equals 0
}
@test 'aliases exact match' {
export YSU_MODE="ALL"
alias hu='hg update'
run _check_aliases 'hg update'
assert "$output" contains 'Found existing alias for "hg update". You should use: "hu"'
assert $state equals 0
}
@test 'aliases substring match' {
export YSU_MODE="ALL"
alias hu='hg update'
run _check_aliases 'hg update -all'
assert "$output" contains 'Found existing alias for "hg update". You should use: "hu"'
assert $state equals 0
}
@test 'aliases ignores - does not report an ignored alias' {
export YSU_MODE="ALL"
export YSU_IGNORED_ALIASES=("something" "e" "else")
alias e="echo"
alias l="ls"
run _check_aliases "echo hello"
assert $output is_empty
assert $state equals 0
}
@test 'aliases ignores only - only ignores specified aliases' {
export YSU_MODE="ALL"
export YSU_IGNORED_ALIASES=("something" "else")
alias e="echo"
alias l="ls"
run _check_aliases "echo hello"
assert $output contains 'Found existing alias for "echo"'
assert $state equals 0
}
@test 'dont display recommendations for an alias if it is used' {
alias hu='hg update'
run _check_aliases 'hu' 'hg update'
assert "$output" is_empty
assert $state equals 0
}
@test 'dont display recommendations for an alias if it is used - 2' {
alias eh='echo hello'
run _check_aliases 'eh world' 'echo hello world'
assert "$output" is_empty
assert $state equals 0
}
@test 'dont display recommendations for an alias if it is used - 4' {
alias ..='cd ..'
alias cd..='cd ..'
run _check_aliases '..' 'cd ..'
assert "$output" is_empty
assert $state equals 0
}
@test 'dont display recommendations for an alias if it is used - 3' {
alias ls='ls --color=auto'
alias ll='ls -lh --group-directories-first'
run _check_aliases 'll' 'ls --color=auto -lh --group-directories-first'
assert "$output" is_empty
assert $state equals 0
}

53
.zsh/zsh-you-should-use/tests/test_buffer.zunit Normal file
View File

@@ -0,0 +1,53 @@
#!/usr/bin/env zunit
@setup {
load "../you-should-use.plugin.zsh"
unset YSU_MESSAGE_POSITION
_YSU_BUFFER=""
}
@teardown {
rm -f output.txt
}
# We work around not being able to use `run` AND test variable values by redirecting
# all output to a temporary file from which we can read.
@test 'ysu - _write_ysu_buffer before' {
YSU_MESSAGE_POSITION="before"
export _YSU_BUFFER
_write_ysu_buffer "hello world" 2> output.txt
assert $state equals 0
assert "$(< output.txt)" same_as "hello world"
assert "$_YSU_BUFFER" is_empty
}
@test 'ysu - _write_ysu_buffer after' {
YSU_MESSAGE_POSITION="after"
export _YSU_BUFFER
_write_ysu_buffer "hello world" 2> output.txt
assert $state equals 0
assert "$(< output.txt)" is_empty
assert "$_YSU_BUFFER" same_as "hello world"
}
@test 'ysu - _write_ysu_buffer invalid' {
YSU_MESSAGE_POSITION="invalid"
export _YSU_BUFFER
_write_ysu_buffer "" 2> output.txt
assert $state equals 0
expected="$(tput setaf 1)$(tput bold)Unknown value for YSU_MESSAGE_POSITION 'invalid'. "
expected+="Expected value 'before' or 'after'$(tput sgr0)\n"
assert "$(< output.txt)" same_as "$expected"
assert "$_YSU_BUFFER" is_empty
}

83
.zsh/zsh-you-should-use/tests/test_git_aliases.zunit Normal file
View File

@@ -0,0 +1,83 @@
#!/usr/bin/env zunit
@setup {
load "../you-should-use.plugin.zsh"
YSU_MESSAGE_FORMAT='Found existing %alias_type for "%command". You should use: "%alias"'
unset YSU_MESSAGE_POSITION
if [[ ! -f ~/.gitconfig ]]; then
touch ~/.gitconfig
fi
# Remove use git configuration which may interfere with tests
mv ~/.gitconfig ~/.gitconfig.bak
touch ~/.gitconfig
}
@teardown {
# Restore users git configuration
mv ~/.gitconfig.bak ~/.gitconfig
}
@test 'git aliases not triggered by aliased git commands' {
git config --global alias.co checkout
run _check_git_aliases "gco" "git checkout"
assert $state equals 0
assert "$output" is_empty
}
@test 'git aliases not triggred by non git commands' {
git config --global alias.cp cherry-pick
run _check_git_aliases "ls -l" "ls -l"
assert $state equals 0
assert "$output" is_empty
}
@test 'git aliases no match' {
run _check_git_aliases "git config --list" "git config --list"
assert "$output" is_empty
assert $state equals 0
}
@test 'git aliases substring match' {
git config --global alias.cfg config
run _check_git_aliases "git config --list" "git config --list"
assert "$output" contains 'Found existing git alias for "config". You should use: "git cfg"'
assert $state equals 0
}
@test 'git aliases ignore on sudo' {
git config --global alias.cfg config
run _check_git_aliases "sudo git config --list" "sudo git config --list"
assert "$output" is_empty
assert $state equals 0
}
@test 'git aliases exact match' {
git config --global alias.st status
run _check_git_aliases "git status" "git status"
assert "$output" contains 'Found existing git alias for "status". You should use: "git st"'
assert $state equals 0
}
@test 'git aliases match parameters' {
git config --global alias.recommit "commit --amend --reuse-message=HEAD"
run _check_git_aliases "git commit --amend --reuse-message=HEAD" "git commit --amend --reuse-message=HEAD"
assert "$output" contains 'Found existing git alias for "commit --amend --reuse-message=HEAD". You should use: "git recommit"'
assert $state equals 0
}
@test 'git aliases not triggered when parameters are different' {
git config --global alias.recommit "commit --amend --reuse-message=HEAD"
run _check_git_aliases "git commit" "git commit"
assert "$output" is_empty
assert $state equals 0
}

53
.zsh/zsh-you-should-use/tests/test_global_aliases.zunit Normal file
View File

@@ -0,0 +1,53 @@
#!/usr/bin/env zunit
@setup {
load "../you-should-use.plugin.zsh"
# Simplify format for tests
YSU_MESSAGE_FORMAT='Found existing %alias_type for "%command". You should use: "%alias"'
unset YSU_MESSAGE_POSITION
}
@teardown {
}
@test 'global aliases no match' {
alias -g hw="Hello World!"
run _check_global_aliases "echo 'hello'"
assert "$output" is_empty
assert $state equals 0
}
@test 'global aliases match' {
alias -g NE="2>/dev/null"
run _check_global_aliases "echo 'hello' 2>/dev/null"
assert "$output" contains 'Found existing global alias for "2>/dev/null". You should use: "NE"'
assert $state equals 0
}
@test 'test doesnt match substrings' {
alias -g n="nvim"
run _check_global_aliases "nvimkaowjqwe"
assert "$output" is_empty
assert $state equals 0
}
@test 'global aliases ignore on sudo' {
alias -g NE="2>/dev/null"
run _check_global_aliases "sudo echo 'hello' 2>/dev/null"
assert "$output" is_empty
assert $state equals 0
}
@test 'global aliases - does not report an ignored alias' {
export YSU_MODE="ALL"
export YSU_IGNORED_GLOBAL_ALIASES=("..." "NE")
alias -g ...="../.."
run _check_global_aliases "cd ../.."
assert $output is_empty
assert $state equals 0
}

107
.zsh/zsh-you-should-use/tests/test_you_should_use.zunit Normal file
View File

@@ -0,0 +1,107 @@
#!/usr/bin/env zunit
@setup {
load "../you-should-use.plugin.zsh"
unset YSU_MESSAGE_POSITION
}
@test 'ysu version exported' {
git_version="$(git tag --list | sort | tail -1)"
git tag --list
assert "$YSU_VERSION" is_not_empty
assert "$YSU_VERSION" same_as "$git_version"
}
@test 'ysu preexec functions are loaded by default' {
assert '_check_aliases' in $preexec_functions
assert '_check_git_aliases' in $preexec_functions
assert '_check_global_aliases' in $preexec_functions
assert '_flush_ysu_buffer' in $precmd_functions
}
@test 'ysu disable/enable functions' {
disable_you_should_use
assert '_check_aliases' not_in $preexec_functions
assert '_check_git_aliases' not_in $preexec_functions
assert '_check_global_aliases' not_in $preexec_functions
assert '_flush_ysu_buffer' not_in $precmd_functions
enable_you_should_use
assert '_check_aliases' in $preexec_functions
assert '_check_git_aliases' in $preexec_functions
assert '_check_global_aliases' in $preexec_functions
assert '_flush_ysu_buffer' in $precmd_functions
}
@test 'ysu message correct output' {
unset YSU_MESSAGE_FORMAT
run ysu_message "alias" "ls -l" "ll"
assert $state equals 0
expected="$(tput bold)$(tput setaf 3)Found existing alias for $(tput setaf 5)\"ls -l\"$(tput setaf 3). "
expected+="You should use: $(tput setaf 5)\"ll\"$(tput sgr0)"
assert "$output" same_as "$expected"
}
@test 'ysu message correct output 2' {
unset YSU_MESSAGE_FORMAT
run ysu_message "foobar" "2>/dev/null" "NE"
assert $state equals 0
expected="$(tput bold)$(tput setaf 3)Found existing foobar for $(tput setaf 5)\"2>/dev/null\"$(tput setaf 3). "
expected+="You should use: $(tput setaf 5)\"NE\"$(tput sgr0)"
assert "$output" same_as "$expected"
}
@test 'escapes \ and % correctly' {
unset YSU_MESSAGE_FORMAT
run ysu_message "alias" "printf '%s\\n'" "pf"
assert $state equals 0
expected="$(tput bold)$(tput setaf 3)Found existing alias for $(tput setaf 5)\"printf '%s\\n'\"$(tput setaf 3). "
expected+="You should use: $(tput setaf 5)\"pf\"$(tput sgr0)"
assert "$output" same_as "$expected"
}
@test 'ysu - _write_ysu_buffer after' {
unset YSU_MESSAGE_FORMAT
YSU_MESSAGE_POSITION="after"
_YSU_BUFFER=""
_write_ysu_buffer "hello world"
assert $state equals 0
assert "$output" is_empty
assert "$_YSU_BUFFER" same_as "hello world"
}
@test 'ysu message - custom message' {
export YSU_MESSAGE_FORMAT="Hi there %alias_type! %command <=> %alias"
run ysu_message "git alias" "tig" "t"
assert $state equals 0
assert "$output" same_as "Hi there git alias! tig <=> t"
}
@test 'ysu message - custom message 2' {
export YSU_MESSAGE_FORMAT="%alias is a %alias_type for %command"
run ysu_message "alias" "xdg-open" "xopen"
assert $state equals 0
assert "$output" same_as "xopen is a alias for xdg-open"
}
@test 'ysu message - custom message multiple usages' {
export YSU_MESSAGE_FORMAT="%alias %alias %command %command %alias_type %alias_type"
run ysu_message 'git alias' 'xpaste' 'xp'
assert $state equals 0
assert "$output" same_as "xp xp xpaste xpaste git alias git alias"
}

284
.zsh/zsh-you-should-use/you-should-use.plugin.zsh Normal file
View File

@@ -0,0 +1,284 @@
#!/bin/zsh
export YSU_VERSION='1.9.0'
if ! type "tput" > /dev/null; then
printf "WARNING: tput command not found on your PATH.\n"
printf "zsh-you-should-use will fallback to uncoloured messages\n"
else
NONE="$(tput sgr0)"
BOLD="$(tput bold)"
RED="$(tput setaf 1)"
YELLOW="$(tput setaf 3)"
PURPLE="$(tput setaf 5)"
fi
function check_alias_usage() {
# Optional parameter that limits how far back history is checked
# I've chosen a large default value instead of bypassing tail because it's simpler
local limit="${1:-${HISTSIZE:-9000000000000000}}"
local key
declare -A usage
for key in "${(@k)aliases}"; do
usage[$key]=0
done
# TODO:
# Handle and (&&) + (&)
# others? watch, time etc...
local -a histfile_lines
histfile_lines=("${(@f)$(<$HISTFILE)}")
histfile_lines=("${histfile_lines[@]#*;}")
local current=0
local total=${#histfile_lines}
if [[ $total -gt $limit ]]; then
total=$limit
fi
local entry
for line in ${histfile_lines[@]} ; do
for entry in ${(@s/|/)line}; do
# Remove leading whitespace
entry=${entry##*[[:space:]]}
# We only care about the first word because that's all aliases work with
# (this does not count global and git aliases)
local word=${entry[(w)1]}
if [[ -n ${usage[$word]} ]]; then
(( usage[$word]++ ))
fi
done
# print current progress
(( current++ ))
printf "Analysing: [$current/$total]\r"
done
# Clear all previous line output
printf "\r\033[K"
# Print ordered usage
for key in ${(k)usage}; do
echo "${usage[$key]}: ${(q+)key}=${(q+)aliases[$key]}"
done | sort -rn -k1
}
# Writing to a buffer rather than directly to stdout/stderr allows us to decide
# if we want to write the reminder message before or after a command has been executed
function _write_ysu_buffer() {
_YSU_BUFFER+="$@"
# Maintain historical behaviour by default
local position="${YSU_MESSAGE_POSITION:-before}"
if [[ "$position" = "before" ]]; then
_flush_ysu_buffer
elif [[ "$position" != "after" ]]; then
(>&2 printf "${RED}${BOLD}Unknown value for YSU_MESSAGE_POSITION '$position'. ")
(>&2 printf "Expected value 'before' or 'after'${NONE}\n")
_flush_ysu_buffer
fi
}
function _flush_ysu_buffer() {
# It's important to pass $_YSU_BUFFER to printfs first argument
# because otherwise all escape codes will not printed correctly
(>&2 printf "$_YSU_BUFFER")
_YSU_BUFFER=""
}
function ysu_message() {
local DEFAULT_MESSAGE_FORMAT="${BOLD}${YELLOW}\
Found existing %alias_type for ${PURPLE}\"%command\"${YELLOW}. \
You should use: ${PURPLE}\"%alias\"${NONE}"
local alias_type_arg="${1}"
local command_arg="${2}"
local alias_arg="${3}"
# Escape arguments which will be interpreted by printf incorrectly
# unfortunately there does not seem to be a nice way to put this into
# a function because returning the values requires to be done by printf/echo!!
command_arg="${command_arg//\%/%%}"
command_arg="${command_arg//\\/\\\\}"
local MESSAGE="${YSU_MESSAGE_FORMAT:-"$DEFAULT_MESSAGE_FORMAT"}"
MESSAGE="${MESSAGE//\%alias_type/$alias_type_arg}"
MESSAGE="${MESSAGE//\%command/$command_arg}"
MESSAGE="${MESSAGE//\%alias/$alias_arg}"
_write_ysu_buffer "$MESSAGE\n"
}
# Prevent command from running if hardcore mode enabled
function _check_ysu_hardcore() {
if (( ${+YSU_HARDCORE} )); then
_write_ysu_buffer "${BOLD}${RED}You Should Use hardcore mode enabled. Use your aliases!${NONE}\n"
kill -s INT $$
fi
}
function _check_git_aliases() {
local typed="$1"
local expanded="$2"
# sudo will use another user's profile and so aliases would not apply
if [[ "$typed" = "sudo "* ]]; then
return
fi
if [[ "$typed" = "git "* ]]; then
local found=false
git config --get-regexp "^alias\..+$" | sort | while read key value; do
key="${key#alias.}"
# if for some reason, read does not split correctly, we
# detect that and manually split the key and value
if [[ -z "$value" ]]; then
value="${key#* }"
key="${key%% *}"
fi
if [[ "$expanded" = "git $value" || "$expanded" = "git $value "* ]]; then
ysu_message "git alias" "$value" "git $key"
found=true
fi
done
if $found; then
_check_ysu_hardcore
fi
fi
}
function _check_global_aliases() {
local typed="$1"
local expanded="$2"
local found=false
local tokens
local key
local value
local entry
# sudo will use another user's profile and so aliases would not apply
if [[ "$typed" = "sudo "* ]]; then
return
fi
alias -g | sort | while IFS="=" read -r key value; do
key="${key## }"
key="${key%% }"
value="${(Q)value}"
# Skip ignored global aliases
if [[ ${YSU_IGNORED_GLOBAL_ALIASES[(r)$key]} == "$key" ]]; then
continue
fi
if [[ "$typed" = *" $value "* || \
"$typed" = *" $value" || \
"$typed" = "$value "* || \
"$typed" = "$value" ]]; then
ysu_message "global alias" "$value" "$key"
found=true
fi
done
if $found; then
_check_ysu_hardcore
fi
}
function _check_aliases() {
local typed="$1"
local expanded="$2"
local found_aliases
found_aliases=()
local best_match=""
local best_match_value=""
local key
local value
# sudo will use another user's profile and so aliases would not apply
if [[ "$typed" = "sudo "* ]]; then
return
fi
# Find alias matches
for key in "${(@k)aliases}"; do
value="${aliases[$key]}"
# Skip ignored aliases
if [[ ${YSU_IGNORED_ALIASES[(r)$key]} == "$key" ]]; then
continue
fi
if [[ "$typed" = "$value" || "$typed" = "$value "* ]]; then
# if the alias longer or the same length as its command
# we assume that it is there to cater for typos.
# If not, then the alias would not save any time
# for the user and so doesn't hold much value anyway
if [[ "${#value}" -gt "${#key}" ]]; then
found_aliases+="$key"
# Match aliases to longest portion of command
if [[ "${#value}" -gt "${#best_match_value}" ]]; then
best_match="$key"
best_match_value="$value"
# on equal length, choose the shortest alias
elif [[ "${#value}" -eq "${#best_match}" && ${#key} -lt "${#best_match}" ]]; then
best_match="$key"
best_match_value="$value"
fi
fi
fi
done
# Print result matches based on current mode
if [[ "$YSU_MODE" = "ALL" ]]; then
for key in ${(@ok)found_aliases}; do
value="${aliases[$key]}"
ysu_message "alias" "$value" "$key"
done
elif [[ (-z "$YSU_MODE" || "$YSU_MODE" = "BESTMATCH") && -n "$best_match" ]]; then
# make sure that the best matched alias has not already
# been typed by the user
value="${aliases[$best_match]}"
if [[ "$typed" = "$best_match" || "$typed" = "$best_match "* ]]; then
return
fi
ysu_message "alias" "$value" "$best_match"
fi
if [[ -n "$found_aliases" ]]; then
_check_ysu_hardcore
fi
}
function disable_you_should_use() {
add-zsh-hook -D preexec _check_aliases
add-zsh-hook -D preexec _check_global_aliases
add-zsh-hook -D preexec _check_git_aliases
add-zsh-hook -D precmd _flush_ysu_buffer
}
function enable_you_should_use() {
disable_you_should_use # Delete any possible pre-existing hooks
add-zsh-hook preexec _check_aliases
add-zsh-hook preexec _check_global_aliases
add-zsh-hook preexec _check_git_aliases
add-zsh-hook precmd _flush_ysu_buffer
}
autoload -Uz add-zsh-hook
enable_you_should_use

1
.zsh/zsh-you-should-use/zsh-you-should-use.plugin.zsh Symbolic link
View File

@@ -0,0 +1 @@
you-should-use.plugin.zsh