13 changed files with 2484 additions and 1 deletions
@ -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>. |
@ -0,0 +1,355 @@ |
|||||||
|
*This repository is a mirror, for developpement and issues, please go to [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/)* |
||||||
|
|
||||||
|
# Vim Cheat.sh |
||||||
|
|
||||||
|
This is a highly configurable vim plugin to browse cheat sheet from |
||||||
|
[cheat.sh](https://github.com/chubin/cheat.sh) directly from vim. |
||||||
|
|
||||||
|
## Demo |
||||||
|
|
||||||
|
<!-- There is an asciinema showing how it works : |
||||||
|
|
||||||
|
[](https://asciinema.org/a/c6QRIhus7np2OOQzmQ2RNXzRZ) |
||||||
|
--> |
||||||
|
|
||||||
|
There is a demo of most important features of the cheat.sh Vim plugin (5 Min), |
||||||
|
courtesy of @chubin, CC-SA. |
||||||
|
|
||||||
|
** Note :** In the video, @chubin uses the `space` key as a `<leader>`, by |
||||||
|
default vim `<leader>` is `backslash`. |
||||||
|
|
||||||
|
<p align="center"> |
||||||
|
<img src='https://cheat.sh/files/vim-demo.gif'/> |
||||||
|
</p> |
||||||
|
|
||||||
|
Or, if you want to scroll and/or pause, the same on YouTube: |
||||||
|
|
||||||
|
<p align="center"> |
||||||
|
<a href="http://www.youtube.com/watch?feature=player_embedded&v=xyf6MJ0y-z8 |
||||||
|
" target="_blank"><img src="http://img.youtube.com/vi/xyf6MJ0y-z8/0.jpg" |
||||||
|
alt="cheat.sh-vim: Using cheat.sh from vim" width="700" height="490" border="10" /></a> |
||||||
|
</p> |
||||||
|
|
||||||
|
## Features |
||||||
|
|
||||||
|
+ Browse existing cheat sheets from cheat.sh directly from vim |
||||||
|
+ Get answers on any programming question directly on your vim with simple mappings |
||||||
|
+ Answers depends of your current filetype or framework |
||||||
|
+ Send compilation / syntax error to cht.sh and get answers |
||||||
|
+ Manage session id to replay last query from other cht.sh clients |
||||||
|
+ Quick navigation through answers |
||||||
|
+ Everything is configurable |
||||||
|
|
||||||
|
### How to use it |
||||||
|
|
||||||
|
The easiest way to use this plugin is to use one of the following mappings : |
||||||
|
|
||||||
|
+ `K` get answer on the word under the cursor or the selection on a pager (this |
||||||
|
feature requires vim >= 7.4.1833, you can check if have the right version with : |
||||||
|
`:echo has("patch-7.4.1833")`) |
||||||
|
+ `<leader>KK` same as `K` but works on lines or visual selection (not working |
||||||
|
on neovim, because they killed interactive commands with `:!`) |
||||||
|
+ `<leader>KB` get the answer on a special buffer |
||||||
|
+ `<leader>KR` Replace your question by the answer |
||||||
|
+ `<leader>KP` Past the answer below your question |
||||||
|
+ `<leader>KC` Replay last query, toggling comments |
||||||
|
+ `<leader>KE` Send first error to cht.sh |
||||||
|
+ `<leader>C` Toggle showing comments by default see [configuration](#configuration) |
||||||
|
+ `<leader>KL` Replay last query |
||||||
|
|
||||||
|
The plugins also provides four main commands : |
||||||
|
|
||||||
|
:Cheat |
||||||
|
:CheatReplace |
||||||
|
:CheatPast |
||||||
|
:CheatPager |
||||||
|
|
||||||
|
+ These commands takes 0 or 1 argument. |
||||||
|
+ If you give no argument, it will send the language of the current buffer and |
||||||
|
the visual selection (or the current line / word in `normal` mode) as a plus |
||||||
|
query to cheat.sh and show the answer in a new buffer (`:Cheat`), in place of |
||||||
|
your question (`:CheatReplace`) or in a pager (`:CheatPager`). |
||||||
|
+ If one argument is given, you can complete it from a list of available cheat |
||||||
|
sheets or write your own [query](https://github.com/chubin/cheat.sh#search). |
||||||
|
+ They also take a `bang` that make same transform the query into a plus query: |
||||||
|
for instance : `:Cheat! factory` is the same as `:Cheat &ft/factory+`. |
||||||
|
|
||||||
|
#### HowIn |
||||||
|
|
||||||
|
The `:HowIn` command takes exaclty one argument. |
||||||
|
|
||||||
|
If the argument is one word, it is interpreted as a filetype (language), and |
||||||
|
the current line (or word, depending on |cheat.sh-configuration|) is sent as a |
||||||
|
query for this given language. |
||||||
|
Else the first word of the query should be a filetype. |
||||||
|
|
||||||
|
Examples : |
||||||
|
|
||||||
|
```python |
||||||
|
# Current postion in the buffer : |
||||||
|
with open('foo') as f: |
||||||
|
``` |
||||||
|
```viml |
||||||
|
:HowIn javascript |
||||||
|
``` |
||||||
|
Or |
||||||
|
```viml |
||||||
|
:Howin javascript open file |
||||||
|
``` |
||||||
|
|
||||||
|
#### Frameworks |
||||||
|
|
||||||
|
#### Ids |
||||||
|
|
||||||
|
When you open a buffer, cheat.sh-vim will try to guess if you are using a |
||||||
|
framework and if a framework is found, it will send queries using your |
||||||
|
framework instead of your filetype. |
||||||
|
|
||||||
|
There are also some mappings to change the current framework : |
||||||
|
|
||||||
|
+ `<leader>Kt` : Use filetype instead of framework |
||||||
|
+ `<leader>KT` : Use autodetected framework |
||||||
|
+ `<leader>Kf` : Use next defined framework for current filetype |
||||||
|
+ `<leader>KF` : Use previous defined framework for current filetype |
||||||
|
|
||||||
|
The available Frameworks can be overriden with the following code (adapt to |
||||||
|
your needs) : |
||||||
|
```viml |
||||||
|
let g:CheatSheetFrameworks = { |
||||||
|
\ 'python' : ['python', 'django', ], |
||||||
|
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||||
|
\ 'php' : ['php', 'symphony', 'yii', 'zend'], |
||||||
|
\} |
||||||
|
``` |
||||||
|
|
||||||
|
As you can see the list is far from being exhaustive, please contribute if you |
||||||
|
modify it (see below). |
||||||
|
|
||||||
|
##### Frameworks Detection |
||||||
|
|
||||||
|
This functionnality is in early stage and help is wanted to improve it. |
||||||
|
To detect framework, the plugin go through the list of defined framework for |
||||||
|
the current filetype. The following dictionnary tells the plugin how to detect |
||||||
|
a few frameworks. |
||||||
|
```viml |
||||||
|
let g:CheatSheetFrameworkDetectionMethods = { |
||||||
|
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||||
|
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||||
|
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||||
|
\} |
||||||
|
``` |
||||||
|
|
||||||
|
This dictionnary can be overriden by the user. |
||||||
|
|
||||||
|
There are three types of detections : |
||||||
|
|
||||||
|
1. 'file' : 'value' is an argument for the `find` command to locate a file |
||||||
|
`find . -name "value"` |
||||||
|
2. 'search', 'value' is a pattern that should be present in the current file |
||||||
|
3. 'func' : 'value' is the name of a user defined function which should return |
||||||
|
something true if the framework is detected. The function takes one argument |
||||||
|
which is the name of the framework we are currently testing for. |
||||||
|
|
||||||
|
Please report any contribution on [this |
||||||
|
issue](https://gitlab.com/dbeniamine/cheat.sh-vim/issues/51#note_95268282), or |
||||||
|
do MR (PR) on gitlab (resp github) : |
||||||
|
|
||||||
|
|
||||||
|
The `:CheatId` command can be used to manage ids : |
||||||
|
|
||||||
|
:Cheat[!] [newid] " Generates a new id or set id to newid |
||||||
|
" Id will not be overwritten if ! is not given |
||||||
|
:Cheat remove " Completely removes the id |
||||||
|
|
||||||
|
#### Errors |
||||||
|
|
||||||
|
Cheat.sh-vim can directly send the syntaxt and compilation errors / warning to |
||||||
|
cht.sh. To do so, hit `<leader>KE` or run `:CheatError`. |
||||||
|
|
||||||
|
By default, the answer will be displayed on the cheat buffer, to change this |
||||||
|
behavior : |
||||||
|
|
||||||
|
let g:CheatSheetDefaultMode = x |
||||||
|
|
||||||
|
Where x is : |
||||||
|
|
||||||
|
+ 0 : Cheat buffer (default) |
||||||
|
+ 1 : Replace current line (sounds like a very bad idea) |
||||||
|
+ 2 : Use the pager |
||||||
|
+ 3 : Append answer below current line (sounds like a bad idea) |
||||||
|
|
||||||
|
##### Error providers |
||||||
|
|
||||||
|
Currently errors are search from the quickfix, then from syntastic errors. |
||||||
|
To change this order : |
||||||
|
|
||||||
|
let g:CheatSheetProviders = ['syntastic', 'quickfix'] |
||||||
|
|
||||||
|
You can easily add an error provider in 5 steps : |
||||||
|
|
||||||
|
1. Copy the file `cheat.sh/autoload/cheat/providers/quickfix.vim` to |
||||||
|
`cheat.sh/autoload/cheat/providers/myprovider.vim` |
||||||
|
2. Adapt and rename the function (only change quickfix in the name), it must |
||||||
|
return the error string without special chars or an empty string if there are |
||||||
|
no errors / warning |
||||||
|
3. Add your provider name (filename) to the `CheatSheatProvider` list in |
||||||
|
`cheat.sh/autoload/cheat/providers.vim` |
||||||
|
4. Test it |
||||||
|
5. Do a merge request on [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/) |
||||||
|
|
||||||
|
##### Syntastic hooks |
||||||
|
|
||||||
|
Cheat.sh-vim uses syntastic hooks to retrieve the error list, if you also need |
||||||
|
to use synstastic hook, make sure that your function calls ours with the initial |
||||||
|
error list : |
||||||
|
|
||||||
|
function SyntasticCheckHook(errors) |
||||||
|
call cheat#providers#syntastic#Hook(a:errors) |
||||||
|
" Do whatever you want to do |
||||||
|
endfunction |
||||||
|
|
||||||
|
#### Navigate |
||||||
|
|
||||||
|
Once you have called on of these commands, you can navigate through questions, |
||||||
|
answers and related with the following mappings : |
||||||
|
|
||||||
|
+ `<leader>KQN` Next Question |
||||||
|
+ `<leader>KAN` Next Answer |
||||||
|
+ `<leader>KSN` Next "See also" |
||||||
|
+ `<leader>KHN` Next in history |
||||||
|
+ `<leader>KQP` Previous Question |
||||||
|
+ `<leader>KAP` Previous Answer |
||||||
|
+ `<leader>KSP` Previous "See also" |
||||||
|
+ `<leader>KHP` Previous in history |
||||||
|
|
||||||
|
In the cheat buffer, the following mappings are also available : |
||||||
|
|
||||||
|
+ `<localleader>h` Previous Answer |
||||||
|
+ `<localleader>j` Next Question |
||||||
|
+ `<localleader>k` Previous Question |
||||||
|
+ `<localleader>l` Next Answer |
||||||
|
+ `<localleader>H` Previous history |
||||||
|
+ `<localleader>J` Next "See also" |
||||||
|
+ `<localleader>K` Previous "See also" |
||||||
|
+ `<localleader>L` Next history |
||||||
|
|
||||||
|
|
||||||
|
You can also directly use the function : |
||||||
|
|
||||||
|
:call cheat#navigate(delta, type) |
||||||
|
|
||||||
|
Where delta is a numeric value for moving (1, or -1 for next or previous) And |
||||||
|
type is one of : `'Q'`, `'A'`, `'S'`, `H` (history), and `C` (replay last |
||||||
|
query, toggling comments). |
||||||
|
|
||||||
|
For instance : |
||||||
|
|
||||||
|
:call cheat#navigate(-3, 'A') |
||||||
|
|
||||||
|
goes back three answers before the current |
||||||
|
|
||||||
|
When navigating, the same mode (pager, buffer, replace) is used as for the last |
||||||
|
request. |
||||||
|
|
||||||
|
#### Notes |
||||||
|
|
||||||
|
+ `<leader>` is usually '\'. |
||||||
|
+ **This plugin is still in beta, Replace mode might remove some of your code, |
||||||
|
use with caution.** |
||||||
|
+ For more info on cheat sheet sources, see |
||||||
|
[cheat.sh](https://github.com/chubin/cheat.sh). |
||||||
|
|
||||||
|
## Install |
||||||
|
|
||||||
|
### Vizardry |
||||||
|
|
||||||
|
If you have [Vizardry](https://github.com/dbeniamine/vizardry) installed, you |
||||||
|
can run from vim: |
||||||
|
|
||||||
|
:Invoke -u dbeniamine cheat.sh-vim |
||||||
|
|
||||||
|
### Vundle |
||||||
|
|
||||||
|
Add the following to your Vundle Plugin list (not tested, but should work) : |
||||||
|
|
||||||
|
Plugin 'dbeniamine/cheat.sh-vim' |
||||||
|
|
||||||
|
### Pathogen install |
||||||
|
|
||||||
|
git clone https://github.com/dbeniamine/cheat.sh-vim.git ~/.vim/bundle/cheat.sh-vim |
||||||
|
|
||||||
|
### Quick install |
||||||
|
|
||||||
|
git clone https://github.com/dbeniamine/cheat.sh-vim.git |
||||||
|
cd cheat.sh-vim/ |
||||||
|
cp -r ./* ~/.vim |
||||||
|
|
||||||
|
## Configuration |
||||||
|
|
||||||
|
Every parameter used to retrieve and display the cheat sheet can be changed, to |
||||||
|
do so, just put the following in you vimrc and ajust to your needs (these are |
||||||
|
the default values that will be used if you do not change them) : |
||||||
|
|
||||||
|
" Vim command used to open new buffer |
||||||
|
let g:CheatSheetReaderCmd='new"' |
||||||
|
|
||||||
|
" Cheat sheet file type |
||||||
|
let g:CheatSheetFt='markdown' |
||||||
|
|
||||||
|
" Program used to retrieve cheat sheet with its arguments |
||||||
|
let g:CheatSheetUrlGetter='curl --silent' |
||||||
|
|
||||||
|
" Flag to add cookie file to the query |
||||||
|
let g:CheatSheetUrlGetterIdFlag='-b' |
||||||
|
|
||||||
|
" cheat sheet base url |
||||||
|
let g:CheatSheetBaseUrl='https://cht.sh' |
||||||
|
|
||||||
|
" cheat sheet settings do not include style settings neiter comments, |
||||||
|
" see other options below |
||||||
|
let g:CheatSheetUrlSettings='q' |
||||||
|
|
||||||
|
" cheat sheet pager |
||||||
|
let g:CheatPager='less -R' |
||||||
|
|
||||||
|
" pygmentize theme used for pager output, see :CheatPager :styles-demo |
||||||
|
let g:CheatSheetPagerStyle=rrt |
||||||
|
|
||||||
|
" Show comments in answers by default |
||||||
|
" (setting this to 0 means giving ?Q to the server) |
||||||
|
let g:CheatSheetShowCommentsByDefault=1 |
||||||
|
|
||||||
|
" cheat sheet buffer name |
||||||
|
let g:CheatSheetBufferName="_cheat" |
||||||
|
|
||||||
|
" Default selection in normal mode (line for whole line, word for word under cursor) |
||||||
|
let g:CheatSheetDefaultSelection="line" |
||||||
|
|
||||||
|
" Default query mode |
||||||
|
" 0 => buffer |
||||||
|
" 1 => replace (do not use or you might loose some lines of code) |
||||||
|
" 2 => pager |
||||||
|
" 3 => paste after query |
||||||
|
" 4 => paste before query |
||||||
|
let g:CheatSheetDefaultMode=0 |
||||||
|
|
||||||
|
Path to cheat sheet cookie |
||||||
|
let g:CheatSheetIdPath=expand('~/.cht.sh/id') |
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
You can also disable the mappings (see plugin/cheat.vim to redo the mappings |
||||||
|
manually) |
||||||
|
|
||||||
|
let g:CheatSheetDoNotMap=1 |
||||||
|
|
||||||
|
To disable the replacement of man by cheat sheets : |
||||||
|
|
||||||
|
Let g:CheatDoNotReplaceKeywordPrg=1 |
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
This plugin is distributed under GPL Licence v3.0, see |
||||||
|
https://www.gnu.org/licenses/gpl.txt |
||||||
|
|
||||||
|
The demo are creative Commons, CC-SA Igor Chubin. |
@ -0,0 +1,128 @@ |
|||||||
|
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||||
|
" Maintainer: David Beniamine |
||||||
|
" |
||||||
|
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||||
|
" |
||||||
|
" 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/>. |
||||||
|
|
||||||
|
let save_cpo = &cpo |
||||||
|
set cpo&vim |
||||||
|
|
||||||
|
if(!exists("g:CheatSheetFrameworks")) |
||||||
|
let g:CheatSheetFrameworks = { |
||||||
|
\ 'python' : [ 'python', 'django', ], |
||||||
|
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||||
|
\ 'php' : ['php', 'symfony', 'yii', 'zend'], |
||||||
|
\} |
||||||
|
endif |
||||||
|
|
||||||
|
if(!exists("g:CheatSheetFrameworkDetectionMethods")) |
||||||
|
let g:CheatSheetFrameworkDetectionMethods = { |
||||||
|
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||||
|
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||||
|
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||||
|
\} |
||||||
|
endif |
||||||
|
|
||||||
|
if(!exists("b:CheatSheetCurrentFramework")) |
||||||
|
let b:CheatSheetCurrentFramework = 0 |
||||||
|
endif |
||||||
|
|
||||||
|
function! s:Detectfromfile(value, fm) |
||||||
|
let dir=expand('%:p:h') |
||||||
|
" Forward search |
||||||
|
silent let ret=system('find '.shellescape(dir).' -name '. |
||||||
|
\shellescape(a:value).' 2>/dev/null') |
||||||
|
" Backward search |
||||||
|
if ret == "" |
||||||
|
let dirs="" |
||||||
|
let parent=substitute(dir, '/[^/]*$', '', '') |
||||||
|
while parent != "" |
||||||
|
let dirs.=" ".shellescape(parent) |
||||||
|
let parent=substitute(parent, '/[^/]*$', '', '') |
||||||
|
endwhile |
||||||
|
silent let ret=system('find '.dirs.' -maxdepth 1 -name '. |
||||||
|
\shellescape(a:value).' 2>/dev/null') |
||||||
|
endif |
||||||
|
return ret != "" |
||||||
|
endfunction |
||||||
|
|
||||||
|
function! s:Detectfromsearch(value, fm) |
||||||
|
return search(a:value, 'cnw') |
||||||
|
endfunction |
||||||
|
|
||||||
|
function! s:Detectfromfunc(value, fm) |
||||||
|
return function(a:value)(a:fm) |
||||||
|
endfunction |
||||||
|
|
||||||
|
function! cheat#frameworks#autodetect(print) |
||||||
|
if(!has_key(g:CheatSheetFrameworks, &ft)) |
||||||
|
return |
||||||
|
endif |
||||||
|
let framework = &ft |
||||||
|
" Try autodetect |
||||||
|
for fm in g:CheatSheetFrameworks[&ft] |
||||||
|
if(has_key(g:CheatSheetFrameworkDetectionMethods, fm) && |
||||||
|
\ function("s:Detectfrom". |
||||||
|
\g:CheatSheetFrameworkDetectionMethods[fm].type)( |
||||||
|
\g:CheatSheetFrameworkDetectionMethods[fm].value, fm) |
||||||
|
\) |
||||||
|
let framework=fm |
||||||
|
break |
||||||
|
endif |
||||||
|
endfor |
||||||
|
" Set framework |
||||||
|
let b:CheatSheetCurrentFramework = index(g:CheatSheetFrameworks[&ft], |
||||||
|
\framework) |
||||||
|
|
||||||
|
if(a:print) |
||||||
|
call cheat#echo('Language for cheat queries changed to : "'. |
||||||
|
\cheat#frameworks#getFt().'"', 's') |
||||||
|
endif |
||||||
|
endfunction |
||||||
|
|
||||||
|
" Try to use a framework if defined or return current filetype |
||||||
|
function! cheat#frameworks#getFt() |
||||||
|
try |
||||||
|
let ft=g:CheatSheetFrameworks[&ft][b:CheatSheetCurrentFramework] |
||||||
|
catch |
||||||
|
let ft=&ft |
||||||
|
endtry |
||||||
|
return ft |
||||||
|
endfunction |
||||||
|
|
||||||
|
" Switch to next filetype |
||||||
|
function! cheat#frameworks#cycle(num) |
||||||
|
if(!has_key(g:CheatSheetFrameworks, &ft)) |
||||||
|
call cheat#echo('No frameworks define for "'.&ft. |
||||||
|
\'", see :help cheat.sh-frameworks', 'E') |
||||||
|
return |
||||||
|
endif |
||||||
|
|
||||||
|
if(a:num == 0) |
||||||
|
" Reset |
||||||
|
let b:CheatSheetCurrentFramework = 0 |
||||||
|
else |
||||||
|
if(abs(b:CheatSheetCurrentFramework) >= len(g:CheatSheetFrameworks[&ft])) |
||||||
|
let b:CheatSheetCurrentFramework = 0 |
||||||
|
endif |
||||||
|
let b:CheatSheetCurrentFramework += a:num |
||||||
|
endif |
||||||
|
|
||||||
|
call cheat#echo('Language for cheat queries changed to : "'. |
||||||
|
\cheat#frameworks#getFt().'"', 's') |
||||||
|
endfunction |
||||||
|
|
||||||
|
let cpo=save_cpo |
||||||
|
" vim:set et sw=4: |
@ -0,0 +1,27 @@ |
|||||||
|
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||||
|
" Maintainer: David Beniamine |
||||||
|
" |
||||||
|
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||||
|
" |
||||||
|
" 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/>. |
||||||
|
|
||||||
|
let save_cpo = &cpo |
||||||
|
set cpo&vim |
||||||
|
|
||||||
|
function! cheat#providers#quickfix#GetError() |
||||||
|
return cheat#providers#GetErrorFromList(getqflist()) |
||||||
|
endfunction |
||||||
|
|
||||||
|
let cpo=save_cpo |
||||||
|
" vim:set et sw=4: |
@ -0,0 +1,32 @@ |
|||||||
|
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||||
|
" Maintainer: David Beniamine |
||||||
|
" |
||||||
|
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||||
|
" |
||||||
|
" 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/>. |
||||||
|
|
||||||
|
let g:save_cpo = &cpo |
||||||
|
set cpo&vim |
||||||
|
|
||||||
|
let s:errors=[] |
||||||
|
|
||||||
|
function! cheat#providers#syntastic#GetError() |
||||||
|
return cheat#providers#GetErrorFromList(s:errors) |
||||||
|
endfunction |
||||||
|
|
||||||
|
function! cheat#providers#syntastic#Hook(errors) |
||||||
|
let s:errors=a:errors |
||||||
|
endfunction |
||||||
|
|
||||||
|
" vim:set et sw=4: |
@ -0,0 +1,129 @@ |
|||||||
|
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||||
|
" Maintainer: David Beniamine |
||||||
|
" |
||||||
|
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||||
|
" |
||||||
|
" 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/>. |
||||||
|
|
||||||
|
let save_cpo = &cpo |
||||||
|
set cpo&vim |
||||||
|
|
||||||
|
" Transforms a high level request into a query ready to be processed by cht.sh |
||||||
|
function! cheat#requests#toquery(request) |
||||||
|
if(a:request.useFt == 1) |
||||||
|
let query='vim:'.a:request.ft.'/' |
||||||
|
else |
||||||
|
let query='' |
||||||
|
endif |
||||||
|
if(a:request.isCheatSheet == 0) |
||||||
|
let query.=substitute(a:request.query, ' ', '+', 'g') |
||||||
|
" There must be a + in the query |
||||||
|
if(match(query, '+') == -1) |
||||||
|
let query.='+' |
||||||
|
endif |
||||||
|
let query.='/'.a:request.q.'/'.a:request.a.','.a:request.s |
||||||
|
else |
||||||
|
let query.=a:request.query |
||||||
|
endif |
||||||
|
let query.='?' |
||||||
|
let query.=g:CheatSheetUrlSettings |
||||||
|
" Color pager requests |
||||||
|
if(a:request.mode!=2) |
||||||
|
let query.='T' |
||||||
|
endif |
||||||
|
if(a:request.comments==0) |
||||||
|
let query.='Q' |
||||||
|
endif |
||||||
|
if(exists("g:CheatSheetPagerStyle") && a:request.mode==2) |
||||||
|
let query.="&style=".g:CheatSheetPagerStyle |
||||||
|
endif |
||||||
|
return query |
||||||
|
endfunction |
||||||
|
|
||||||
|
" Parse the query to update the given request |
||||||
|
function! s:parseQuery(query, request) |
||||||
|
let opts=split(a:query, '/') |
||||||
|
if(len(opts) >= 2) |
||||||
|
let a:request.ft=opts[0] |
||||||
|
let a:request.query=opts[1] |
||||||
|
else |
||||||
|
let a:request.ft=g:CheatSheetFt |
||||||
|
let a:request.query=opts[0] |
||||||
|
let a:request.useFt = 0 |
||||||
|
endif |
||||||
|
if(len(opts) >=3) |
||||||
|
let a:request.q=opts[2] |
||||||
|
else |
||||||
|
let a:request.q=0 |
||||||
|
endif |
||||||
|
if(len(opts) >=4) |
||||||
|
" Remove see related if present |
||||||
|
let a:request.a=substitute(opts[3], '\(.*\),\+.*$', '\1', '') |
||||||
|
else |
||||||
|
let a:request.a=0 |
||||||
|
endif |
||||||
|
" Remove see related uses , not / |
||||||
|
if(match(a:query, ',\d\+$')!=-1) |
||||||
|
let a:request.s=substitute(a:query, '^.*,\(\d\+\)$', '\1', '') |
||||||
|
else |
||||||
|
let a:request.s=0 |
||||||
|
endif |
||||||
|
if(match(a:query,'+')!=-1) |
||||||
|
let a:request.isCheatSheet=0 |
||||||
|
let a:request.useFt = 1 |
||||||
|
else |
||||||
|
let a:request.isCheatSheet=1 |
||||||
|
endif |
||||||
|
return a:request |
||||||
|
endfunction |
||||||
|
|
||||||
|
|
||||||
|
" Prepare an empty request |
||||||
|
function! cheat#requests#init(query, mode, parseQuery) |
||||||
|
let request={ |
||||||
|
\'a' : 0, |
||||||
|
\'q' : 0, |
||||||
|
\'s' : 0, |
||||||
|
\'comments' : g:CheatSheetShowCommentsByDefault, |
||||||
|
\'ft' : cheat#frameworks#getFt(), |
||||||
|
\'isCheatSheet' : 0, |
||||||
|
\'appendpos' : 0, |
||||||
|
\'numLines' : 0, |
||||||
|
\'mode' : g:CheatSheetDefaultMode, |
||||||
|
\'useFt' : 1, |
||||||
|
\'query' : a:query, |
||||||
|
\} |
||||||
|
if(a:mode != 5) |
||||||
|
let request.mode=a:mode |
||||||
|
endif |
||||||
|
|
||||||
|
" Set append pos / remove query if required |
||||||
|
if(request.mode == 1) |
||||||
|
call cheat#echo('removing lines', 'e') |
||||||
|
normal dd |
||||||
|
let request.appendpos=getcurpos()[1]-1 |
||||||
|
elseif(request.mode == 3) |
||||||
|
let request.appendpos=getcurpos()[1] |
||||||
|
elseif(request.mode == 4) |
||||||
|
let request.appendpos=getcurpos()[1]-1 |
||||||
|
endif |
||||||
|
|
||||||
|
if(a:parseQuery) |
||||||
|
call s:parseQuery(a:query, request) |
||||||
|
endif |
||||||
|
return request |
||||||
|
endfunction |
||||||
|
|
||||||
|
let cpo=save_cpo |
||||||
|
" vim:set et sw=4: |
@ -0,0 +1,314 @@ |
|||||||
|
*cheat.sh-vim* ~ |
||||||
|
|
||||||
|
This is a vim plugin to browse cheat sheet from |
||||||
|
cheat.sh (https://github.com/chubin/cheat.sh) directly from vim. |
||||||
|
|
||||||
|
=============================================================================== |
||||||
|
Features *cheat.sh-features* ~ |
||||||
|
|
||||||
|
|
||||||
|
+ Browse existing cheat sheets from cheat.sh directly from vim |
||||||
|
+ Get answers on any programming question directly on your vim with simple mappings |
||||||
|
+ Answers depends of your current filetype or framework see |cheat.sh-frameworks| |
||||||
|
+ Send compilation / syntax error to cht.sh and get answers |
||||||
|
+ Quick navigation through answers |
||||||
|
+ Everything is configurable |
||||||
|
|
||||||
|
How to use it *cheat.sh-how-to-use* ~ |
||||||
|
|
||||||
|
The easiest way to use this plugin is to use one of the following mappings : |
||||||
|
The easiest way to use this plugin is to use one of the following mappings : |
||||||
|
|
||||||
|
+ `K` get answer on the word under the cursor or the selection on a pager (this |
||||||
|
feature requires vim >= 7.4.1833, you can check if have the right version with : |
||||||
|
`:echo has("patch-7.4.1833")`) |
||||||
|
+ `<leader>KK` same as `K` but works on lines or visual selection (not working |
||||||
|
on neovim, because they killed interactive commands with `:!`) |
||||||
|
+ `<leader>KB` get the answer on a special buffer |
||||||
|
+ `<leader>KR` Replace your question by the answer |
||||||
|
+ `<leader>KP` Past the answer below your question |
||||||
|
+ `<leader>KC` Replay last query, toggling comments |
||||||
|
+ `<leader>KE` Send first error to cht.sh |
||||||
|
+ `<leader>C` Toggle showing comments by default see |cheat.sh-configuration| |
||||||
|
+ `<leader>KL` Replay last query |
||||||
|
|
||||||
|
The plugins also provides four main commands : |
||||||
|
> |
||||||
|
:Cheat |
||||||
|
:CheatReplace |
||||||
|
:CheatPast |
||||||
|
:CheatPager |
||||||
|
< |
||||||
|
+ These commands takes 0 or 1 argument. |
||||||
|
+ If you give no argument, it will send the language of the current buffer and |
||||||
|
the visual selection (or the current line / word in `normal` mode) as a plus |
||||||
|
query to cheat.sh and show the answer in a new buffer (`:Cheat`), in place of |
||||||
|
your question (`:CheatReplace`) or in a pager (`:CheatPager`). |
||||||
|
+ If one argument is given, you can complete it from a list of available cheat |
||||||
|
sheets or write your own [query](https://github.com/chubin/cheat.sh#search). |
||||||
|
+ They also take a `bang` that make same transform the query into a plus query: |
||||||
|
for instance : `:Cheat! factory` is the same as `:Cheat &ft/factory+`. |
||||||
|
|
||||||
|
HowIn *cheat.sh-howin* ~ |
||||||
|
|
||||||
|
The `:HowIn` command takes exaclty one argument. |
||||||
|
|
||||||
|
If the argument is one word, it is interpreted as a filetype (language), and |
||||||
|
the current line (or word, depending on |cheat.sh-configuration|) is sent as a |
||||||
|
query for this given language. |
||||||
|
Else the first word of the query should be a filetype. |
||||||
|
|
||||||
|
Examples : |
||||||
|
|
||||||
|
> |
||||||
|
# Current postion in the buffer : |
||||||
|
with open('foo') as f: |
||||||
|
:HowIn javascript |
||||||
|
< |
||||||
|
Or |
||||||
|
> |
||||||
|
:Howin javascript open file |
||||||
|
< |
||||||
|
|
||||||
|
|
||||||
|
Frameworks *cheat.sh-frameworks* ~ |
||||||
|
|
||||||
|
When you open a buffer, cheat.sh-vim will try to guess if you are using a |
||||||
|
framework (see |cheat.sh-framework-detection|) and if a framework is found, it |
||||||
|
will send queries using your framework instead of your filetype. |
||||||
|
|
||||||
|
There are also some mappings to change the current framework : |
||||||
|
|
||||||
|
+ `<leader>Kt` : Use filetype instead of framework |
||||||
|
+ `<leader>KT` : Use autodetected framework |
||||||
|
+ `<leader>Kf` : Use next defined framework for current filetype |
||||||
|
+ `<leader>KF` : Use previous defined framework for current filetype |
||||||
|
|
||||||
|
The available Frameworks can be overriden with the following code (adapt to |
||||||
|
your needs) : |
||||||
|
> |
||||||
|
let g:CheatSheetFrameworks = { |
||||||
|
\ 'python' : ['python', 'django', ], |
||||||
|
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||||
|
\ 'php' : ['php', 'symphony', 'yii', 'zend'], |
||||||
|
\} |
||||||
|
|
||||||
|
As you can see the list is far from being exhaustive, please contribute if you |
||||||
|
modify it (see below). |
||||||
|
|
||||||
|
*cheat.sh-frameworks-detection* |
||||||
|
|
||||||
|
This functionnality is in early stage and help is wanted to improve it. |
||||||
|
To detect framework, the plugin go through the list of defined framework for |
||||||
|
the current filetype. The following dictionnary tells the plugin how to detect |
||||||
|
a few frameworks. |
||||||
|
> |
||||||
|
let g:CheatSheetFrameworkDetectionMethods = { |
||||||
|
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||||
|
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||||
|
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||||
|
\} |
||||||
|
|
||||||
|
This dictionnary can be overriden by the user. |
||||||
|
|
||||||
|
There are three types of detections : |
||||||
|
|
||||||
|
1. 'file' : 'value' is an argument for the `find` command to locate a file |
||||||
|
`find . -name "value"` |
||||||
|
2. 'search', 'value' is a pattern that should be present in the current file |
||||||
|
3. 'func' : 'value' is the name of a user defined function which should return |
||||||
|
something true if the framework is detected. The function takes one argument |
||||||
|
which is the name of the framework we are currently testing for. |
||||||
|
|
||||||
|
Please report any contribution on the followin issue, or do MR (PR) on gitlab |
||||||
|
(resp github). |
||||||
|
|
||||||
|
https://gitlab.com/dbeniamine/cheat.sh-vim/issues/51#note_95268282 |
||||||
|
|
||||||
|
<Ids *cheat.sh-ids* ~ |
||||||
|
|
||||||
|
You can manage ids through the `:CheatId` command : |
||||||
|
|
||||||
|
:Cheat[!] [newid] " Generates a new id or set id to newid |
||||||
|
" Id will not be overwritten if ! is not given |
||||||
|
:Cheat remove " Completely removes the id |
||||||
|
|
||||||
|
Id is used to replay query from different clients |
||||||
|
|
||||||
|
Errors *cheat.sh-errors* ~ |
||||||
|
|
||||||
|
Cheat.sh-vim can directly send the syntaxt and compilation errors / warning to |
||||||
|
cht.sh. To do so, hit `<leader>KE` or run `:CheatError`. |
||||||
|
|
||||||
|
By default, the answer will be displayed on the cheat buffer, to change this |
||||||
|
behavior : |
||||||
|
> |
||||||
|
let g:CheatSheetDefaultMode = x |
||||||
|
< |
||||||
|
Where x is : |
||||||
|
|
||||||
|
+ 0 : Cheat buffer (default) |
||||||
|
+ 1 : Replace current line (sounds like a very bad idea) |
||||||
|
+ 2 : Use the pager |
||||||
|
+ 3 : Append answer below current line (sounds like a bad idea) |
||||||
|
|
||||||
|
Error providers *cheat.sh-errors-providers* ~ |
||||||
|
|
||||||
|
Currently errors are search from the quickfix, then from syntastic errors. |
||||||
|
To change this order : |
||||||
|
> |
||||||
|
let g:CheatSheetProviders = ['syntastic', 'quickfix'] |
||||||
|
< |
||||||
|
|
||||||
|
You can easily add an error provider in 5 steps : |
||||||
|
|
||||||
|
1. Copy the file `cheat.sh/autoload/cheat/providers/quickfix.vim` to |
||||||
|
`cheat.sh/autoload/cheat/providers/myprovider.vim` |
||||||
|
2. Adapt and rename the function (only change quickfix in the name), it must |
||||||
|
return the error string without special chars or an empty string if there are |
||||||
|
no errors / warning |
||||||
|
3. Add your provider name (filename) to the `CheatSheatProvider` list in |
||||||
|
`cheat.sh/autoload/cheat/providers.vim` |
||||||
|
4. Test it |
||||||
|
5. Do a merge request on [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/) |
||||||
|
|
||||||
|
Syntastic hooks *cheat.sh-syntastic-hook* ~ |
||||||
|
|
||||||
|
Cheat.sh-vim uses syntastic hooks to retrieve the error list, if you also need |
||||||
|
to use synstastic hook, make sure that your function calls ours with the initial |
||||||
|
error list : |
||||||
|
|
||||||
|
function SyntasticCheckHook(errors) |
||||||
|
call cheat#providers#syntastic#Hook(a:errors) |
||||||
|
" Do whatever you want to do |
||||||
|
endfunction |
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Navigate *cheat.sh-navigate* ~ |
||||||
|
|
||||||
|
Once you have called on of these commands, you can navigate through questions, |
||||||
|
answers and related with the following mappings : |
||||||
|
|
||||||
|
+ `<leader>KQN` Next Question |
||||||
|
+ `<leader>KAN` Next Answer |
||||||
|
+ `<leader>KSN` Next "See also" |
||||||
|
+ `<leader>KHN` Next in history |
||||||
|
+ `<leader>KQP` Previous Question |
||||||
|
+ `<leader>KAP` Previous Answer |
||||||
|
+ `<leader>KSP` Previous "See also" |
||||||
|
+ `<leader>KHP` Previous in history |
||||||
|
|
||||||
|
In the cheat buffer, the following mappings are available : |
||||||
|
|
||||||
|
+ `<localleader>h` Previous Answer |
||||||
|
+ `<localleader>j` Next Question |
||||||
|
+ `<localleader>k` Previous Question |
||||||
|
+ `<localleader>l` Next Answer |
||||||
|
+ `<localleader>H` Previous history |
||||||
|
+ `<localleader>J` Next "See also" |
||||||
|
+ `<localleader>K` Previous "See also" |
||||||
|
+ `<localleader>L` Next history |
||||||
|
|
||||||
|
You can also directly use the function : |
||||||
|
> |
||||||
|
:call cheat#navigate(delta, type) |
||||||
|
< |
||||||
|
Where delta is a numeric value for moving (1, or -1 for next or previous) And |
||||||
|
type is one of : `'Q'`, `'A'`, `'S'`, `H` (history), and `C` (replay last |
||||||
|
query, toggling comments). |
||||||
|
|
||||||
|
For instance : |
||||||
|
> |
||||||
|
:call cheat#navigate(-3, 'A') |
||||||
|
< |
||||||
|
goes back three answers before the current |
||||||
|
|
||||||
|
When navigating, the same mode (pager, buffer, replace) is used as for the last |
||||||
|
request. |
||||||
|
|
||||||
|
Notes *cheat.sh-notes* ~ |
||||||
|
|
||||||
|
+ `<leader>` is usually '\', see |<leader>| |
||||||
|
+ **This plugin is still in beta, Replace mode might remove some of your code, |
||||||
|
use with caution.** |
||||||
|
+ For more info on cheat sheet sources, see |
||||||
|
[cheat.sh](https://github.com/chubin/cheat.sh). |
||||||
|
|
||||||
|
|
||||||
|
This plugin provides a `:Cheat` command to browse cheat sheets from vim. This |
||||||
|
command takes one argument : a Cheat.sh |
||||||
|
query (https://github.com/chubin/cheat.sh#search), and supports completion. |
||||||
|
|
||||||
|
For more info on cheat sheet source, see |
||||||
|
cheat.sh (https://github.com/chubin/cheat.sh). |
||||||
|
|
||||||
|
============================================================================== |
||||||
|
Configuration *cheat.sh-configuration* ~ |
||||||
|
|
||||||
|
Every parameter used to retrieve and display the cheat sheet can be changed, |
||||||
|
to do so, just put the following in you vimrc and ajust to your needs (these |
||||||
|
are the default values that will be used if you do not change them) : |
||||||
|
> |
||||||
|
" Vim command used to open new buffer |
||||||
|
let g:CheatSheetReaderCmd='new"' |
||||||
|
|
||||||
|
" Cheat sheet file type |
||||||
|
let g:CheatSheetFt='markdown' |
||||||
|
|
||||||
|
" Program used to retrieve cheat sheet with its arguments |
||||||
|
let g:CheatSheetUrlGetter='curl --silent' |
||||||
|
|
||||||
|
" Flag to add cookie file to the query |
||||||
|
let g:CheatSheetUrlGetterIdFlag='-b' |
||||||
|
|
||||||
|
" cheat sheet base url |
||||||
|
let g:CheatSheetBaseUrl='https://cht.sh' |
||||||
|
|
||||||
|
" cheat sheet settings do not include style settings neiter comments, |
||||||
|
" see other options below |
||||||
|
let g:CheatSheetUrlSettings='q' |
||||||
|
|
||||||
|
" cheat sheet pager |
||||||
|
let g:CheatPager='less -R' |
||||||
|
|
||||||
|
" pygmentize theme used for pager output, see :CheatPager :styles-demo |
||||||
|
let g:CheatSheetPagerStyle=rrt |
||||||
|
|
||||||
|
" Show comments in answers by default |
||||||
|
" (setting this to 0 means giving ?Q to the server) |
||||||
|
let g:CheatSheetShowCommentsByDefault=1 |
||||||
|
|
||||||
|
" cheat sheet buffer name |
||||||
|
let g:CheatSheetBufferName="_cheat" |
||||||
|
|
||||||
|
" Default selection in normal mode (line for whole line, word for word under cursor) |
||||||
|
let g:CheatSheetDefaultSelection="line" |
||||||
|
|
||||||
|
" Default query mode |
||||||
|
" 0 => buffer |
||||||
|
" 1 => replace (do not use or you might loose some lines of code) |
||||||
|
" 2 => pager |
||||||
|
" 3 => paste after query |
||||||
|
" 4 => paste before query |
||||||
|
let g:CheatSheetDefaultMode=0 |
||||||
|
|
||||||
|
Path to cheat sheet cookie |
||||||
|
let g:CheatSheetIdPath=expand('~/.cht.sh/id') |
||||||
|
|
||||||
|
< |
||||||
|
You can also disable the mappings (see plugin/cheat.vim to redo the mappings |
||||||
|
manually) |
||||||
|
> |
||||||
|
let g:CheatSheetDoNotMap=1 |
||||||
|
< |
||||||
|
To disable the replacement of man by cheat sheets : |
||||||
|
> |
||||||
|
Let g:CheatDoNotReplaceKeywordPrg=1 |
||||||
|
< |
||||||
|
|
||||||
|
============================================================================== |
||||||
|
Licence *cheat.sh-licence* ~ |
||||||
|
|
||||||
|
This plugin is distributed under GPL Licence v3.0, see |
||||||
|
https://www.gnu.org/licenses/gpl.txt |
@ -0,0 +1,174 @@ |
|||||||
|
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||||
|
" Maintainer: David Beniamine |
||||||
|
" |
||||||
|
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||||
|
" |
||||||
|
" 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/>. |
||||||
|
|
||||||
|
if exists("g:loaded_cheat_sh") |
||||||
|
finish |
||||||
|
endif |
||||||
|
|
||||||
|
let save_cpo = &cpo |
||||||
|
set cpo&vim |
||||||
|
|
||||||
|
let g:loaded_cheat_sh = "v0.2" |
||||||
|
|
||||||
|
" Default query mode |
||||||
|
if(!exists("g:CheatSheetDefaultMode")) |
||||||
|
let g:CheatSheetDefaultMode=0 |
||||||
|
endif |
||||||
|
|
||||||
|
" cheat sheet base url |
||||||
|
if(!exists("g:CheatSheetBaseUrl")) |
||||||
|
let g:CheatSheetBaseUrl='https://cht.sh' |
||||||
|
endif |
||||||
|
|
||||||
|
" command definition |
||||||
|
command! -nargs=? -bang -count -complete=custom,cheat#completeargs Cheat |
||||||
|
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 0, "<bang>") |
||||||
|
|
||||||
|
command! -nargs=? -count CheatError |
||||||
|
\ call cheat#cheat('', -1, -1, -1, 4, '!') |
||||||
|
|
||||||
|
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatReplace |
||||||
|
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 1, "<bang>") |
||||||
|
|
||||||
|
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatPager |
||||||
|
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 2, "<bang>") |
||||||
|
|
||||||
|
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatPaste |
||||||
|
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 3, "<bang>") |
||||||
|
|
||||||
|
command! -nargs=1 CheatNavigateQuestions call cheat#navigate(<q-args>, 'Q') |
||||||
|
command! -nargs=1 CheatNavigateAnswers call cheat#navigate(<q-args>, 'A') |
||||||
|
command! -nargs=1 CheatSeeAlso call cheat#navigate(<q-args>, 'S') |
||||||
|
command! -nargs=1 CheatHistory call cheat#navigate(<q-args>, 'H') |
||||||
|
command! -nargs=? -bang CheatId call cheat#session#id(<q-args>, "<bang>") |
||||||
|
|
||||||
|
|
||||||
|
command! -nargs=1 -bang -count -complete=custom,cheat#completeargs HowIn |
||||||
|
\ call cheat#howin(<q-args>, <line1>, <line2>, <count>) |
||||||
|
|
||||||
|
if((!exists("g:CheatDoNotReplaceKeywordPrg") || |
||||||
|
\ g:CheatDoNotReplaceKeywordPrg ==0)) |
||||||
|
if(has("patch-7.4.1833")) |
||||||
|
set keywordprg=:CheatPager! |
||||||
|
else |
||||||
|
exe 'set keywordprg='.expand('<sfile>:p:h').'/../scripts/chtpager.sh' |
||||||
|
endif |
||||||
|
endif |
||||||
|
|
||||||
|
if(!exists("g:CheatSheetDoNotMap") || g:CheatSheetDoNotMap ==0) |
||||||
|
nnoremap <script> <silent> <leader>C :call cheat#toggleComments()<CR> |
||||||
|
|
||||||
|
" Buffer |
||||||
|
nnoremap <script> <silent> <leader>KB |
||||||
|
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 0, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KB |
||||||
|
\ :call cheat#cheat("", -1, -1, 2, 0, '!')<CR> |
||||||
|
|
||||||
|
" Pager |
||||||
|
nnoremap <script> <silent> <leader>KK |
||||||
|
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 2, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KK |
||||||
|
\ :call cheat#cheat("", -1, -1, 2, 2, '!')<CR> |
||||||
|
|
||||||
|
vnoremap <script> <silent> <leader>KL :call cheat#session#last()<CR> |
||||||
|
nnoremap <script> <silent> <leader>KL :call cheat#session#last()<CR> |
||||||
|
|
||||||
|
|
||||||
|
" Replace |
||||||
|
nnoremap <script> <silent> <leader>KR |
||||||
|
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 1, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KR |
||||||
|
\ :call cheat#cheat("", -1, -1, 2, 1, '!')<CR> |
||||||
|
|
||||||
|
" Paste |
||||||
|
nnoremap <script> <silent> <leader>KP |
||||||
|
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 4, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KP |
||||||
|
\ :call cheat#cheat("", -1, -1, 4, 1, '!')<CR> |
||||||
|
|
||||||
|
nnoremap <script> <silent> <leader>Kp |
||||||
|
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 3, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>Kp |
||||||
|
\ :call cheat#cheat("", -1, -1, 3, 1, '!')<CR> |
||||||
|
|
||||||
|
" Buffer |
||||||
|
nnoremap <script> <silent> <leader>KE |
||||||
|
\ :call cheat#cheat("", -1, -1 , -1, 5, '!')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KE |
||||||
|
\ :call cheat#cheat("", -1, -1, -1, 5, '!')<CR> |
||||||
|
" Toggle comments |
||||||
|
nnoremap <script> <silent> <leader>KC :call cheat#navigate(0, 'C')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KC :call cheat#navigate(0, 'C')<CR> |
||||||
|
|
||||||
|
" Next |
||||||
|
nnoremap <script> <silent> <leader>KQN :call cheat#navigate(1,'Q')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KQN :call cheat#navigate(1,'Q')<CR> |
||||||
|
nnoremap <script> <silent> <leader>KAN :call cheat#navigate(1, 'A')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KAN :call cheat#navigate(1, 'A')<CR> |
||||||
|
nnoremap <script> <silent> <leader>KHN :call cheat#navigate(1, 'H')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KHN :call cheat#navigate(1, 'H')<CR> |
||||||
|
|
||||||
|
" Prev |
||||||
|
nnoremap <script> <silent> <leader>KQP :call cheat#navigate(-1,'Q')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KQP :call cheat#navigate(-1,'Q')<CR> |
||||||
|
nnoremap <script> <silent> <leader>KAP :call cheat#navigate(-1,'A')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KAP :call cheat#navigate(-1,'A')<CR> |
||||||
|
nnoremap <script> <silent> <leader>KHP :call cheat#navigate(-1, 'H')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KHP :call cheat#navigate(-1, 'H')<CR> |
||||||
|
|
||||||
|
" See Also |
||||||
|
nnoremap <script> <silent> <leader>KSN :call cheat#navigate(1,'S')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KSN :call cheat#navigate(1,'S')<CR> |
||||||
|
nnoremap <script> <silent> <leader>KSP :call cheat#navigate(-1,'S')<CR> |
||||||
|
vnoremap <script> <silent> <leader>KSP :call cheat#navigate(-1,'S')<CR> |
||||||
|
|
||||||
|
" Frameworks switch |
||||||
|
nnoremap <script> <silent> <leader>Kf |
||||||
|
\ :call cheat#frameworks#cycle(1)<CR> |
||||||
|
vnoremap <script> <silent> <leader>Kf |
||||||
|
\ :call cheat#frameworks#cycle(1)<CR> |
||||||
|
nnoremap <script> <silent> <leader>KF |
||||||
|
\ :call cheat#frameworks#cycle(-1)<CR> |
||||||
|
vnoremap <script> <silent> <leader>KF |
||||||
|
\ :call cheat#frameworks#cycle(-1)<CR> |
||||||
|
nnoremap <script> <silent> <leader>Kt |
||||||
|
\ :call cheat#frameworks#cycle(0)<CR> |
||||||
|
vnoremap <script> <silent> <leader>Kt |
||||||
|
\ :call cheat#frameworks#cycle(0)<CR> |
||||||
|
nnoremap <script> <silent> <leader>KT |
||||||
|
\ :call cheat#frameworks#autodetect(1)<CR> |
||||||
|
vnoremap <script> <silent> <leader>KT |
||||||
|
\ :call cheat#frameworks#autodetect(1)<CR> |
||||||
|
endif |
||||||
|
|
||||||
|
if(!exists("g:CheatSheetDisableFrameworkDetection") |
||||||
|
\ || g:CheatSheetDisableFrameworkDetection == 0) |
||||||
|
augroup cheat_group |
||||||
|
autocmd! |
||||||
|
autocmd BufReadPost,BufNewFile * call cheat#frameworks#autodetect(0) |
||||||
|
augroup END |
||||||
|
endif |
||||||
|
|
||||||
|
try |
||||||
|
function SyntasticCheckHook(errors) |
||||||
|
call cheat#providers#syntastic#Hook(a:errors) |
||||||
|
endfunction |
||||||
|
endtry |
||||||
|
|
||||||
|
let cpo=save_cpo |
||||||
|
" vim:set et sw=4: |
@ -0,0 +1,2 @@ |
|||||||
|
#!/bin/bash |
||||||
|
\vim -E -c "CheatPager! $@" -c q |
Loading…
Reference in new issue