parochial (empty) → 0.1.0.0
raw patch · 9 files changed
+1215/−0 lines, 9 filesdep +Cabaldep +basedep +blaze-html
Dependencies added: Cabal, base, blaze-html, blaze-markup, directory, filepath, filepattern, hackage-db, hoogle, optparse-generic, parochial, posix-paths, protolude, text, unix-compat
Files
- CHANGELOG +5/−0
- LICENCE +661/−0
- README.md +151/−0
- app/Main.hs +34/−0
- parochial.cabal +84/−0
- src/Parochial/HaddockGenerator.hs +139/−0
- src/Parochial/HoogleGenerator.hs +33/−0
- src/Parochial/Options.hs +97/−0
- src/Parochial/Types.hs +11/−0
+ CHANGELOG view
@@ -0,0 +1,5 @@+parochial (0.1.0.0) stable; urgency=medium++ * Initial release.++ -- Richard Heycock <rgh@filterfish.org> Sat, 26 Dec 2020 13:59:14 +1100
+ LICENCE view
@@ -0,0 +1,661 @@+ GNU AFFERO GENERAL PUBLIC LICENSE+ Version 3, 19 November 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU 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.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU 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 <http://www.gnu.org/licenses/>.++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+<http://www.gnu.org/licenses/>.
+ README.md view
@@ -0,0 +1,151 @@+# Parochial++Parochial is a tool for managing local haddocks and hoogle databases. I work in cafes and+on the train plus I live in Australia where the internet speed is, err, somewhat+variable. The other significant benefit I found when learning Haskell (and I'm _very_+much still in that category) is knowing that I was reading the actual documentation of+the installed library. For example if I searched for a function on+[Hoogle](hoogle.haskell.org/) I wasn't sure if it was the correct function. In fact+I still find this really useful.++The whole point behind Parochial is to group the documentation on a project by project+basis. For the html documentation it simply builds a symlink farm to the installed+documentation in `$HOME/.cabal/...` (you will need to set the `-haddock` ghc option or+set it in `$HOME/.cabal.broken/config` to ensure the documentation is built) in+a directory named after the current project. For the hoogle database it does much the+same but instead of building a symlink farm it builds a hoogle database, again named+after the project.+++# Benefits++* Fast.+* Works without an internet connection.+* Per project documentation.+* Indexes *all* project libraries (including transitive dependencies). Hoogle only+ indexes [Stackage](https://www.stackage.org/) which doesn't include everything on+ [Hackage](https://hackage.haskell.org).++Of course the downside is that if you don't have the library in your cabal file you won't+have any documentation for it.+++# Limitations++This is still fairly raw and at an early stage of development but it's certainly usable+and I will be adding to it over time.++* Only works for Simple distributions.+* Only tested with nix-style local builds.+* Only works for projects that build a binary. You can work around this by specifying+ the state file with the --state command line option.+* It's tied to a specific hoogle version so if the docs in `$HOME/.cabal/...` were built+ with a different version parochial will fail with a version mismatch error.+* It's tied to a specific version of cabal. I _think_+ [cabal-helpr](https://hackage.haskell.org/package/cabal-helper) should fix this but+ I need to look into it more.+* If you want to access the hoogle database from a browser you will need to run `hoogle+ server` manually. This is probably fine if you mainly work on one project but would+ become annoying fairly quickly. The hoogle hrefs are file:///\<local/path\> which most+ browsers will refuse to render.+* I'm sure there are others as well!+++# Usage++## Building the Documentation+++```parochial --help``` displays a help message.+++If the project contains a single binary the following will work:++for haddock:++```bash+parochial haddock+```++and hoogle:+++```bash+parochial hoogle+```++If the project containes a single library then you will need to provide the `--state` option:++for haddock:++```bash+parochial haddock --state $(find . -name setup-config)+```++and hoogle:++```bash+parochial hoogle --state $(find . -name setup-config)+```++It there is more than one library you will need to build each one separately (I want to+fix this in the future):++for haddock:++```bash+find . -name setup-config | xargs -n1 parochial haddock --state+```++and hoogle:++```bash+find . -name setup-config | xargs -n1 parochial hoogle --state+```++## Reading the Documentation++### Serving up the html++I use caddy to serve up the target directory but you can choose whatever you like, it+just needs to be able to serve up some files. The following `Caddyfile` should do the job:++```+localhost:80 {+ file_server browse+}+```++Either change the port number to above 1024 or set the following capability on the `caddy`+binary. As root run:++```bash+setcap CAP_NET_BIND_SERVICE=ep $(which caddy)+```+++### Command line hoogle++You can specify the database on the command line, like so:++```bash+hoogle --database=/srv/parochial/parochial.hoo Functor+```++or write a simple wrapper script that infers the name of the database from the CWD or+some other clue.+++# TODO++* Don't hardcode `/srv/parochial` as the default place to put the documentation (this+ works for me and you can override it with the --target option but even so it's really+ me being very lazy!).+* Work out a better way of locating the `setup-config` parent directory. I basically+ recurse the dist directory searching for `setup-config` which works but is pretty+ simplistic. I would have thought `Cabal` would have a way of doing this but I can't+ find it. If anyone knows how to do this please do let me know.+* Integrate the local hoogle database and the local haddocks.+* If the project has multiple local packages merge the results so the documentation is+ in a single place for the entire project.+* Make the index page less ugly.
+ app/Main.hs view
@@ -0,0 +1,34 @@+module Main where++import Protolude+import System.IO (hSetEncoding, utf8)++import Distribution.Simple.Configure++import Options.Generic++import Parochial.HaddockGenerator+import Parochial.HoogleGenerator+import Parochial.Options+import Parochial.Types+++main :: IO ()+main = do+ hSetEncoding stdout utf8+ parseCmdOptions >>= subCmd+++-- Choose between building the Hoogle database or the Haddocks+subCmd :: Config Unwrapped -> IO ()+subCmd c = case c of+ (Haddock t p s) -> build t p s createSymLinkFarm+ (Hoogle t p s) -> build t p s buildHoogleDB+++-- Sort the options out and call the passed in function+build :: Maybe Target -> Maybe Text -> Maybe FilePath -> (Target -> [Pkg] -> IO ()) -> IO ()+build t p s f = do+ setupConfig <- getState s+ targetPath <- getAndMkTargetPath p t+ getConfigStateFile setupConfig >>= installedHaddocks >>= f targetPath
+ parochial.cabal view
@@ -0,0 +1,84 @@+cabal-version: 2.2++name: parochial+version: 0.1.0.0++synopsis: Help Manage project specific documentation+description: Parochial helps manage local documentation by creating an index of+ a project's html, it also builds a hoogle index. In both instances+ the project's transitive dependencies are included.++homepage: https://gitlab.com/filterfish/parochial+bug-reports: https://gitlab.com/filterfish/parochial/-/issues+license: AGPL-3.0-only+license-file: LICENCE++author: Richard Heycock+maintainer: rgh@filterfish.org++copyright: 2020 Richard Heycock+category: Development,Documentation++build-type: Simple+extra-source-files: README.md+ CHANGELOG++source-repository head+ type: git+ location: https://gitlab.com/filterfish/parochial++library+ hs-source-dirs: src++ default-extensions: OverloadedStrings NoImplicitPrelude LambdaCase++ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns+ -Wwarn=deprecations+ -fhide-source-paths++ build-depends: base == 4.*+ , protolude == 0.*++ -- The version of cabal must match the installed version of cabal-install.+ , Cabal == 3.*+ , hoogle == 5.*++ , blaze-html == 0.9.*+ , blaze-markup == 0.8.*+ , directory == 1.3.*+ , filepath == 1.4.*+ , hackage-db == 2.1.*+ , optparse-generic == 1.4.*+ , posix-paths == 0.2.*+ , text == 1.2.*+ , unix-compat == 0.5.*+ , filepattern == 0.1.*++ exposed-modules: Parochial.HaddockGenerator+ , Parochial.HoogleGenerator+ , Parochial.Options+ , Parochial.Types++ default-language: Haskell2010+++executable parochial+ main-is: Main.hs+ hs-source-dirs: app++ default-extensions: OverloadedStrings NoImplicitPrelude LambdaCase++ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns+ -Wwarn=deprecations+ -fhide-source-paths++ build-depends: base == 4.*+ , protolude == 0.*++ , Cabal == 3.*+ , optparse-generic == 1.4.*++ , parochial++ default-language: Haskell2010+
+ src/Parochial/HaddockGenerator.hs view
@@ -0,0 +1,139 @@+module Parochial.HaddockGenerator (+ createSymLinkFarm+ , installedHaddocks+ , installedHaddocks'+ ) where+++import Protolude hiding (packageName)++import qualified Data.List as L++import Distribution.Types.Version+import Distribution.Types.PackageId+import Distribution.Types.PackageName+import Distribution.Types.LocalBuildInfo++import Distribution.Simple.PackageIndex+import Distribution.InstalledPackageInfo++import System.FilePath+import System.Directory+import System.PosixCompat.Files++import Text.Blaze.Html.Renderer.Pretty ( renderHtml )++import Text.Blaze.Html5 ((!))+import qualified Text.Blaze.Html5 as H+import qualified Text.Blaze.Html5.Attributes as A++import Parochial.Types+++-- | Predefined list of blacklisted packages. This is dirty nasty hack because Hoogle+-- dies when it parses certain files it shouldn't, ironically it dies parsing it's+-- own package! See https://github.com/ndmitchell/hoogle/issues/362 for more details.+--+-- The downside of this approach is that it won't build the documentation for these+-- packages+blackListedPagkages :: [Text]+blackListedPagkages = ["hoogle"]+++-- | Construct a project specific symlink farm which links the installed haddocks to the+-- project and wraps it in a (very) primitive html page.+createSymLinkFarm :: Target -> [Pkg] -> IO ()+createSymLinkFarm t i = removeSymLinks t >> (generateSymLinks t i >>= createIndex t)+++-- | Builds a symlink farm from the package database so that when the documentation is served+-- up by a web server the links are correct.+generateSymLinks :: Target -> [Pkg] -> IO [Pkg]+generateSymLinks target = traverse generateSymLink+ where+ generateSymLink (pId, p) = createSymbolicLink p (path pId) >> pure (pId, p)+ path = (target </>) . toS . packageName+++-- | Remove all symlinks to ensure there are no dangling links or links pointing to the wrong+-- versions.+removeSymLinks :: Target -> IO ()+removeSymLinks path = listDirectoryAbs >>= filterM pathIsSymbolicLink >>= traverse_ removeFile+ where+ listDirectoryAbs = listDirectory path >>= traverse (pure . (path </>))+++-- | Contrive a @Pkg@ for the locally installed documentation+projectPkg :: LocalBuildInfo -> Pkg+projectPkg lbi = (projectIdentifier lbi, takeDirectory (buildDir lbi) </> "doc" </> "html" </> name </> name)+ where+ name = toS $ packageName (projectIdentifier lbi)+++-- | Extract the @PackageIdentifier@ for the project.+projectIdentifier :: LocalBuildInfo -> PackageIdentifier+projectIdentifier = localPackage+++-- | Find all project dependencies and filter out any promlematic ones. This isn't+-- particularly efficeient but given it's performing IO it won't make much difference.+installedHaddocks :: LocalBuildInfo -> IO [Pkg]+installedHaddocks = filterM hasIndexHtml . extract . filterPackages . allPackages . installedPkgs+ where+ -- FIXME mconcat not correct and needs to be done properly. I'm not sure what properly is though!+ extract :: [InstalledPackageInfo] -> [Pkg]+ extract = map (\i -> (sourcePackageId i, mconcat $ haddockHTMLs i))++ filterPackages :: [InstalledPackageInfo] -> [InstalledPackageInfo]+ filterPackages = L.filter (liftM2 (&&) isBlacklisted isNotEmpty)++ isBlacklisted :: InstalledPackageInfo -> Bool+ isBlacklisted = not . flip elem blackListedPagkages . packageName . sourcePackageId++ isNotEmpty :: InstalledPackageInfo -> Bool+ isNotEmpty = not . null . haddockHTMLs++ hasIndexHtml :: Pkg -> IO Bool+ hasIndexHtml = fileExist . indexPath . snd+++-- | The same as @installedHaddocks@ but included the project documentation.+installedHaddocks' :: LocalBuildInfo -> IO [Pkg]+installedHaddocks' i = installedHaddocks i >>= \h -> return (projectPkg i : h)+++-------------------------------------------------------+-- HTML+-------------------------------------------------------++-- | Write the project specific index.html file.+createIndex :: Target -> [Pkg] -> IO ()+createIndex t ps = withFile (indexPath t) WriteMode write+ where+ write = flip hPutStr (renderHtml generateHtml)++ generateHtml = H.docTypeHtml $ do+ H.head $ H.title (H.text $ toS t)+ H.body $ H.ul $ forM_ ps (H.li . pkgLink)++ pkgLink :: Pkg -> H.Html+ pkgLink (pId, _) = H.a ! A.href (H.toValue (indexPath (toS $ packageName pId))) $+ H.text (libName pId)+++indexPath :: FilePath -> FilePath+indexPath = (</> "index.html")+++-------------------------------------------------------+-- Utilities+-------------------------------------------------------++libName :: PackageIdentifier -> Text+libName p = packageName p <> " — " <> fmtVersion p+ where+ fmtVersion = toS . L.intercalate "." . map show . versionNumbers . pkgVersion+++packageName :: PackageIdentifier -> Text+packageName = toS . unPackageName . pkgName
+ src/Parochial/HoogleGenerator.hs view
@@ -0,0 +1,33 @@+module Parochial.HoogleGenerator (+ buildHoogleDB+ ) where+++import Protolude+import qualified Data.String as S+import qualified Hoogle as H++import System.FilePath.Posix (addExtension)++import Parochial.Types+++-- Generate the Hoogle options to be passed to @hoogle@.+-- This is a bit yucky as it uses @hoogle@ which appears to be+-- a convenience function for the command line tool. I did look at not+-- using this wrapper but it's a bit intimidating!+hoogleGenOptions :: Target -> [FilePath] -> [S.String]+hoogleGenOptions t ps = generateCommand <> locals ps+ where+ generateCommand = ["generate", "--database=" <> addExtension t "hoo"]+ locals = map ("--local=" <>)+++-- | Build the hoogle database. This extracts the paths from all the packages,+-- checks they exist and passes them to the hoogle command.+buildHoogleDB :: Target -> [Pkg] -> IO ()+buildHoogleDB t = H.hoogle . hoogleGenOptions t . extractPaths+ where+ extractPaths = map snd++
+ src/Parochial/Options.hs view
@@ -0,0 +1,97 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE StandaloneDeriving #-}+{-# LANGUAGE TypeOperators #-}+++module Parochial.Options (+ Config(..)+ , getCurrentProject+ , defaultTarget+ , getAndMkTargetPath+ , getState+ , parseCmdOptions+ ) where++import Protolude hiding (state)++import Distribution.Simple.Flag+import Distribution.Simple.Utils hiding (findFile)+import Distribution.Simple.Configure++import System.Directory+import System.FilePath++import System.FilePattern.Directory++import Options.Generic++import Parochial.Types+++data Config w+ = Haddock+ { target :: w ::: Maybe FilePath <?> "Target directory"+ , project :: w ::: Maybe Text <?> "The name of the project. Default to project name derived from $CWD"+ , state :: w ::: Maybe FilePath <?> "The state file"+ }+ | Hoogle+ { target :: w ::: Maybe FilePath <?> "Target directory"+ , project :: w ::: Maybe Text <?> "The name of the project. Default to project name derived from $CWD"+ , state :: w ::: Maybe FilePath <?> "The state file"+ }+ deriving (Generic)+++instance ParseRecord (Config Wrapped)+deriving instance Show (Config Unwrapped)+++setupConfigFile :: FilePath+setupConfigFile = "setup-config"+++defaultDistDir :: FilePath+defaultDistDir = "dist-newstyle"++getCurrentProject :: Maybe Text -> IO Text+getCurrentProject = maybe (toS . takeBaseName <$> getCurrentDirectory) pure+++-- This is me being laxy.+-- FIXME put this in home somewhere.+defaultTarget :: Maybe FilePath -> Target+defaultTarget = fromMaybe "/srv/parochial"+++getAndMkTargetPath :: Maybe Text -> Maybe FilePath -> IO Target+getAndMkTargetPath p t = getTarget >>= mkTargetPath+ where+ getTarget = (defaultTarget t </>) <$> (toS <$> getCurrentProject p)+ mkTargetPath p' = createDirectoryIfMissing True p' >> pure p'+++-- | Takes the value from either the --state option or tries to find the setup-config+-- itself.+getState :: Maybe FilePath -> IO FilePath+getState = maybe findSetupConfig pure+++-- | Try and find the setup-config file. This is *very* primative at the moment and+-- will simply search for the first path returned by **/x/**/setup-config+findSetupConfig :: IO FilePath+findSetupConfig = do+ d <- dist+ findS d >>= maybe (dieNoVerbosity ("Can't find: " <> setupConfigFile)) (pure . (d </>))++ where+ dist :: IO FilePath+ dist = findDistPref "." (Flag defaultDistDir)++ findS :: FilePath -> IO (Maybe FilePath)+ findS d = head <$> getDirectoryFiles d ["**/x/**" </> setupConfigFile]+++parseCmdOptions :: MonadIO m => m (Config Unwrapped)+parseCmdOptions = unwrapRecord "Generate project specific haddocks"
+ src/Parochial/Types.hs view
@@ -0,0 +1,11 @@+module Parochial.Types (+ Pkg+ , Target+ ) where++import Protolude+import Distribution.Types.PackageId+++type Pkg = (PackageIdentifier, FilePath)+type Target = FilePath