From a6082f5b6eb63c884b95bdbd29f40675f557a6f3 Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:07:41 -0400 Subject: [PATCH 1/6] Re-license AGPLv3 --- COPYING | 661 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 22 -- README.md | 11 +- package.yaml | 4 +- restyler.cabal | 5 +- 5 files changed, 667 insertions(+), 36 deletions(-) create mode 100644 COPYING delete mode 100644 LICENSE diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..0ad25db4b --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 1c8d2a4e0..000000000 --- a/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -“Commons Clause” License Condition v1.0 - -The Software is provided to you by the Licensor under the License, as defined -below, subject to the following condition. - -Without limiting other conditions in the License, the grant of rights under the -License will not include, and the License does not grant to you, the right to -Sell the Software. - -For purposes of the foregoing, “Sell” means practicing any or all of the rights -granted to you under the License to provide to third parties, for a fee or other -consideration (including without limitation fees for hosting or consulting/ -support services related to the Software), a product or service whose value -derives, entirely or substantially, from the functionality of the Software. Any -license notice or attribution required by the License must also include this -Commons Cause License Condition notice. - -Software: Restyled - -License: MIT (https://opensource.org/licenses/MIT) - -Licensor: Patrick Brisbin diff --git a/README.md b/README.md index da25b2d3f..a3d44b504 100644 --- a/README.md +++ b/README.md @@ -87,15 +87,8 @@ just test ## LICENSE -Restyled is source-available, [Commons Claused][cc] licensed. For a detailed -description of another project's rationale for this licensing model, one with -which I agree, see [here][level]. - -[cc]: https://commonsclause.com/ -[level]: https://web.archive.org/web/20181120030157/https://leveljournal.com/source-available-licensing +This project is licensed AGPLv3. See [COPYING](./COPYING). --- -[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE) | [CONTRIBUTING][] - -[contributing]: https://github.com/restyled-io/restyled.io/wiki/Contributing-to-Restyled +[CHANGELOG](./CHANGELOG.md) diff --git a/package.yaml b/package.yaml index 5eb146a71..e1ff6f08d 100644 --- a/package.yaml +++ b/package.yaml @@ -1,6 +1,6 @@ name: restyler -version: 0.4.3.2 -license: MIT +version: 0.5.0.0 +license: AGPL-3 language: GHC2021 diff --git a/restyler.cabal b/restyler.cabal index e84a72cfa..9b7fbb46e 100644 --- a/restyler.cabal +++ b/restyler.cabal @@ -5,9 +5,8 @@ cabal-version: 1.12 -- see: https://github.com/sol/hpack name: restyler -version: 0.4.3.2 -license: MIT -license-file: LICENSE +version: 0.5.0.0 +license: AGPL-3 build-type: Simple library From 90a9baac460a0cdd88b8325b86a42ee7680b88a5 Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:07:49 -0400 Subject: [PATCH 2/6] Configure headroom --- .headroom.yaml | 48 +++++++++++++++++++++++++++++ headroom-templates/haskell.mustache | 8 +++++ justfile | 3 ++ 3 files changed, 59 insertions(+) create mode 100644 .headroom.yaml create mode 100644 headroom-templates/haskell.mustache diff --git a/.headroom.yaml b/.headroom.yaml new file mode 100644 index 000000000..6b9b647a3 --- /dev/null +++ b/.headroom.yaml @@ -0,0 +1,48 @@ +## This is the configuration file for Headroom. +## See https://github.com/vaclavsvejcar/headroom for more details. + +## Defines with which version of Headroom this configuration is compatible. +## Headroom uses this field to detect whether your configuration doesn't need +## any manual migration steps in case that it's older than your current Headroom +## version. You don't need to touch this field unless explicitly stated in +## migration guide during upgrading Headroom to new version. +version: 0.4.3.0 + +## Defines the behaviour how to handle license headers, possible options are: +## +## - add = (default) adds license header to files with no existing header +## (same as '-a|--add-headers' command line argument) +## - drop = drops existing license header from without replacement +## (same as '-d|--drop-headers' command line argument) +## - replace = adds or replaces existing license header +## (same as '-r|--replace-headers' command line argument) +run-mode: add + +## Paths to source code files (either files or directories), +## same as '-s|--source-path=PATH' command line argument (can be used multiple +## times for more than one path). +source-paths: + - _tools/restylers/app + - _tools/restylers/src + - _tools/restylers/test + + +## If set to 'true', Headroom tries to detect whether any VCS (like GIT) is used +## for current project and if yes, it loads rules for ignored files and excludes +## all source paths that matches these rules. +exclude-ignored-paths: false + +## Paths to template files (either files or directories), +## same as '-t|--template-path=PATH' command line argument (can be used multiple +## times for more than one path). +template-paths: + - headroom-templates + +## Variables (key-value) to replace in templates, +## same as '-v|--variable="KEY=VALUE"' command line argument (can be used +## multiple times for more than one path). +variables: + author: Patrick Brisbin + email: pbrisbin@gmail.com + project: Restyler + year: 2024 diff --git a/headroom-templates/haskell.mustache b/headroom-templates/haskell.mustache new file mode 100644 index 000000000..3776b0ea1 --- /dev/null +++ b/headroom-templates/haskell.mustache @@ -0,0 +1,8 @@ +-- | +-- +-- Module : {{{ _haskell_module_name }}} +-- Copyright : (c) {{ _current_year }} {{ author }} +-- License : AGPL-3 +-- Maintainer : {{ email }} +-- Stability : experimental +-- Portability : POSIX diff --git a/justfile b/justfile index 9edca9975..4cec82f40 100644 --- a/justfile +++ b/justfile @@ -31,6 +31,9 @@ lint: watch: stack build --fast --pedantic --test --file-watch +headroom: + stack exec -- headroom run + # aws := "aws --profile restyled-ci" # doc_bucket := ` From b8c0986d348b0c4dc3192764e5906cb7b33aa93f Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:24:16 -0400 Subject: [PATCH 3/6] fixup! Configure headroom --- .headroom.yaml | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/.headroom.yaml b/.headroom.yaml index 6b9b647a3..4a50fde7f 100644 --- a/.headroom.yaml +++ b/.headroom.yaml @@ -22,10 +22,9 @@ run-mode: add ## same as '-s|--source-path=PATH' command line argument (can be used multiple ## times for more than one path). source-paths: - - _tools/restylers/app - - _tools/restylers/src - - _tools/restylers/test - + - app + - src + - test ## If set to 'true', Headroom tries to detect whether any VCS (like GIT) is used ## for current project and if yes, it loads rules for ignored files and excludes @@ -45,4 +44,9 @@ variables: author: Patrick Brisbin email: pbrisbin@gmail.com project: Restyler - year: 2024 + year: "2024" + +license-headers: + haskell: + line-comment: + prefixed-by: "^--" From f24a0aab59d91cc5045390415c674d79ba7e3117 Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:24:35 -0400 Subject: [PATCH 4/6] fixup! Configure headroom --- justfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/justfile b/justfile index 4cec82f40..d64810ff6 100644 --- a/justfile +++ b/justfile @@ -32,7 +32,8 @@ watch: stack build --fast --pedantic --test --file-watch headroom: - stack exec -- headroom run + stack exec -- headroom run -r + stack exec -- fourmolu -i app src test # aws := "aws --profile restyled-ci" From 303f4ec2c046271ef45c5948aa4f333e78fca06b Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:25:26 -0400 Subject: [PATCH 5/6] Add module headers to simple modules --- app/Main.hs | 8 ++++++++ src/Restyler/AnnotatedException.hs | 8 ++++++++ src/Restyler/App.hs | 8 ++++++++ src/Restyler/CLI.hs | 8 ++++++++ src/Restyler/Config/ChangedPaths.hs | 8 ++++++++ src/Restyler/Config/CommitTemplate.hs | 8 ++++++++ src/Restyler/Config/ExpectedKeys.hs | 8 ++++++++ src/Restyler/Config/Image.hs | 8 ++++++++ src/Restyler/Config/Include.hs | 8 ++++++++ src/Restyler/Config/Interpreter.hs | 8 ++++++++ src/Restyler/Config/RemoteFile.hs | 8 ++++++++ src/Restyler/Config/RequestReview.hs | 8 ++++++++ src/Restyler/Config/Restyler.hs | 8 ++++++++ src/Restyler/Config/SketchyList.hs | 8 ++++++++ src/Restyler/Config/Statuses.hs | 8 ++++++++ src/Restyler/Delimited.hs | 8 ++++++++ src/Restyler/GitHub/PullRequest.hs | 8 ++++++++ src/Restyler/Ignore.hs | 8 ++++++++ src/Restyler/Local/App.hs | 8 ++++++++ src/Restyler/Local/Options.hs | 8 ++++++++ src/Restyler/Monad/Directory.hs | 8 ++++++++ src/Restyler/Monad/Docker.hs | 8 ++++++++ src/Restyler/Monad/DownloadFile.hs | 8 ++++++++ src/Restyler/Monad/Git.hs | 8 ++++++++ src/Restyler/Monad/ReadFile.hs | 8 ++++++++ src/Restyler/Monad/WriteFile.hs | 8 ++++++++ src/Restyler/Opt.hs | 8 ++++++++ src/Restyler/Options/DryRun.hs | 8 ++++++++ src/Restyler/Options/FailOnDifferences.hs | 8 ++++++++ src/Restyler/Options/HostDirectory.hs | 8 ++++++++ src/Restyler/Options/ImageCleanup.hs | 8 ++++++++ src/Restyler/Options/LogSettings.hs | 8 ++++++++ src/Restyler/Options/Manifest.hs | 8 ++++++++ src/Restyler/Options/NoCommit.hs | 8 ++++++++ src/Restyler/Options/NoPull.hs | 8 ++++++++ src/Restyler/Options/Repository.hs | 8 ++++++++ src/Restyler/Prelude.hs | 8 ++++++++ src/Restyler/ReadP.hs | 8 ++++++++ src/Restyler/Restrictions.hs | 8 ++++++++ src/Restyler/RestyleResult.hs | 8 ++++++++ src/Restyler/Restyler.hs | 8 ++++++++ src/Restyler/Restyler/Run.hs | 8 ++++++++ src/Restyler/RestylerResult.hs | 8 ++++++++ src/Restyler/Wiki.hs | 8 ++++++++ src/Restyler/Yaml/Errata.hs | 8 ++++++++ test/Restyler/Config/CommitTemplateSpec.hs | 8 ++++++++ test/Restyler/Config/ExpectedKeysSpec.hs | 8 ++++++++ test/Restyler/Config/IncludeSpec.hs | 8 ++++++++ test/Restyler/Config/InterpreterSpec.hs | 8 ++++++++ test/Restyler/ConfigSpec.hs | 8 ++++++++ test/Restyler/DelimitedSpec.hs | 8 ++++++++ test/Restyler/IgnoreSpec.hs | 8 ++++++++ test/Restyler/RestrictionsSpec.hs | 8 ++++++++ test/Restyler/Restyler/RunSpec.hs | 8 ++++++++ test/Restyler/RestylerSpec.hs | 8 ++++++++ test/Restyler/WikiSpec.hs | 8 ++++++++ test/Restyler/Yaml/ErrataSpec.hs | 8 ++++++++ test/Spec.hs | 9 +++++++++ test/SpecHelper.hs | 8 ++++++++ 59 files changed, 473 insertions(+) diff --git a/app/Main.hs b/app/Main.hs index 36baa7fe7..3db16cbf9 100644 --- a/app/Main.hs +++ b/app/Main.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Main +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Main ( main ) where diff --git a/src/Restyler/AnnotatedException.hs b/src/Restyler/AnnotatedException.hs index 8662b7f2e..658702f05 100644 --- a/src/Restyler/AnnotatedException.hs +++ b/src/Restyler/AnnotatedException.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.AnnotatedException +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.AnnotatedException ( checkpointCallStack , AnnotatedException (..) diff --git a/src/Restyler/App.hs b/src/Restyler/App.hs index 747db84db..9b364e855 100644 --- a/src/Restyler/App.hs +++ b/src/Restyler/App.hs @@ -1,5 +1,13 @@ {-# LANGUAGE DerivingVia #-} +-- | +-- +-- Module : Restyler.App +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.App ( AppT , runAppT diff --git a/src/Restyler/CLI.hs b/src/Restyler/CLI.hs index 60e69b048..bfe21212b 100644 --- a/src/Restyler/CLI.hs +++ b/src/Restyler/CLI.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.CLI +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.CLI ( main ) where diff --git a/src/Restyler/Config/ChangedPaths.hs b/src/Restyler/Config/ChangedPaths.hs index ff2e0ca06..9b55ce0b4 100644 --- a/src/Restyler/Config/ChangedPaths.hs +++ b/src/Restyler/Config/ChangedPaths.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.ChangedPaths +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.ChangedPaths ( ChangedPathsConfig (..) , MaximumChangedPathsOutcome (..) diff --git a/src/Restyler/Config/CommitTemplate.hs b/src/Restyler/Config/CommitTemplate.hs index 8e31db1ec..a690adddc 100644 --- a/src/Restyler/Config/CommitTemplate.hs +++ b/src/Restyler/Config/CommitTemplate.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.CommitTemplate +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.CommitTemplate ( CommitTemplate (..) , CommitTemplateInputs (..) diff --git a/src/Restyler/Config/ExpectedKeys.hs b/src/Restyler/Config/ExpectedKeys.hs index 35666e46e..f18f86f4b 100644 --- a/src/Restyler/Config/ExpectedKeys.hs +++ b/src/Restyler/Config/ExpectedKeys.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.ExpectedKeys +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.ExpectedKeys ( genericParseJSONValidated , validateObjectKeys diff --git a/src/Restyler/Config/Image.hs b/src/Restyler/Config/Image.hs index f6d4c4a0e..e567cfaf3 100644 --- a/src/Restyler/Config/Image.hs +++ b/src/Restyler/Config/Image.hs @@ -1,6 +1,14 @@ {-# LANGUAGE DerivingVia #-} {-# LANGUAGE RecordWildCards #-} +-- | +-- +-- Module : Restyler.Config.Image +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Image ( Image , overrideRestylerImage diff --git a/src/Restyler/Config/Include.hs b/src/Restyler/Config/Include.hs index d6153c494..cdf6cee1f 100644 --- a/src/Restyler/Config/Include.hs +++ b/src/Restyler/Config/Include.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.Include +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Include ( Include (..) , explicit diff --git a/src/Restyler/Config/Interpreter.hs b/src/Restyler/Config/Interpreter.hs index e9bb6b832..dfb6119c1 100644 --- a/src/Restyler/Config/Interpreter.hs +++ b/src/Restyler/Config/Interpreter.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.Interpreter +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Interpreter ( Interpreter (..) , readInterpreter diff --git a/src/Restyler/Config/RemoteFile.hs b/src/Restyler/Config/RemoteFile.hs index 875fe4496..a505f6bfc 100644 --- a/src/Restyler/Config/RemoteFile.hs +++ b/src/Restyler/Config/RemoteFile.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.RemoteFile +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.RemoteFile ( RemoteFile (..) ) where diff --git a/src/Restyler/Config/RequestReview.hs b/src/Restyler/Config/RequestReview.hs index 704bc2421..1566d65db 100644 --- a/src/Restyler/Config/RequestReview.hs +++ b/src/Restyler/Config/RequestReview.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.RequestReview +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.RequestReview ( RequestReviewConfig ) where diff --git a/src/Restyler/Config/Restyler.hs b/src/Restyler/Config/Restyler.hs index 3b52f31a1..bfc2fbaae 100644 --- a/src/Restyler/Config/Restyler.hs +++ b/src/Restyler/Config/Restyler.hs @@ -1,6 +1,14 @@ {-# LANGUAGE FieldSelectors #-} {-# LANGUAGE RecordWildCards #-} +-- | +-- +-- Module : Restyler.Config.Restyler +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Restyler ( RestylerOverride , overrideRestylers diff --git a/src/Restyler/Config/SketchyList.hs b/src/Restyler/Config/SketchyList.hs index d76a6defa..eefebaedd 100644 --- a/src/Restyler/Config/SketchyList.hs +++ b/src/Restyler/Config/SketchyList.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.SketchyList +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.SketchyList ( SketchyList , unSketchy diff --git a/src/Restyler/Config/Statuses.hs b/src/Restyler/Config/Statuses.hs index decd68ad5..3471c760a 100644 --- a/src/Restyler/Config/Statuses.hs +++ b/src/Restyler/Config/Statuses.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.Statuses +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Statuses ( Statuses (..) ) where diff --git a/src/Restyler/Delimited.hs b/src/Restyler/Delimited.hs index d5670c3d1..cb7c76af3 100644 --- a/src/Restyler/Delimited.hs +++ b/src/Restyler/Delimited.hs @@ -1,6 +1,14 @@ {-# LANGUAGE FieldSelectors #-} {-# LANGUAGE RecordWildCards #-} +-- | +-- +-- Module : Restyler.Delimited +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Delimited ( Delimiters (..) , restyleDelimited diff --git a/src/Restyler/GitHub/PullRequest.hs b/src/Restyler/GitHub/PullRequest.hs index 3bd8830fb..d21c9142a 100644 --- a/src/Restyler/GitHub/PullRequest.hs +++ b/src/Restyler/GitHub/PullRequest.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.GitHub.PullRequest +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.GitHub.PullRequest ( PullRequest , HasPullRequestState (..) diff --git a/src/Restyler/Ignore.hs b/src/Restyler/Ignore.hs index 0e08d27c4..19ae0eaf9 100644 --- a/src/Restyler/Ignore.hs +++ b/src/Restyler/Ignore.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Ignore +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Ignore ( IgnoredReason (..) , getIgnoredReason diff --git a/src/Restyler/Local/App.hs b/src/Restyler/Local/App.hs index 421c212f6..8ecba1129 100644 --- a/src/Restyler/Local/App.hs +++ b/src/Restyler/Local/App.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Local.App +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Local.App ( App (..) , withApp diff --git a/src/Restyler/Local/Options.hs b/src/Restyler/Local/Options.hs index 1efb08b37..bc92068dc 100644 --- a/src/Restyler/Local/Options.hs +++ b/src/Restyler/Local/Options.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Local.Options +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Local.Options ( Options (..) , envParser diff --git a/src/Restyler/Monad/Directory.hs b/src/Restyler/Monad/Directory.hs index fd2a8195c..ea360e5e7 100644 --- a/src/Restyler/Monad/Directory.hs +++ b/src/Restyler/Monad/Directory.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Monad.Directory +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.Directory ( MonadDirectory (..) , Permissions (..) diff --git a/src/Restyler/Monad/Docker.hs b/src/Restyler/Monad/Docker.hs index a5e1517e6..bd84ba273 100644 --- a/src/Restyler/Monad/Docker.hs +++ b/src/Restyler/Monad/Docker.hs @@ -1,5 +1,13 @@ {-# LANGUAGE UndecidableInstances #-} +-- | +-- +-- Module : Restyler.Monad.Docker +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.Docker ( MonadDocker (..) diff --git a/src/Restyler/Monad/DownloadFile.hs b/src/Restyler/Monad/DownloadFile.hs index 1e7f219a6..10d746a0e 100644 --- a/src/Restyler/Monad/DownloadFile.hs +++ b/src/Restyler/Monad/DownloadFile.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Monad.DownloadFile +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.DownloadFile ( MonadDownloadFile (..) diff --git a/src/Restyler/Monad/Git.hs b/src/Restyler/Monad/Git.hs index 0d8b3e62d..54b43a7a6 100644 --- a/src/Restyler/Monad/Git.hs +++ b/src/Restyler/Monad/Git.hs @@ -1,5 +1,13 @@ {-# LANGUAGE UndecidableInstances #-} +-- | +-- +-- Module : Restyler.Monad.Git +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.Git ( MonadGit (..) diff --git a/src/Restyler/Monad/ReadFile.hs b/src/Restyler/Monad/ReadFile.hs index ad61fbe40..a8f51636b 100644 --- a/src/Restyler/Monad/ReadFile.hs +++ b/src/Restyler/Monad/ReadFile.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Monad.ReadFile +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.ReadFile ( MonadReadFile (..) diff --git a/src/Restyler/Monad/WriteFile.hs b/src/Restyler/Monad/WriteFile.hs index 0902d4827..052ec805d 100644 --- a/src/Restyler/Monad/WriteFile.hs +++ b/src/Restyler/Monad/WriteFile.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Monad.WriteFile +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Monad.WriteFile ( MonadWriteFile (..) diff --git a/src/Restyler/Opt.hs b/src/Restyler/Opt.hs index 1b88d6169..0d8b95e35 100644 --- a/src/Restyler/Opt.hs +++ b/src/Restyler/Opt.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Opt +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Opt ( parse , module Options.Applicative diff --git a/src/Restyler/Options/DryRun.hs b/src/Restyler/Options/DryRun.hs index 566b06a07..30b63e87b 100644 --- a/src/Restyler/Options/DryRun.hs +++ b/src/Restyler/Options/DryRun.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.DryRun +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.DryRun ( DryRunOption (..) , HasDryRunOption (..) diff --git a/src/Restyler/Options/FailOnDifferences.hs b/src/Restyler/Options/FailOnDifferences.hs index aec83d5ee..20475a440 100644 --- a/src/Restyler/Options/FailOnDifferences.hs +++ b/src/Restyler/Options/FailOnDifferences.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.FailOnDifferences +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.FailOnDifferences ( FailOnDifferencesOption (..) , HasFailOnDifferencesOption (..) diff --git a/src/Restyler/Options/HostDirectory.hs b/src/Restyler/Options/HostDirectory.hs index 5d55a3439..d9bfd162c 100644 --- a/src/Restyler/Options/HostDirectory.hs +++ b/src/Restyler/Options/HostDirectory.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.HostDirectory +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.HostDirectory ( HostDirectoryOption (..) , HasHostDirectoryOption (..) diff --git a/src/Restyler/Options/ImageCleanup.hs b/src/Restyler/Options/ImageCleanup.hs index 5022a352c..c3bfd3d09 100644 --- a/src/Restyler/Options/ImageCleanup.hs +++ b/src/Restyler/Options/ImageCleanup.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.ImageCleanup +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.ImageCleanup ( ImageCleanupOption (..) , HasImageCleanupOption (..) diff --git a/src/Restyler/Options/LogSettings.hs b/src/Restyler/Options/LogSettings.hs index 940b5cfbe..e218985e4 100644 --- a/src/Restyler/Options/LogSettings.hs +++ b/src/Restyler/Options/LogSettings.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.LogSettings +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.LogSettings ( LogSettingsOption (..) , resolveLogSettings diff --git a/src/Restyler/Options/Manifest.hs b/src/Restyler/Options/Manifest.hs index e4de4703e..643035847 100644 --- a/src/Restyler/Options/Manifest.hs +++ b/src/Restyler/Options/Manifest.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.Manifest +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.Manifest ( ManifestOption (..) , HasManifestOption (..) diff --git a/src/Restyler/Options/NoCommit.hs b/src/Restyler/Options/NoCommit.hs index 404dfa497..b26ba9886 100644 --- a/src/Restyler/Options/NoCommit.hs +++ b/src/Restyler/Options/NoCommit.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.NoCommit +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.NoCommit ( NoCommitOption (..) , HasNoCommitOption (..) diff --git a/src/Restyler/Options/NoPull.hs b/src/Restyler/Options/NoPull.hs index 5808cbaf2..22f6a439e 100644 --- a/src/Restyler/Options/NoPull.hs +++ b/src/Restyler/Options/NoPull.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.NoPull +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.NoPull ( NoPullOption (..) , HasNoPullOption (..) diff --git a/src/Restyler/Options/Repository.hs b/src/Restyler/Options/Repository.hs index 2044bda3b..90a302934 100644 --- a/src/Restyler/Options/Repository.hs +++ b/src/Restyler/Options/Repository.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Options.Repository +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Options.Repository ( RepositoryOption (..) ) where diff --git a/src/Restyler/Prelude.hs b/src/Restyler/Prelude.hs index 2e18faa33..b862547ec 100644 --- a/src/Restyler/Prelude.hs +++ b/src/Restyler/Prelude.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Prelude +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Prelude ( module X , module Restyler.Prelude diff --git a/src/Restyler/ReadP.hs b/src/Restyler/ReadP.hs index a46105229..f85883500 100644 --- a/src/Restyler/ReadP.hs +++ b/src/Restyler/ReadP.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.ReadP +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.ReadP ( parseReadP , module Text.ParserCombinators.ReadP diff --git a/src/Restyler/Restrictions.hs b/src/Restyler/Restrictions.hs index 4b6db6e15..b0a397fa1 100644 --- a/src/Restyler/Restrictions.hs +++ b/src/Restyler/Restrictions.hs @@ -1,6 +1,14 @@ {-# LANGUAGE DerivingVia #-} {-# LANGUAGE RecordWildCards #-} +-- | +-- +-- Module : Restyler.Restrictions +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Restrictions ( HasRestrictions (..) , Restrictions (..) diff --git a/src/Restyler/RestyleResult.hs b/src/Restyler/RestyleResult.hs index f10539fb2..8724e6ff3 100644 --- a/src/Restyler/RestyleResult.hs +++ b/src/Restyler/RestyleResult.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.RestyleResult +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.RestyleResult ( RestyleResult (..) , RestyleSkipped (..) diff --git a/src/Restyler/Restyler.hs b/src/Restyler/Restyler.hs index 860e8a633..6342ae313 100644 --- a/src/Restyler/Restyler.hs +++ b/src/Restyler/Restyler.hs @@ -1,5 +1,13 @@ {-# LANGUAGE FieldSelectors #-} +-- | +-- +-- Module : Restyler.Restyler +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Restyler ( Restyler (..) , RestylerRunStyle (..) diff --git a/src/Restyler/Restyler/Run.hs b/src/Restyler/Restyler/Run.hs index 2390f4192..4dc6ac332 100644 --- a/src/Restyler/Restyler/Run.hs +++ b/src/Restyler/Restyler/Run.hs @@ -1,6 +1,14 @@ {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TupleSections #-} +-- | +-- +-- Module : Restyler.Restyler.Run +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Restyler.Run ( runRestylers diff --git a/src/Restyler/RestylerResult.hs b/src/Restyler/RestylerResult.hs index d3a63e5ad..d752bd8aa 100644 --- a/src/Restyler/RestylerResult.hs +++ b/src/Restyler/RestylerResult.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.RestylerResult +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.RestylerResult ( RestylerResult (..) , getRestylerResult diff --git a/src/Restyler/Wiki.hs b/src/Restyler/Wiki.hs index 4e1907ac7..b52b08ab3 100644 --- a/src/Restyler/Wiki.hs +++ b/src/Restyler/Wiki.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Wiki +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Wiki ( commonError , page diff --git a/src/Restyler/Yaml/Errata.hs b/src/Restyler/Yaml/Errata.hs index 2023d395f..de3caf18f 100644 --- a/src/Restyler/Yaml/Errata.hs +++ b/src/Restyler/Yaml/Errata.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Yaml.Errata +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Yaml.Errata ( formatInvalidYaml ) where diff --git a/test/Restyler/Config/CommitTemplateSpec.hs b/test/Restyler/Config/CommitTemplateSpec.hs index 9736b3662..b377aa62f 100644 --- a/test/Restyler/Config/CommitTemplateSpec.hs +++ b/test/Restyler/Config/CommitTemplateSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.CommitTemplateSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.CommitTemplateSpec ( spec ) diff --git a/test/Restyler/Config/ExpectedKeysSpec.hs b/test/Restyler/Config/ExpectedKeysSpec.hs index 477dd7ae8..f668923dc 100644 --- a/test/Restyler/Config/ExpectedKeysSpec.hs +++ b/test/Restyler/Config/ExpectedKeysSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.ExpectedKeysSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.ExpectedKeysSpec ( spec ) where diff --git a/test/Restyler/Config/IncludeSpec.hs b/test/Restyler/Config/IncludeSpec.hs index 14af3df08..889ed118a 100644 --- a/test/Restyler/Config/IncludeSpec.hs +++ b/test/Restyler/Config/IncludeSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.IncludeSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.IncludeSpec ( spec ) diff --git a/test/Restyler/Config/InterpreterSpec.hs b/test/Restyler/Config/InterpreterSpec.hs index 1e956ede5..b59e63bcb 100644 --- a/test/Restyler/Config/InterpreterSpec.hs +++ b/test/Restyler/Config/InterpreterSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Config.InterpreterSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.InterpreterSpec ( spec ) diff --git a/test/Restyler/ConfigSpec.hs b/test/Restyler/ConfigSpec.hs index 77c2a8dc4..512d4d00d 100644 --- a/test/Restyler/ConfigSpec.hs +++ b/test/Restyler/ConfigSpec.hs @@ -1,5 +1,13 @@ {-# LANGUAGE QuasiQuotes #-} +-- | +-- +-- Module : Restyler.ConfigSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.ConfigSpec ( spec ) where diff --git a/test/Restyler/DelimitedSpec.hs b/test/Restyler/DelimitedSpec.hs index 7b560827d..5268e1faa 100644 --- a/test/Restyler/DelimitedSpec.hs +++ b/test/Restyler/DelimitedSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.DelimitedSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.DelimitedSpec ( spec ) where diff --git a/test/Restyler/IgnoreSpec.hs b/test/Restyler/IgnoreSpec.hs index b10d96e72..31fc5e70b 100644 --- a/test/Restyler/IgnoreSpec.hs +++ b/test/Restyler/IgnoreSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.IgnoreSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.IgnoreSpec ( spec ) where diff --git a/test/Restyler/RestrictionsSpec.hs b/test/Restyler/RestrictionsSpec.hs index 6ebc2fa8c..122ed9e07 100644 --- a/test/Restyler/RestrictionsSpec.hs +++ b/test/Restyler/RestrictionsSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.RestrictionsSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.RestrictionsSpec ( spec ) where diff --git a/test/Restyler/Restyler/RunSpec.hs b/test/Restyler/Restyler/RunSpec.hs index 3b20fc475..a072a503e 100644 --- a/test/Restyler/Restyler/RunSpec.hs +++ b/test/Restyler/Restyler/RunSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.Restyler.RunSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Restyler.RunSpec ( spec ) where diff --git a/test/Restyler/RestylerSpec.hs b/test/Restyler/RestylerSpec.hs index c4757c211..6f8886999 100644 --- a/test/Restyler/RestylerSpec.hs +++ b/test/Restyler/RestylerSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.RestylerSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.RestylerSpec ( spec ) diff --git a/test/Restyler/WikiSpec.hs b/test/Restyler/WikiSpec.hs index 01f018bef..db7391cf1 100644 --- a/test/Restyler/WikiSpec.hs +++ b/test/Restyler/WikiSpec.hs @@ -1,3 +1,11 @@ +-- | +-- +-- Module : Restyler.WikiSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.WikiSpec ( spec ) where diff --git a/test/Restyler/Yaml/ErrataSpec.hs b/test/Restyler/Yaml/ErrataSpec.hs index 00d76247c..1aefd9d8c 100644 --- a/test/Restyler/Yaml/ErrataSpec.hs +++ b/test/Restyler/Yaml/ErrataSpec.hs @@ -1,5 +1,13 @@ {-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-} +-- | +-- +-- Module : Restyler.Yaml.ErrataSpec +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Yaml.ErrataSpec ( spec ) where diff --git a/test/Spec.hs b/test/Spec.hs index 7a1ea192c..393af8739 100644 --- a/test/Spec.hs +++ b/test/Spec.hs @@ -1,2 +1,11 @@ {-# OPTIONS_GHC -F -pgmF hspec-discover #-} {-# OPTIONS_GHC -Wno-missing-export-lists #-} + +-- | +-- +-- Module : !!! INSERT HASKELL MODULE NAME !!! +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX diff --git a/test/SpecHelper.hs b/test/SpecHelper.hs index 853ae9f0a..a5bac1fec 100644 --- a/test/SpecHelper.hs +++ b/test/SpecHelper.hs @@ -1,5 +1,13 @@ {-# LANGUAGE FieldSelectors #-} +-- | +-- +-- Module : SpecHelper +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module SpecHelper ( someRestyler From 2dbced1905282298b28c25e036d320e45db44616 Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Fri, 9 Aug 2024 11:35:59 -0400 Subject: [PATCH 6/6] Add module headers to modules with docs --- src/GHC/Generics/Selectors.hs | 7 +++++++ src/Restyler/Config.hs | 7 +++++++ src/Restyler/Config/Glob.hs | 7 +++++++ src/Restyler/Local.hs | 7 +++++++ test/Restyler/Test/FS.hs | 7 +++++++ 5 files changed, 35 insertions(+) diff --git a/src/GHC/Generics/Selectors.hs b/src/GHC/Generics/Selectors.hs index 8e4f50458..f0d02e14c 100644 --- a/src/GHC/Generics/Selectors.hs +++ b/src/GHC/Generics/Selectors.hs @@ -5,6 +5,13 @@ -- | Function for getting the names of fields in a type -- -- +-- +-- Module : GHC.Generics.Selectors +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module GHC.Generics.Selectors ( Selectors (..) ) where diff --git a/src/Restyler/Config.hs b/src/Restyler/Config.hs index 36d77532e..30f98b1d0 100644 --- a/src/Restyler/Config.hs +++ b/src/Restyler/Config.hs @@ -18,6 +18,13 @@ -- - -- - -- - +-- +-- Module : Restyler.Config +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config ( Config (..) , ConfigError (..) diff --git a/src/Restyler/Config/Glob.hs b/src/Restyler/Config/Glob.hs index c87674b3e..7dc192614 100644 --- a/src/Restyler/Config/Glob.hs +++ b/src/Restyler/Config/Glob.hs @@ -1,6 +1,13 @@ {-# LANGUAGE AllowAmbiguousTypes #-} -- | Small wrapper over @'System.FilePath.Glob.Pattern'@ +-- +-- Module : Restyler.Config.Glob +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Config.Glob ( Glob (..) , GlobTarget (..) diff --git a/src/Restyler/Local.hs b/src/Restyler/Local.hs index 187c1605c..6f06713a2 100644 --- a/src/Restyler/Local.hs +++ b/src/Restyler/Local.hs @@ -1,4 +1,11 @@ -- | @restyle PATH [PATH...]@ +-- +-- Module : Restyler.Local +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Local ( NullPullRequest (..) , run diff --git a/test/Restyler/Test/FS.hs b/test/Restyler/Test/FS.hs index 1fa32e8fe..08b291421 100644 --- a/test/Restyler/Test/FS.hs +++ b/test/Restyler/Test/FS.hs @@ -12,6 +12,13 @@ -- common prefix shared by multiple files. An empty directory can be created -- by creating a file ending in @/@. Therefore, reading and writing to a -- \"directory\" could behave in surprising ways. +-- +-- Module : Restyler.Test.FS +-- Copyright : (c) 2024 Patrick Brisbin +-- License : AGPL-3 +-- Maintainer : pbrisbin@gmail.com +-- Stability : experimental +-- Portability : POSIX module Restyler.Test.FS ( FS , build