From 350213b16576472b0f78e52016c09adb132c2b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Sat, 9 Jan 2016 11:53:44 +0100 Subject: [PATCH] Initial commit --- .gitignore | 2 + LICENSE | 674 ++++++++++++++++++++ Makefile | 3 + README.md | 1 + bin/yamllint | 82 +++ tests/__init__.py | 0 tests/rules/__init__.py | 0 tests/rules/common.py | 45 ++ tests/rules/test_colons.py | 220 +++++++ tests/rules/test_document_end.py | 80 +++ tests/rules/test_document_start.py | 90 +++ tests/rules/test_empty_lines.py | 80 +++ tests/rules/test_hyphens.py | 106 +++ tests/rules/test_indentation.py | 191 ++++++ tests/rules/test_line_length.py | 63 ++ tests/rules/test_new_line_at_end_of_file.py | 42 ++ tests/rules/test_new_lines.py | 47 ++ tests/rules/test_trailing_spaces.py | 48 ++ tests/test_parser.py | 93 +++ yamllint/__init__.py | 80 +++ yamllint/conf/default.yml | 39 ++ yamllint/config.py | 103 +++ yamllint/errors.py | 50 ++ yamllint/output.py | 38 ++ yamllint/parser.py | 95 +++ yamllint/rules/__init__.py | 48 ++ yamllint/rules/colons.py | 46 ++ yamllint/rules/document_end.py | 44 ++ yamllint/rules/document_start.py | 43 ++ yamllint/rules/empty_lines.py | 59 ++ yamllint/rules/hyphens.py | 34 + yamllint/rules/indentation.py | 63 ++ yamllint/rules/line_length.py | 29 + yamllint/rules/new_line_at_end_of_file.py | 27 + yamllint/rules/new_lines.py | 34 + yamllint/rules/trailing_spaces.py | 39 ++ 36 files changed, 2738 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100755 bin/yamllint create mode 100644 tests/__init__.py create mode 100644 tests/rules/__init__.py create mode 100644 tests/rules/common.py create mode 100644 tests/rules/test_colons.py create mode 100644 tests/rules/test_document_end.py create mode 100644 tests/rules/test_document_start.py create mode 100644 tests/rules/test_empty_lines.py create mode 100644 tests/rules/test_hyphens.py create mode 100644 tests/rules/test_indentation.py create mode 100644 tests/rules/test_line_length.py create mode 100644 tests/rules/test_new_line_at_end_of_file.py create mode 100644 tests/rules/test_new_lines.py create mode 100644 tests/rules/test_trailing_spaces.py create mode 100644 tests/test_parser.py create mode 100644 yamllint/__init__.py create mode 100644 yamllint/conf/default.yml create mode 100644 yamllint/config.py create mode 100644 yamllint/errors.py create mode 100644 yamllint/output.py create mode 100644 yamllint/parser.py create mode 100644 yamllint/rules/__init__.py create mode 100644 yamllint/rules/colons.py create mode 100644 yamllint/rules/document_end.py create mode 100644 yamllint/rules/document_start.py create mode 100644 yamllint/rules/empty_lines.py create mode 100644 yamllint/rules/hyphens.py create mode 100644 yamllint/rules/indentation.py create mode 100644 yamllint/rules/line_length.py create mode 100644 yamllint/rules/new_line_at_end_of_file.py create mode 100644 yamllint/rules/new_lines.py create mode 100644 yamllint/rules/trailing_spaces.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..58af8a2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__ +*.py[cod] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ace5197 --- /dev/null +++ b/Makefile @@ -0,0 +1,3 @@ +.PHONY: tests +tests: + python -m unittest discover diff --git a/README.md b/README.md new file mode 100644 index 0000000..f702eab --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# yamllint diff --git a/bin/yamllint b/bin/yamllint new file mode 100755 index 0000000..c8b640c --- /dev/null +++ b/bin/yamllint @@ -0,0 +1,82 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from __future__ import print_function +import os.path +import sys + +import argparse + +from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION +from yamllint import config +from yamllint.errors import YamlLintConfigError +from yamllint import lint +from yamllint import output + + +if __name__ == '__main__': + parser = argparse.ArgumentParser(prog=APP_NAME, + description=APP_DESCRIPTION) + parser.add_argument('files', metavar='FILES', nargs='+', + help='files to check') + parser.add_argument('-c', '--config', dest='config_file', action='store', + help='path to a custom configuration') + parser.add_argument('-f', '--format', + choices=('parsable', 'standard'), default='standard', + help='format for parsing output') + parser.add_argument('-v', '--version', action='version', + version='%s %s' % (APP_NAME, APP_VERSION)) + + # TODO: read from stdin when no filename? + + args = parser.parse_args() + + try: + if args.config_file is not None: + conf = config.parse_config_from_file(args.config_file) + elif os.path.isfile('.yamllint'): + conf = config.parse_config_from_file('.yamllint') + else: + conf = config.parse_config('extends: default') + except YamlLintConfigError as e: + print(e, file=sys.stderr) + sys.exit(-1) + + return_code = 0 + + for file in args.files: + if args.format != 'parsable': + print('\033[4m%s\033[0m' % file) + + try: + with open(file) as f: + for problem in lint(f, conf): + if args.format == 'parsable': + print(output.parsable_format(problem, file)) + else: + print(output.standard_format(problem, file)) + + if return_code == 0 and problem.level == 'error': + return_code = 1 + except EnvironmentError as e: + print(e) + return_code = -1 + + if args.format != 'parsable': + print('') + + sys.exit(return_code) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/rules/__init__.py b/tests/rules/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/rules/common.py b/tests/rules/common.py new file mode 100644 index 0000000..d956302 --- /dev/null +++ b/tests/rules/common.py @@ -0,0 +1,45 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import unittest + +import yaml + +from yamllint.config import parse_config +from yamllint.errors import LintProblem +from yamllint import lint + + +class RuleTestCase(unittest.TestCase): + def build_fake_config(self, conf): + if conf is None: + conf = {} + else: + conf = yaml.safe_load(conf) + conf = {'extends': 'default', + 'rules': conf} + return parse_config(yaml.safe_dump(conf)) + + def check(self, source, conf, line=None, column=None, **kwargs): + expected_problems = [] + for key in kwargs: + assert key.startswith('problem') + expected_problems.append( + LintProblem(kwargs[key][0], kwargs[key][1], rule=self.rule_id)) + expected_problems.sort() + + real_problems = list(lint(source, self.build_fake_config(conf))) + self.assertEqual(real_problems, expected_problems) diff --git a/tests/rules/test_colons.py b/tests/rules/test_colons.py new file mode 100644 index 0000000..c6bcc07 --- /dev/null +++ b/tests/rules/test_colons.py @@ -0,0 +1,220 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class ColonTestCase(RuleTestCase): + rule_id = 'colons' + + def test_disabled(self): + conf = 'colons: disable' + self.check('---\n' + 'object:\n' + ' k1 : v1\n' + 'obj2:\n' + ' k2 :\n' + ' - 8\n' + ' k3:\n' + ' val\n' + ' property : value\n' + ' prop2 : val2\n' + ' propriété : [ valeur ]\n' + ' o:\n' + ' k1: [v1, v2]\n' + ' p:\n' + ' - k3: >\n' + ' val\n' + ' - o: { k1: v1 }\n' + ' - p: kdjf\n' + ' - q: val0\n' + ' q2:\n' + ' - val1\n' + '...\n', conf) + self.check('---\n' + 'object:\n' + ' k1: v1\n' + 'obj2:\n' + ' k2:\n' + ' - 8\n' + ' k3:\n' + ' val\n' + ' property: value\n' + ' prop2: val2\n' + ' propriété: [ valeur ]\n' + ' o:\n' + ' k1: [v1, v2]\n', conf) + self.check('---\n' + 'obj:\n' + ' p:\n' + ' - k1: >\n' + ' val\n' + ' - k3: >\n' + ' val\n' + ' - o: { k1: v1 }\n' + ' - o: { k1: v1 }\n' + ' q2:\n' + ' - val1\n' + '...\n', conf) + self.check('---\n' + 'a: {b: {c: d, e : f}}\n', conf) + + def test_before_enabled(self): + conf = 'colons: {max-spaces-before: 0, max-spaces-after: -1}' + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + ' - b\n' + ' k2: v2\n' + '...\n', conf) + self.check('---\n' + 'object:\n' + ' k1 :\n' + ' - a\n' + ' - b\n' + ' k2: v2\n' + '...\n', conf, problem=(3, 5)) + self.check('---\n' + 'lib :\n' + ' - var\n' + '...\n', conf, problem=(2, 4)) + self.check('---\n' + '- lib :\n' + ' - var\n' + '...\n', conf, problem=(2, 6)) + self.check('---\n' + 'a: {b: {c : d, e : f}}\n', conf, + problem1=(2, 10), problem2=(2, 17)) + + def test_before_max(self): + conf = 'colons: {max-spaces-before: 3, max-spaces-after: -1}' + self.check('---\n' + 'object :\n' + ' k1 :\n' + ' - a\n' + ' - b\n' + ' k2 : v2\n' + '...\n', conf) + self.check('---\n' + 'object :\n' + ' k1 :\n' + ' - a\n' + ' - b\n' + ' k2 : v2\n' + '...\n', conf, problem=(3, 8)) + + def test_before_with_explicit_block_mappings(self): + conf = 'colons: {max-spaces-before: 0, max-spaces-after: -1}' + self.check('---\n' + 'object:\n' + ' ? key\n' + ' : value\n' + '...\n', conf) + self.check('---\n' + 'object :\n' + ' ? key\n' + ' : value\n' + '...\n', conf, problem=(2, 7)) + + def test_after_enabled(self): + conf = 'colons: {max-spaces-before: -1, max-spaces-after: 1}' + self.check('---\n' + 'key: value\n', conf) + self.check('---\n' + 'key: value\n', conf, problem=(2, 6)) + self.check('---\n' + 'object:\n' + ' k1: [a, b]\n' + ' k2: string\n', conf, problem=(3, 7)) + self.check('---\n' + 'object:\n' + ' k1: [a, b]\n' + ' k2: string\n', conf, problem=(4, 7)) + self.check('---\n' + 'object:\n' + ' other: {key: value}\n' + '...\n', conf, problem=(3, 16)) + self.check('---\n' + 'a: {b: {c: d, e : f}}\n', conf, + problem1=(2, 12), problem2=(2, 20)) + + def test_after_max(self): + conf = 'colons: {max-spaces-before: -1, max-spaces-after: 3}' + self.check('---\n' + 'object:\n' + ' k1: [a, b]\n', conf) + self.check('---\n' + 'object:\n' + ' k1: [a, b]\n', conf, problem=(3, 9)) + self.check('---\n' + 'object:\n' + ' k2: string\n', conf) + self.check('---\n' + 'object:\n' + ' k2: string\n', conf, problem=(3, 9)) + self.check('---\n' + 'object:\n' + ' other: {key: value}\n' + '...\n', conf) + self.check('---\n' + 'object:\n' + ' other: {key: value}\n' + '...\n', conf, problem=(3, 18)) + + def test_after_with_explicit_block_mappings(self): + conf = 'colons: {max-spaces-before: -1, max-spaces-after: 1}' + self.check('---\n' + 'object:\n' + ' ? key\n' + ' : value\n' + '...\n', conf) + self.check('---\n' + 'object:\n' + ' ? key\n' + ' : value\n' + '...\n', conf, problem=(4, 5)) + + def test_after_do_not_confound_with_trailing_space(self): + conf = ('colons: {max-spaces-before: 1, max-spaces-after: 1}\n' + 'trailing-spaces: disable\n') + self.check('---\n' + 'trailing: \n' + ' - spaces\n', conf) + + def test_both_before_and_after(self): + conf = 'colons: {max-spaces-before: 0, max-spaces-after: 1}' + self.check('---\n' + 'obj:\n' + ' string: text\n' + ' k:\n' + ' - 8\n' + ' k3:\n' + ' val\n' + ' property: [value]\n', conf) + self.check('---\n' + 'object:\n' + ' k1 : v1\n', conf, problem1=(3, 5), problem2=(3, 8)) + self.check('---\n' + 'obj:\n' + ' string: text\n' + ' k :\n' + ' - 8\n' + ' k3:\n' + ' val\n' + ' property: {a: 1, b: 2, c : 3}\n', conf, + problem1=(3, 11), problem2=(4, 4), + problem3=(8, 23), problem4=(8, 28)) diff --git a/tests/rules/test_document_end.py b/tests/rules/test_document_end.py new file mode 100644 index 0000000..4d1305b --- /dev/null +++ b/tests/rules/test_document_end.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class DocumentEndTestCase(RuleTestCase): + rule_id = 'document-end' + + def test_disabled(self): + conf = 'document-end: disable' + self.check('---\n' + 'with:\n' + ' document: end\n' + '...\n', conf) + self.check('---\n' + 'without:\n' + ' document: end\n', conf) + + def test_required(self): + conf = 'document-end: {present: yes}' + self.check('', conf) + self.check('\n', conf) + self.check('---\n' + 'with:\n' + ' document: end\n' + '...\n', conf) + self.check('---\n' + 'without:\n' + ' document: end\n', conf, problem=(3, 1)) + + def test_forbidden(self): + conf = 'document-end: {present: no}' + self.check('---\n' + 'with:\n' + ' document: end\n' + '...\n', conf, problem=(4, 1)) + self.check('---\n' + 'without:\n' + ' document: end\n', conf) + + def test_multiple_documents(self): + conf = ('document-end: {present: yes}\n' + 'document-start: disable\n') + self.check('---\n' + 'first: document\n' + '...\n' + '---\n' + 'second: document\n' + '...\n' + '---\n' + 'third: document\n' + '...\n', conf) + self.check('first: document\n' + '...\n' + 'second: document\n' + '...\n' + 'third: document\n' + '...\n', conf) + self.check('---\n' + 'first: document\n' + '...\n' + '---\n' + 'second: document\n' + '---\n' + 'third: document\n' + '...\n', conf, problem=(6, 1)) diff --git a/tests/rules/test_document_start.py b/tests/rules/test_document_start.py new file mode 100644 index 0000000..228e6fd --- /dev/null +++ b/tests/rules/test_document_start.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class DocumentStartTestCase(RuleTestCase): + rule_id = 'document-start' + + def test_disabled(self): + conf = 'document-start: disable' + self.check('', conf) + self.check('key: val\n', conf) + self.check('---\n' + 'key: val\n', conf) + + def test_required(self): + conf = ('document-start: {present: yes}\n' + 'empty-lines: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('key: val\n', conf, problem=(1, 1)) + self.check('\n' + '\n' + 'key: val\n', conf, problem=(3, 1)) + self.check('---\n' + 'key: val\n', conf) + self.check('\n' + '\n' + '---\n' + 'key: val\n', conf) + + def test_forbidden(self): + conf = ('document-start: {present: no}\n' + 'empty-lines: disable\n') + self.check('', conf) + self.check('key: val\n', conf) + self.check('\n' + '\n' + 'key: val\n', conf) + self.check('---\n' + 'key: val\n', conf, problem=(1, 1)) + self.check('\n' + '\n' + '---\n' + 'key: val\n', conf, problem=(3, 1)) + self.check('first: document\n' + '---\n' + 'key: val\n', conf, problem=(2, 1)) + + def test_multiple_documents(self): + conf = 'document-start: {present: yes}' + self.check('---\n' + 'first: document\n' + '...\n' + '---\n' + 'second: document\n' + '...\n' + '---\n' + 'third: document\n', conf) + self.check('---\n' + 'first: document\n' + '---\n' + 'second: document\n' + '---\n' + 'third: document\n', conf) + self.check('---\n' + 'first: document\n' + '...\n' + 'second: document\n' + '---\n' + 'third: document\n', conf, problem=(4, 1)) + + def test_directives(self): + # TODO + # %YAML 1.2 + pass diff --git a/tests/rules/test_empty_lines.py b/tests/rules/test_empty_lines.py new file mode 100644 index 0000000..5c5e819 --- /dev/null +++ b/tests/rules/test_empty_lines.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class EmptyLinesTestCase(RuleTestCase): + rule_id = 'empty-lines' + + def test_disabled(self): + conf = ('empty-lines: disable\n' + 'new-line-at-end-of-file: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('\n\n', conf) + self.check('\n\n\n\n\n\n\n\n\n', conf) + self.check('some text\n\n\n\n\n\n\n\n\n', conf) + self.check('\n\n\n\n\n\n\n\n\nsome text', conf) + self.check('\n\n\nsome text\n\n\n', conf) + + def test_empty_document(self): + conf = ('empty-lines: {max: 0, max-start: 0, max-end: 0}\n' + 'new-line-at-end-of-file: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + + def test_0_empty_lines(self): + conf = ('empty-lines: {max: 0, max-start: 0, max-end: 0}\n' + 'new-line-at-end-of-file: disable\n') + self.check('---\n', conf) + self.check('---\ntext\n\ntext', conf, problem=(3, 1)) + self.check('---\ntext\n\ntext\n', conf, problem=(3, 1)) + + def test_10_empty_lines(self): + conf = 'empty-lines: {max: 10, max-start: 0, max-end: 0}' + self.check('---\nintro\n\n\n\n\n\n\n\n\n\n\nconclusion\n', conf) + self.check('---\nintro\n\n\n\n\n\n\n\n\n\n\n\nconclusion\n', conf, + problem=(13, 1)) + + def test_spaces(self): + conf = ('empty-lines: {max: 1, max-start: 0, max-end: 0}\n' + 'trailing-spaces: disable\n') + self.check('---\nintro\n\n \n\nconclusion\n', conf) + self.check('---\nintro\n\n \n\n\nconclusion\n', conf, problem=(6, 1)) + + def test_empty_lines_at_start(self): + conf = ('empty-lines: {max: 2, max-start: 4, max-end: 0}\n' + 'document-start: disable\n') + self.check('\n\n\n\nnon empty\n', conf) + self.check('\n\n\n\n\nnon empty\n', conf, problem=(5, 1)) + + conf = ('empty-lines: {max: 2, max-start: 0, max-end: 0}\n' + 'document-start: disable\n') + self.check('non empty\n', conf) + self.check('\nnon empty\n', conf, problem=(1, 1)) + + def test_empty_lines_at_end(self): + conf = ('empty-lines: {max: 2, max-start: 0, max-end: 4}\n' + 'document-start: disable\n') + self.check('non empty\n\n\n\n\n', conf) + self.check('non empty\n\n\n\n\n\n', conf, problem=(6, 1)) + conf = ('empty-lines: {max: 2, max-start: 0, max-end: 0}\n' + 'document-start: disable\n') + self.check('non empty\n', conf) + self.check('non empty\n\n', conf, problem=(2, 1)) diff --git a/tests/rules/test_hyphens.py b/tests/rules/test_hyphens.py new file mode 100644 index 0000000..dfd2810 --- /dev/null +++ b/tests/rules/test_hyphens.py @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class HyphenTestCase(RuleTestCase): + rule_id = 'hyphens' + + def test_disabled(self): + conf = 'hyphens: disable' + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + 'object:\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + 'object:\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + 'object:\n' + ' subobject:\n' + ' - elem1\n' + ' - elem2\n', conf) + self.check('---\n' + 'object:\n' + ' subobject:\n' + ' - elem1\n' + ' - elem2\n', conf) + + def test_enabled(self): + conf = 'hyphens: {max-spaces-after: 1}' + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf, problem=(3, 3)) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf, problem1=(2, 3), problem2=(3, 3)) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf, problem=(2, 3)) + self.check('---\n' + 'object:\n' + '- elem1\n' + '- elem2\n', conf, problem=(4, 3)) + self.check('---\n' + 'object:\n' + '- elem1\n' + '- elem2\n', conf, problem1=(3, 3), problem2=(4, 3)) + self.check('---\n' + 'object:\n' + ' subobject:\n' + ' - elem1\n' + ' - elem2\n', conf, problem=(5, 7)) + self.check('---\n' + 'object:\n' + ' subobject:\n' + ' - elem1\n' + ' - elem2\n', conf, problem1=(4, 7), problem2=(5, 7)) + + def test_max_3(self): + conf = 'hyphens: {max-spaces-after: 3}' + self.check('---\n' + '- elem1\n' + '- elem2\n', conf) + self.check('---\n' + '- elem1\n' + '- elem2\n', conf, problem=(2, 5)) + self.check('---\n' + 'a:\n' + ' b:\n' + ' - elem1\n' + ' - elem2\n', conf) + self.check('---\n' + 'a:\n' + ' b:\n' + ' - elem1\n' + ' - elem2\n', conf, problem1=(4, 9), problem2=(5, 9)) diff --git a/tests/rules/test_indentation.py b/tests/rules/test_indentation.py new file mode 100644 index 0000000..e7cdec9 --- /dev/null +++ b/tests/rules/test_indentation.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class IndentationTestCase(RuleTestCase): + rule_id = 'indentation' + + def test_disabled(self): + conf = 'indentation: disable' + self.check('---\n' + 'object:\n' + ' k1: v1\n' + 'obj2:\n' + ' k2:\n' + ' - 8\n' + ' k3:\n' + ' val\n' + '...\n', conf) + self.check('---\n' + ' o:\n' + ' k1: v1\n' + ' p:\n' + ' k3:\n' + ' val\n' + '...\n', conf) + self.check('---\n' + ' - o:\n' + ' k1: v1\n' + ' - p: kdjf\n' + ' - q:\n' + ' k3:\n' + ' - val\n' + '...\n', conf) + + def test_one_space(self): + conf = 'indentation: {spaces: 1}' + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + ' - b\n' + ' k2: v2\n' + '...\n', conf) + + def test_two_spaces(self): + conf = 'indentation: {spaces: 2}' + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + ' - b\n' + ' k2: v2\n' + '...\n', conf) + + def test_three_spaces(self): + conf = 'indentation: {spaces: 3}' + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + ' - b\n' + ' k2: v2\n' + '...\n', conf) + + def test_under_indented(self): + conf = 'indentation: {spaces: 2}' + self.check('---\n' + 'object:\n' + ' val: 1\n' + '...\n', conf, problem=(3, 2)) + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + '...\n', conf, problem=(4, 4)) + conf = 'indentation: {spaces: 4}' + self.check('---\n' + 'object:\n' + ' val: 1\n' + '...\n', conf, problem=(3, 4)) + self.check('---\n' + '- el1\n' + '- el2:\n' + ' - subel\n' + '...\n', conf, problem=(4, 4)) + + def test_over_indented(self): + conf = 'indentation: {spaces: 2}' + self.check('---\n' + 'object:\n' + ' val: 1\n' + '...\n', conf, problem=(3, 4)) + self.check('---\n' + 'object:\n' + ' k1:\n' + ' - a\n' + '...\n', conf, problem=(4, 6)) + conf = 'indentation: {spaces: 4}' + self.check('---\n' + 'object:\n' + ' val: 1\n' + '...\n', conf, problem=(3, 6)) + self.check('---\n' + ' object:\n' + ' val: 1\n' + '...\n', conf, problem=(2, 2)) + self.check('---\n' + '- el1\n' + '- el2:\n' + ' - subel\n' + '...\n', conf, problem=(4, 6)) + self.check('---\n' + '- el1\n' + '- el2:\n' + ' - subel\n' + '...\n', conf, problem=(4, 15)) + self.check('---\n' + ' - el1\n' + ' - el2:\n' + ' - subel\n' + '...\n', conf, problem1=(2, 3), problem2=(4, 7)) + + def test_multi_lines(self): + self.check('---\n' + 'long_string: >\n' + ' bla bla blah\n' + ' blah bla bla\n' + '...\n', None) + self.check('---\n' + '- long_string: >\n' + ' bla bla blah\n' + ' blah bla bla\n' + '...\n', None) + self.check('---\n' + 'obj:\n' + ' - long_string: >\n' + ' bla bla blah\n' + ' blah bla bla\n' + '...\n', None) + + def test_nested_collections(self): + self.check('---\n' + '- o:\n' + ' k1: v1\n' + '...\n', None) + self.check('---\n' + '- o:\n' + ' k1: v1\n' + '...\n', None, problem=(3, 4)) + self.check('---\n' + '- o:\n' + ' k1: v1\n' + '...\n', None, problem=(3, 6)) + + def test_return(self): + self.check('---\n' + 'a:\n' + ' b:\n' + ' c:\n' + ' d:\n' + ' e:\n' + ' f:\n' + 'g:\n' + '...\n', None) + # self.check('---\n' + # 'a:\n' + # ' b:\n' + # ' c:\n' + # ' d:\n' + # '...\n', None, problem=(5, 5)) + # self.check('---\n' + # 'a:\n' + # ' b:\n' + # ' c:\n' + # ' d:\n' + # '...\n', None, problem=(5, 2)) diff --git a/tests/rules/test_line_length.py b/tests/rules/test_line_length.py new file mode 100644 index 0000000..7ea2c20 --- /dev/null +++ b/tests/rules/test_line_length.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class LineLengthTestCase(RuleTestCase): + rule_id = 'line-length' + + def test_disabled(self): + conf = ('line-length: disable\n' + 'empty-lines: disable\n' + 'new-line-at-end-of-file: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('---\n', conf) + self.check(81 * 'a', conf) + self.check('---\n' + 81 * 'a' + '\n', conf) + self.check(1000 * 'b', conf) + self.check('---\n' + 1000 * 'b' + '\n', conf) + + def test_default(self): + conf = ('line-length: {max: 80}\n' + 'empty-lines: disable\n' + 'new-line-at-end-of-file: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('---\n', conf) + self.check(80 * 'a', conf) + self.check('---\n' + 80 * 'a' + '\n', conf) + self.check(81 * 'a', conf, problem=(1, 81)) + self.check('---\n' + 81 * 'a' + '\n', conf, problem=(2, 81)) + self.check(1000 * 'b', conf, problem=(1, 81)) + self.check('---\n' + 1000 * 'b' + '\n', conf, problem=(2, 81)) + + def test_max_length_10(self): + conf = ('line-length: {max: 10}\n' + 'new-line-at-end-of-file: disable\n') + self.check('---\nABCDEFGHIJ', conf) + self.check('---\nABCDEFGHIJK', conf, problem=(2, 11)) + self.check('---\nABCDEFGHIJK\n', conf, problem=(2, 11)) + + def test_spaces(self): + conf = ('line-length: {max: 80}\n' + 'new-line-at-end-of-file: disable\n' + 'trailing-spaces: disable\n') + self.check('---\n' + 81 * ' ', conf, problem=(2, 81)) + self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81)) diff --git a/tests/rules/test_new_line_at_end_of_file.py b/tests/rules/test_new_line_at_end_of_file.py new file mode 100644 index 0000000..1c80668 --- /dev/null +++ b/tests/rules/test_new_line_at_end_of_file.py @@ -0,0 +1,42 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class NewLineAtEndOfFileTestCase(RuleTestCase): + rule_id = 'new-line-at-end-of-file' + + def test_disabled(self): + conf = ('new-line-at-end-of-file: disable\n' + 'empty-lines: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('word', conf) + self.check('Sentence.\n', conf) + + def test_enabled(self): + conf = ('new-line-at-end-of-file: {}\n' + 'empty-lines: disable\n' + 'document-start: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('word', conf, problem=(1, 5)) + self.check('Sentence.\n', conf) + self.check('---\n' + 'yaml: document\n' + '...', conf, problem=(3, 4)) diff --git a/tests/rules/test_new_lines.py b/tests/rules/test_new_lines.py new file mode 100644 index 0000000..e330e03 --- /dev/null +++ b/tests/rules/test_new_lines.py @@ -0,0 +1,47 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class NewLinesTestCase(RuleTestCase): + rule_id = 'new-lines' + + def test_disabled(self): + conf = ('new-line-at-end-of-file: disable\n' + 'new-lines: disable\n') + self.check('', conf) + self.check('\n', conf) + self.check('\r', conf) + self.check('\r\n', conf) + self.check('---\ntext\n', conf) + self.check('---\r\ntext\r\n', conf) + + def test_unix_type(self): + conf = 'new-lines: {type: unix}' + self.check('', conf) + self.check('\n', conf) + self.check('\r\n', conf, problem=(1, 1)) + self.check('---\ntext\n', conf) + self.check('---\r\ntext\r\n', conf, problem=(1, 4)) + + def test_dos_type(self): + conf = 'new-lines: {type: dos}\n' + self.check('', conf) + self.check('\n', conf, problem=(1, 1)) + self.check('\r\n', conf) + self.check('---\ntext\n', conf, problem=(1, 4)) + self.check('---\r\ntext\r\n', conf) diff --git a/tests/rules/test_trailing_spaces.py b/tests/rules/test_trailing_spaces.py new file mode 100644 index 0000000..75ffe3d --- /dev/null +++ b/tests/rules/test_trailing_spaces.py @@ -0,0 +1,48 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from tests.rules.common import RuleTestCase + + +class TrailingSpacesTestCase(RuleTestCase): + rule_id = 'trailing-spaces' + + def test_disabled(self): + conf = 'trailing-spaces: disable' + self.check('', conf) + self.check('\n', conf) + self.check(' \n', conf) + self.check('---\n' + 'some: text \n', conf) + + def test_enabled(self): + conf = 'trailing-spaces: {}' + self.check('', conf) + self.check('\n', conf) + self.check(' \n', conf, problem=(1, 1)) + self.check('\t\t\t\n', conf, problem=(1, 1)) + self.check('---\n' + 'some: text \n', conf, problem=(2, 11)) + self.check('---\n' + 'some: text\t\n', conf, problem=(2, 11)) + + def test_with_dos_new_lines(self): + conf = ('trailing-spaces: {}\n' + 'new-lines: {type: dos}\n') + self.check('---\r\n' + 'some: text\r\n', conf) + self.check('---\r\n' + 'some: text \r\n', conf, problem=(2, 11)) diff --git a/tests/test_parser.py b/tests/test_parser.py new file mode 100644 index 0000000..1c46f66 --- /dev/null +++ b/tests/test_parser.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import unittest + +import yaml + +from yamllint.parser import (line_generator, token_generator, + token_or_line_generator, Line, Token) + + +class ParserTestCase(unittest.TestCase): + def test_line_generator(self): + e = list(line_generator('')) + self.assertEqual(len(e), 1) + self.assertEqual(e[0].line_no, 1) + self.assertEqual(e[0].start, 0) + self.assertEqual(e[0].end, 0) + + e = list(line_generator('\n')) + self.assertEqual(len(e), 2) + + e = list(line_generator(' \n')) + self.assertEqual(len(e), 2) + self.assertEqual(e[0].line_no, 1) + self.assertEqual(e[0].start, 0) + self.assertEqual(e[0].end, 1) + + e = list(line_generator('\n\n')) + self.assertEqual(len(e), 3) + + e = list(line_generator('---\n' + 'this is line 1\n' + 'line 2\n' + '\n' + '3\n')) + self.assertEqual(len(e), 6) + self.assertEqual(e[0].line_no, 1) + self.assertEqual(e[0].content, '---') + self.assertEqual(e[2].content, 'line 2') + self.assertEqual(e[3].content, '') + self.assertEqual(e[5].line_no, 6) + + e = list(line_generator('test with\n' + 'no newline\n' + 'at the end')) + self.assertEqual(len(e), 3) + self.assertEqual(e[2].line_no, 3) + self.assertEqual(e[2].content, 'at the end') + + def test_token_generator(self): + e = list(token_generator('')) + self.assertEqual(len(e), 2) + self.assertEqual(e[0].prev, None) + self.assertIsInstance(e[0].curr, yaml.Token) + self.assertIsInstance(e[0].next, yaml.Token) + self.assertEqual(e[1].prev, e[0].curr) + self.assertEqual(e[1].curr, e[0].next) + self.assertEqual(e[1].next, None) + + e = list(token_generator('---\n' + 'k: v\n')) + self.assertEqual(len(e), 9) + self.assertIsInstance(e[3].curr, yaml.KeyToken) + self.assertIsInstance(e[5].curr, yaml.ValueToken) + + def test_token_or_line_generator(self): + e = list(token_or_line_generator('---\n' + 'k: v\n')) + self.assertEqual(len(e), 12) + self.assertIsInstance(e[0], Token) + self.assertIsInstance(e[0].curr, yaml.StreamStartToken) + self.assertIsInstance(e[1], Token) + self.assertIsInstance(e[1].curr, yaml.DocumentStartToken) + self.assertIsInstance(e[2], Line) + self.assertIsInstance(e[3].curr, yaml.BlockMappingStartToken) + self.assertIsInstance(e[4].curr, yaml.KeyToken) + self.assertIsInstance(e[6].curr, yaml.ValueToken) + self.assertIsInstance(e[8], Line) + self.assertIsInstance(e[11], Line) diff --git a/yamllint/__init__.py b/yamllint/__init__.py new file mode 100644 index 0000000..d8b8edc --- /dev/null +++ b/yamllint/__init__.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint import config +from yamllint import parser + + +APP_NAME = 'yamllint' +APP_VERSION = '0.1.0' +APP_DESCRIPTION = 'Lint YAML files.' + +__author__ = 'Adrien Vergé' +__copyright__ = 'Copyright 2016, Adrien Vergé' +__license__ = 'GPLv3' +__version__ = APP_VERSION + + +def _lint(buffer, conf): + rules = config.get_enabled_rules(conf) + + # Split token rules from line rules + token_rules = [r for r in rules if r.TYPE == 'token'] + line_rules = [r for r in rules if r.TYPE == 'line'] + + # If the document contains a syntax error, save it and yield it at the + # right line + syntax_error = parser.get_syntax_error(buffer) + + for elem in parser.token_or_line_generator(buffer): + if syntax_error and syntax_error.line <= elem.line_no: + syntax_error.level = 'error' + yield syntax_error + syntax_error = None + + if isinstance(elem, parser.Token): + for rule in token_rules: + rule_conf = conf[rule.ID] + for problem in rule.check(rule_conf, + elem.curr, elem.prev, elem.next): + problem.rule = rule.ID + problem.level = rule_conf['level'] + yield problem + elif isinstance(elem, parser.Line): + for rule in line_rules: + rule_conf = conf[rule.ID] + for problem in rule.check(rule_conf, elem): + problem.rule = rule.ID + problem.level = rule_conf['level'] + yield problem + + +def lint(input, conf): + """Lints a YAML source. + + Returns a generator of LintProblem objects. + + :param input: buffer, string or stream to read from + :param conf: yamllint configuration object + """ + if type(input) == str: + return _lint(input, conf) + elif hasattr(input, 'read'): # Python 2's file or Python 3's io.IOBase + # We need to have everything in memory to parse correctly + content = input.read() + return _lint(content, conf) + else: + raise TypeError('input should be a string or a stream') diff --git a/yamllint/conf/default.yml b/yamllint/conf/default.yml new file mode 100644 index 0000000..c4413fd --- /dev/null +++ b/yamllint/conf/default.yml @@ -0,0 +1,39 @@ +--- + +rules: + #block-sequence-indentation: + # present: yes + colons: + max-spaces-before: 0 + max-spaces-after: 1 + #comma: + # max-spaces-before: 0 + # max-spaces-after: 1 + #comment: + # min-spaces-after: 1 + # min-spaces-before: 2 + document-end: disable + document-start: + level: warning + present: yes + empty-lines: + max: 2 + max-start: 0 + max-end: 0 + hyphens: + max-spaces-after: 1 + indentation: + spaces: 2 + #comments: yes + line-length: + max: 80 + new-line-at-end-of-file: {level: error} + new-lines: + type: unix + #spaces-in-brackets: [ 1, 2 ] + # min: 1 + # max: 1 + #spaces-in-braces: { df: d } + # min: 1 + # max: 1 + trailing-spaces: {} diff --git a/yamllint/config.py b/yamllint/config.py new file mode 100644 index 0000000..de40705 --- /dev/null +++ b/yamllint/config.py @@ -0,0 +1,103 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import os.path + +import yaml + +import yamllint.rules +from yamllint.errors import YamlLintConfigError + + +def get_extended_conf(name): + # Is it a standard conf shipped with yamllint... + if '/' not in name: + std_conf = os.path.join(os.path.dirname(os.path.realpath(__file__)), + 'conf', name + '.yml') + + if os.path.isfile(std_conf): + return std_conf + + # or a custom conf on filesystem? + return name + + +def extend_config(content): + try: + conf = yaml.safe_load(content) + + if 'rules' not in conf: + conf['rules'] = {} + + # Does this conf override another conf that we need to load? + if 'extends' in conf: + base = parse_config_from_file(get_extended_conf(conf['extends'])) + + base.update(conf['rules']) + conf['rules'] = base + + return conf + except Exception as e: + raise YamlLintConfigError('invalid config: %s' % e) + + +def parse_config(content): + conf = extend_config(content) + rules = {} + + for id in conf['rules']: + try: + rule = yamllint.rules.get(id) + except Exception as e: + raise YamlLintConfigError('invalid config: %s' % e) + + if conf['rules'][id] == 'disable': + continue + + rules[id] = {'level': 'error'} + if type(conf['rules'][id]) == dict: + if 'level' in conf['rules'][id]: + if conf['rules'][id]['level'] not in ('error', 'warning'): + raise YamlLintConfigError( + 'invalid config: level should be "error" or "warning"') + rules[id]['level'] = conf['rules'][id]['level'] + + options = getattr(rule, 'CONF', {}) + for optkey in conf['rules'][id]: + if optkey == 'level': + continue + if optkey not in options: + raise YamlLintConfigError( + 'invalid config: unknown option "%s" for rule "%s"' % + (optkey, id)) + if type(conf['rules'][id][optkey]) != options[optkey]: + raise YamlLintConfigError( + 'invalid config: option "%s" of "%s" should be %s' % + (optkey, id, options[optkey].__name__)) + rules[id][optkey] = conf['rules'][id][optkey] + else: + raise YamlLintConfigError(('invalid config: rule "%s": should be ' + 'either "disable" or a dict') % id) + return rules + + +def parse_config_from_file(path): + with open(path) as f: + return parse_config(f.read()) + + +def get_enabled_rules(conf): + return [yamllint.rules.get(r) for r in conf.keys() if conf[r] is not False] diff --git a/yamllint/errors.py b/yamllint/errors.py new file mode 100644 index 0000000..8e1f02a --- /dev/null +++ b/yamllint/errors.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + + +class LintProblem(object): + def __init__(self, line, column, desc='', rule=None): + self.line = line + self.column = column + self.desc = desc + self.rule = rule + self.level = None + + @property + def message(self): + if self.rule is not None: + return '%s (%s)' % (self.desc, self.rule) + return self.desc + + def __eq__(self, other): + return (self.line == other.line and + self.column == other.column and + self.rule == other.rule) + + def __lt__(self, other): + return (self.line < other.line or + (self.line == other.line and self.column < other.column)) + + def __repr__(self): + return '%d:%d: %s' % (self.line, self.column, self.message) + + +class YamlLintError(Exception): + pass + + +class YamlLintConfigError(YamlLintError): + pass diff --git a/yamllint/output.py b/yamllint/output.py new file mode 100644 index 0000000..eaedbf3 --- /dev/null +++ b/yamllint/output.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + + +def parsable_format(problem, filename): + return ('%(file)s:%(line)s:%(column)s: [%(level)s] %(message)s' % + {'file': filename, + 'line': problem.line, + 'column': problem.column, + 'level': problem.level, + 'message': problem.message}) + + +def standard_format(problem, filename): + line = ' \033[2m%d:%d\033[0m' % (problem.line, problem.column) + line += max(20 - len(line), 0) * ' ' + if problem.level == 'warning': + line += '\033[33m%s\033[0m' % problem.level + else: + line += '\033[31m%s\033[0m' % problem.level + line += max(38 - len(line), 0) * ' ' + line += problem.desc + if problem.rule: + line += ' \033[2m(%s)\033[0m' % problem.rule + return line diff --git a/yamllint/parser.py b/yamllint/parser.py new file mode 100644 index 0000000..2265cc0 --- /dev/null +++ b/yamllint/parser.py @@ -0,0 +1,95 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +class Line(object): + def __init__(self, line_no, buffer, start, end): + self.line_no = line_no + self.start = start + self.end = end + self.buffer = buffer + + @property + def content(self): + return self.buffer[self.start:self.end] + + +class Token(object): + def __init__(self, line_no, curr, prev, next): + self.line_no = line_no + self.curr = curr + self.prev = prev + self.next = next + + +def line_generator(buffer): + line_no = 1 + cur = 0 + next = buffer.find('\n') + while next != -1: + yield Line(line_no, buffer, start=cur, end=next) + cur = next + 1 + next = buffer.find('\n', cur) + line_no += 1 + + yield Line(line_no, buffer, start=cur, end=len(buffer)) + + +def token_generator(buffer): + yaml_loader = yaml.BaseLoader(buffer) + + try: + prev = None + next = yaml_loader.peek_token() + while next is not None: + curr = yaml_loader.get_token() + next = yaml_loader.peek_token() + + yield Token(curr.start_mark.line + 1, curr, prev, next) + + prev = curr + except yaml.scanner.ScannerError: + pass + + +def token_or_line_generator(buffer): + """Generator that mixes tokens and lines, ordering them by line number""" + token_gen = token_generator(buffer) + line_gen = line_generator(buffer) + + token = next(token_gen, None) + line = next(line_gen, None) + + while token is not None or line is not None: + if token is None or (line is not None and + token.line_no > line.line_no): + yield line + line = next(line_gen, None) + else: + yield token + token = next(token_gen, None) + + +def get_syntax_error(buffer): + try: + yaml.safe_load_all(buffer) + except yaml.error.MarkedYAMLError as e: + return LintProblem(e.problem_mark.line + 1, e.problem_mark.column + 1, + 'syntax error: ' + e.problem) diff --git a/yamllint/rules/__init__.py b/yamllint/rules/__init__.py new file mode 100644 index 0000000..6d818f2 --- /dev/null +++ b/yamllint/rules/__init__.py @@ -0,0 +1,48 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint.rules import ( + colons, + document_end, + document_start, + empty_lines, + hyphens, + indentation, + line_length, + new_line_at_end_of_file, + new_lines, + trailing_spaces, +) + +_RULES = { + colons.ID: colons, + document_end.ID: document_end, + document_start.ID: document_start, + empty_lines.ID: empty_lines, + hyphens.ID: hyphens, + indentation.ID: indentation, + line_length.ID: line_length, + new_line_at_end_of_file.ID: new_line_at_end_of_file, + new_lines.ID: new_lines, + trailing_spaces.ID: trailing_spaces, +} + + +def get(id): + if id not in _RULES: + raise ValueError('no such rule: "%s"' % id) + + return _RULES[id] diff --git a/yamllint/rules/colons.py b/yamllint/rules/colons.py new file mode 100644 index 0000000..4d644aa --- /dev/null +++ b/yamllint/rules/colons.py @@ -0,0 +1,46 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +ID = 'colons' +TYPE = 'token' +CONF = {'max-spaces-before': int, + 'max-spaces-after': int} + + +def check(conf, token, prev, next): + if isinstance(token, yaml.ValueToken): + if (prev is not None and + prev.end_mark.line == token.start_mark.line and + conf['max-spaces-before'] != - 1 and + (prev.end_mark.pointer + conf['max-spaces-before'] < + token.start_mark.pointer)): + yield LintProblem(token.start_mark.line + 1, + token.start_mark.column, + 'too many spaces before colon') + + if (next is not None and + token.end_mark.line == next.start_mark.line and + conf['max-spaces-after'] != - 1 and + (next.start_mark.pointer - token.end_mark.pointer > + conf['max-spaces-after'])): + yield LintProblem(token.start_mark.line + 1, + next.start_mark.column, + 'too many spaces after colon') diff --git a/yamllint/rules/document_end.py b/yamllint/rules/document_end.py new file mode 100644 index 0000000..7850619 --- /dev/null +++ b/yamllint/rules/document_end.py @@ -0,0 +1,44 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +ID = 'document-end' +TYPE = 'token' +CONF = {'present': bool} + + +def check(conf, token, prev, next): + if conf['present']: + if (isinstance(token, yaml.StreamEndToken) and + not (isinstance(prev, yaml.DocumentEndToken) or + isinstance(prev, yaml.StreamStartToken))): + yield LintProblem(token.start_mark.line, 1, + 'missing document end "..."') + elif (isinstance(token, yaml.DocumentStartToken) and + not (isinstance(prev, yaml.DocumentEndToken) or + isinstance(prev, yaml.StreamStartToken))): + yield LintProblem(token.start_mark.line + 1, 1, + 'missing document end "..."') + + else: + if isinstance(token, yaml.DocumentEndToken): + yield LintProblem(token.start_mark.line + 1, + token.start_mark.column + 1, + 'found forbidden document end "..."') diff --git a/yamllint/rules/document_start.py b/yamllint/rules/document_start.py new file mode 100644 index 0000000..b0d3554 --- /dev/null +++ b/yamllint/rules/document_start.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +ID = 'document-start' +TYPE = 'token' +CONF = {'present': bool} + + +# TODO: Don't fail if document contains directives such as +# %YAML 1.2 + +def check(conf, token, prev, next): + if conf['present']: + if ((isinstance(prev, yaml.StreamStartToken) or + isinstance(prev, yaml.DocumentEndToken)) and + not (isinstance(token, yaml.DocumentStartToken) or + isinstance(token, yaml.StreamEndToken))): + yield LintProblem(token.start_mark.line + 1, 1, + 'missing document start "---"') + + else: + if isinstance(token, yaml.DocumentStartToken): + yield LintProblem(token.start_mark.line + 1, + token.start_mark.column + 1, + 'found forbidden document start "---"') diff --git a/yamllint/rules/empty_lines.py b/yamllint/rules/empty_lines.py new file mode 100644 index 0000000..3023796 --- /dev/null +++ b/yamllint/rules/empty_lines.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint.errors import LintProblem + + +ID = 'empty-lines' +TYPE = 'line' +CONF = {'max': int, + 'max-start': int, + 'max-end': int} + + +def check(conf, line): + if line.start == line.end and line.end < len(line.buffer): + # Only alert on the last blank line of a serie + if (line.end < len(line.buffer) - 1 and + line.buffer[line.end + 1] == '\n'): + return + + blank_lines = 0 + + while (line.start > blank_lines and + line.buffer[line.start - blank_lines - 1] == '\n'): + blank_lines += 1 + + max = conf['max'] + + # Special case: start of document + if line.start - blank_lines == 0: + blank_lines += 1 # first line doesn't have a preceding \n + max = conf['max-start'] + + # Special case: end of document + # NOTE: The last line of a file is always supposed to end with a new + # line. See POSIX definition of a line at: + if line.end == len(line.buffer) - 1 and line.buffer[line.end] == '\n': + # Allow the exception of the one-byte file containing '\n' + if line.end == 0: + return + + max = conf['max-end'] + + if blank_lines > max: + yield LintProblem(line.line_no, 1, 'too many blank lines (%d > %d)' + % (blank_lines, max)) diff --git a/yamllint/rules/hyphens.py b/yamllint/rules/hyphens.py new file mode 100644 index 0000000..1231762 --- /dev/null +++ b/yamllint/rules/hyphens.py @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +ID = 'hyphens' +TYPE = 'token' +CONF = {'max-spaces-after': int} + + +def check(conf, token, prev, next): + if isinstance(token, yaml.BlockEntryToken): + if token.end_mark.line == next.start_mark.line: + if (next.start_mark.pointer - token.end_mark.pointer > + conf['max-spaces-after']): + yield LintProblem(token.start_mark.line + 1, + next.start_mark.column, + 'too many spaces after hyphen') diff --git a/yamllint/rules/indentation.py b/yamllint/rules/indentation.py new file mode 100644 index 0000000..e31b095 --- /dev/null +++ b/yamllint/rules/indentation.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import yaml + +from yamllint.errors import LintProblem + + +ID = 'indentation' +TYPE = 'token' +CONF = {'spaces': int} + + +def check(conf, token, prev, next): + if isinstance(token, yaml.StreamEndToken): + return + + if (prev is None or isinstance(prev, yaml.StreamStartToken) or + isinstance(prev, yaml.DirectiveToken) or + isinstance(prev, yaml.DocumentStartToken)): + if token.start_mark.column != 0: + yield LintProblem( + token.end_mark.line + 1, token.start_mark.column + 1, + 'found indentation of %d instead of %d' % + (token.start_mark.column, 0)) + return + + if token.start_mark.line > prev.end_mark.line: + buffer = prev.end_mark.buffer + + start = buffer.rfind('\n', 0, prev.end_mark.pointer) + 1 + prev_indent = 0 + + # YAML recognizes two white space characters: space and tab. + # http://yaml.org/spec/1.2/spec.html#id2775170 + while buffer[start + prev_indent] in ' \t': + prev_indent += 1 + + # Discard any leading '- ' + if (buffer[start + prev_indent:start + prev_indent + 2] == '- '): + prev_indent += 2 + while buffer[start + prev_indent] in ' \t': + prev_indent += 1 + + if (token.start_mark.column > prev_indent and + token.start_mark.column != prev_indent + conf['spaces']): + yield LintProblem( + token.end_mark.line + 1, token.start_mark.column + 1, + 'found indentation of %d instead of %d' % + (token.start_mark.column, prev_indent + conf['spaces'])) diff --git a/yamllint/rules/line_length.py b/yamllint/rules/line_length.py new file mode 100644 index 0000000..23186dc --- /dev/null +++ b/yamllint/rules/line_length.py @@ -0,0 +1,29 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint.errors import LintProblem + + +ID = 'line-length' +TYPE = 'line' +CONF = {'max': int} + + +def check(conf, line): + if line.end - line.start > conf['max']: + yield LintProblem(line.line_no, conf['max'] + 1, + 'line too long (%d > %d characters)' % + (line.end - line.start, conf['max'])) diff --git a/yamllint/rules/new_line_at_end_of_file.py b/yamllint/rules/new_line_at_end_of_file.py new file mode 100644 index 0000000..56b0ed6 --- /dev/null +++ b/yamllint/rules/new_line_at_end_of_file.py @@ -0,0 +1,27 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint.errors import LintProblem + + +ID = 'new-line-at-end-of-file' +TYPE = 'line' + + +def check(conf, line): + if line.end == len(line.buffer) and line.end > line.start: + yield LintProblem(line.line_no, line.end - line.start + 1, + 'no new line character at the end of file') diff --git a/yamllint/rules/new_lines.py b/yamllint/rules/new_lines.py new file mode 100644 index 0000000..0874315 --- /dev/null +++ b/yamllint/rules/new_lines.py @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +from yamllint.errors import LintProblem + + +ID = 'new-lines' +TYPE = 'line' +CONF = {'type': str} + + +def check(conf, line): + if line.start == 0 and len(line.buffer) > line.end: + if conf['type'] == 'dos': + if line.buffer[line.end - 1:line.end + 1] != '\r\n': + yield LintProblem(1, line.end - line.start + 1, + 'wrong new line character: expected \\r\\n') + else: + if line.end > 0 and line.buffer[line.end - 1] == '\r': + yield LintProblem(1, line.end - line.start, + 'wrong new line character: expected \\n') diff --git a/yamllint/rules/trailing_spaces.py b/yamllint/rules/trailing_spaces.py new file mode 100644 index 0000000..a463049 --- /dev/null +++ b/yamllint/rules/trailing_spaces.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2016 Adrien Vergé +# +# 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 . + +import string + +from yamllint.errors import LintProblem + + +ID = 'trailing-spaces' +TYPE = 'line' + + +def check(conf, line): + if line.end == 0: + return + + # YAML recognizes two white space characters: space and tab. + # http://yaml.org/spec/1.2/spec.html#id2775170 + + pos = line.end + while line.buffer[pos - 1] in string.whitespace and pos > line.start: + pos -= 1 + + if pos != line.end and line.buffer[pos] in ' \t': + yield LintProblem(line.line_no, pos - line.start + 1, + 'trailing spaces')