diff --git a/LICENSE b/LICENSE index 6904e08..c6f01c6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,660 @@ -MIT License - -Copyright (c) 2022 Gobstones - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +# 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/sections/architecture/architecture.md b/sections/architecture/architecture.md index 676fbe2..e73613c 100644 --- a/sections/architecture/architecture.md +++ b/sections/architecture/architecture.md @@ -47,11 +47,33 @@ We are currently working in redesigning some of the modules into new grouping. E ## Repositories configuration -_< TO BE DONE: Discuss gobstones-script >_ +The [`gobstones-scripts`](https://github.com/gobstones/gobstones-scripts) module is used to create other modules for the [GobstonesWeb2] platform, and to abstract away configuration details in all the projects. + +The module can be used as a command line program that allows to create new modules, through the subcommands `create` or `init`. It provides several template for projects, such as creating simple libraries, command line applications and libraries, react components, and simple web components. + +The project's created have tools such as `typescript`, `rollup`, `nps`, `jest`, `typedoc` and others a development dependencies. In that sense, the modules created do not have dependencies for all those tools, having a dev-dependency only on `gobstones-scripts`, which in itself have dependencies on the tools. In that sense the module assumes a flat `node-modules` organization. + +Some configuration files needed by the tooling, such as `tsconfig.js` or `rollup.config.js`, are abstracted away by the `gobstones-script` module, which holds the configuration files. These configuration files have a default version, but, in case some module requires a particular configuration, these configuration files can be overwritten in the projects, by the subcommand `eject`. + +Other configuration files for some tooling, such as `.prettierc` used by `prettier`, or `.eslintrc` used by `ESLint`, are automatically created in the root of the created projects. Those files may require some sort of update as versions of the tooling are updated, or changed, and a such, the subcommand `update` allows for updating such files. + +Finally, the tool allows to run different actions defined through `nps`, by running the `run` subcommand. + +You can read more about the tool, configuration files, and tooling in the [Technologies we use](/../technologies/technologies.md) section. ## Basic functionalities -_< TO BE DONE: Discuss gobstones-core >_ +Another useful project is [`gobstones-core`](https://github.com/gobstones/gobstones-core), that provides some basic utilities used through different projects. + +The project includes things such as the idea for `Event`'s that have typechecking, for throwing events that objects can subscribe to; some particular data structures or types, such as `BiMap` or `Subset`. + +Another utility provided is the `Expectations` module, that allows for setting up expectations to validate user inputs and other stuff. + +The `SourceReader` module provides a class that allows to provide source files and process them as a stream, reading one or more character at a time. This is useful for tokenizing inputs. + +This module is required by default in projects created by `gobstones-scripts`, and is required by most projects in used in [GobstonesWeb2]. + +You can read more about the things the module exports in the [`gobstones-core's README`](https://github.com/gobstones/gobstones-core). [Back to Introduction](../introduction.md). diff --git a/sections/technologies/technologies.md b/sections/technologies/technologies.md index e9fba8b..cb71d66 100644 --- a/sections/technologies/technologies.md +++ b/sections/technologies/technologies.md @@ -1,178 +1,492 @@ # Technologies used in **GobstonesWeb2** -**GobstonesWeb2** is based on `Node.js`, and `Typescript`, and several technologies associated with those. +**GobstonesWeb2** is based on several technologies. Knowledge on some of these technologies, such as the programming language `TypeScript`, `Node.js` or `git` is mandatory, if you want to contribute to the project with code. For others you may find configuration files at the root of the project, or automatically performed actions, and although a deep knowledge on such tools is not required in order to contribute, being at least aware of the technologies in use is a must. -## The basics +Most of these technologies and their configuration are totally or partially abstracted away through the [`gobstones-scripts`](https://github.com/gobstones/gobstones-scripts) module. You should read and understand how that module hides the configuration for some tools, allowing you to overriding the default in each project by **ejecting** the configuration files, as well as how it provides default configuration files that must be in the root of each project, but that are not meant to be modified, as we expect they are only changed through the tool by **updating** the files as a tool's action. - - - +If you need help configuring the development environment, you may read the [Installation tutorial](./installation-tutorial.md). + +----------------------------------------------------- + +## Language and basic environment setup + +These technologies are a must if you want to contribute with code in any way or are required to understand the code. + +----------------------------------------------------- + + + + + +### Typescript + +We use `TypeScript` as the default language for most of the development of new packages. + +
+Expand to view more about TypeScript. + +`TypeScript` is a programming language based on `JavaScript`, with the addition of types, thus providing a type error detection mechanism. + +A good starting point to know the basics on `Typescript` is [`typescriptlang.org`](https://www.typescriptlang.org/docs/). + +`TypeScript` code compiles to `JavaScript` (in a process known as transpilation), and the code produced is then run through `Node.js` (i.e. if it runs on the server or as a CLI application) or in a Web Browser (i.e. such as libraries, web libraries or react-libraries). So you need to understand the underlying way in which `JavaScript` programs execute and it's API. + +You may read [`developer.mozilla.org`](https://developer.mozilla.org/es/docs/Web/JavaScript) to know more on `JavaScript`. + +To transpile `TypeScript` code you will need the **TypeScript compiler** and then you will require an environment to run the produced `JavaScript` code, which may be the browser, `Node.js` or other. + +Note that you may not need to install anything, as all the typescript configuration is handled by the configuration provided through the `gobstones-script` configuration and the project itself. + +Usually projects using `TypeScript` expect a configuration file for instructing the compiler how to produce the output, usually named as `tsconfig.json` and put at the root of the project. You will not find this file at most of the project, as the configuration is held and maintained internally by the `gobstones-script` library. Some projects may have the file, if they require a particular configuration that is different from the default, thus overriding the one in `gobstones-scripts`. +
+ + + + + +----------------------------------------------------- + + + + ### Node.js -In order to contribute to the development, you need to have `Node.js` and some package manager installed in your system, and understand how to use it with a given repository. + +We use `Node.js` to run code locally and the tooling. +
Expand to view more about Node.js. - + +`Node.js` is a `JavaScript` engine, that is, it allows you to run `JavaScript` code. We use `Node.js` to run the transpiled code produced by the `TypeScript` compiler. + +Not only that, but mot of the tooling (such as the TypeScript compiler itself) is provided as `JavaScript` modules, that require `Node.js` or a compatible platform to run. In that sense, `Node.js` is additionally needed. So `Node.js` is needed for running tests, generating documentation, compiling the code, and so on. + +Finally, all server side applications run using `Node.js` as the base server. + +You **MUST** have the latest version installed in your system in order to code. + +You will find that each project have it's own `package.json` file, that will be used by `Node.js` and other tools. Most of the contributions should not touch such file. + If you want to know more on `Node.js` there are a lot of good books and tutorials on it. A good starting point to know the basics on `Node.js` is [`nodejs.org`](https://nodejs.org/en/about/).
---- + + + + +----------------------------------------------------- - - - + + + ### Packet Manager: `npm` -Associated with `Node.js` you will be using some package manager, to help you download, install, and administer all the packages needed for effective development. -The most common package managers is `npm` (Node Package Manager), installed together with `Node.js`, but there are others. + +The `npm` package manager is used for managing dependencies and publishing libraries. +
Expand to view more about npm. -A good starting point to know the basics on `npm` is [`npmjs.com`](https://docs.npmjs.com/about-npm). -
+`npm` is installed on your system when you install `Node.js` and it's a fundamental part of the tooling when developing in `TypeScript` or `JavaScript`. ---- +Although `npm` is the default package manager, others may be use, such as `yarn`. Nonetheless, the project's architecture assumes a **flat hierarchy `node-modules`**. We recommend sticking with `npm` as it's the officially supported package manager. - - - +`npm` is used to manage dependencies that the project needs for running, as well as the ones needed to build or test the project. Also, `npm` and the default `npm registry` are used to publish the packages. -### Typescript -Finally, we use `Typescript` for most of the development of new packages. -
-Expand to view more about TypeScript. +You **MUST** have the latest version installed in your system in order to code. -`Typescript` is a programming language based on `Javascript`, with the addition of types, thus -providing a type error detection mechanism. -A good starting point to know the basics on `Typescript` is [`typescriptlang.org`](https://www.typescriptlang.org/docs/). +You may find files such as `.npmrc` and `.npmignore` in the root of most projects. The files are ment to be updated only by `gobstones-scripts`. + +You may need to understand how to work with `npm`. A good starting point to know the basics on `npm` is [`npmjs.com`](https://docs.npmjs.com/about-npm).
---- + + + - - - +----------------------------------------------------- + + + + ### Visual Studio Code -One important addition for helping on the development is the IDE (Integrated Development Environment). -Again, there are several ones, but many of us use **Visual Studio Code** (`VSCode`). + +We use **Visual Studio Code** (`VSCode`) as the default IDE. +
Expand to view more about Visual Studio Code +One important addition for helping on the development is the IDE (Integrated Development Environment). There are many good ones, but we mostly make use of `VSCode`. + +Most projects include a `.vscode` folder that, once a project is open in the IDE, some extensions and configurations are recommended by the environment. + +You **MAY** choose to use any IDE of your choice, as long as the IDE, but we recommend sticking with IDEs that integrate with `Prettier` or at least understand the configuration provided through `EditorConfig`. If on doubt, we recommend you stick with `VSCode`. + A good starting point to know the basics on `VSCode` is [`code.visualstudio.com`](https://code.visualstudio.com/docs).
---- + + + + +----------------------------------------------------- + + + + + +### git and GitHub + +We use *git** as the code's VCS and GitHub as server and platform. + +
+Expand to view more about git + +A VCS (Version Control System) allows for code history tracking and management, as well as simplifying code sharing, publishing and others. We use `git`, which is one of the most popular choices. + +The `git` tool bases itself in the concept of repositories, and one such repository acts as the single source of truth for any project. We use `GitHub` as a server to publish such a repository for all our projects. + +You **MUST** have `git` installed on your system in order to contribute, as well as a `GitHub`'s account. + +If you do not have a GitHub account, you may create one at [github.com](https://github.com). If you do not know what `git` is, there are many books available, but you may start at [git-scm.com](https://git-scm.com) + +Configuration for `git`, with files such as `.gitignore` is already present in all projects, and it's handled through updates of `gobstones-scripts`, so you should not modify such file. + +In addition to basic `git`, we make use of features provided by `GitHub`, such as the `GitHub Actions` (for Continuous Integration) and `GitHub Pages` (For Documentation publishing), as well a handling **Issues** and **Pull Requests** through their platform. + +You may also find a `.github` folder at the root of mot projects, that holds configuration for some of these platform's tools. + +Also, if you have been using `git` in the past, you may find a slight different behavior in how it works on our project. This is explain by the addition of some tools added to enforce **semantic-commits**. For more information, read about `Husky`, `Commit Lint` and `Commitizen` in the **Git control** subsection of this document. +
+ + + + + +----------------------------------------------------- + + +## Building and automating + + + + + - - - -If you need help on installing these elements in your system, [consult our short tutorial](./installation-tutorial.md). +### Package Scripts: `nps` + +We use `nps` as the task manager. + +
+Expand to view more about nps + +To define and execute custom scripts within `Node.js`, running all the tooling in a simple fashion, we use `nps` (Node Package Scripts). +`nps` it's a task manager or task executor (in the same fashion as `grunt` or `gulp`). + +The good thing about `nps` is that it does not require knowledge of complex models and tools, but it's just a one step up on manually running the command through the terminal one by one. + +The configuration file for `nps`, `package-scripts.json` is abstracted away by `gobstones-scripts` by default, although you can eject it if you need to change the behavior of any task. This is a simple json file, listing all the possible tasks to run, and the code each of them will run on the terminal, along some description. + +Some predefined tasks are configured, such as building the application, running the tests, building and serving the documentation, and linting. Most simple calls are also present in the `scripts` section of each project's `package.json`, but you may run any task using `npm start` followed by the task to run. + +Additionally, tasks in the configuration for most of the projects make use of some helper tasks exported by the `gobstones-scripts` module, such as `serially` or `concurrently`. + +Again, basic configuration has already been provided, and there is not much you need to do to start using it than downloading the projects and installing the dependencies. Nonetheless, you may read more about `nps` in [`nps at npmjs`](https://www.npmjs.com/package/nps). +
+ + + + -## Other technologies +----------------------------------------------------- - - - + + + ### Rollup -As a means to bundle and compile code from the project modules, we rely on `rollup.js`. This tool is designed for modern JavaScript development applications, focusing on creating efficient and optimized bundles for the web. + +We rely on `rollup.js` to bundle the code of the project libraries. +
Expand to view more about rollup.js +Most modern projects rely in some bundler that packages all the code into a single distributable file. There are many bundlers you may be aware of, like `webpack`, `esm` or others. We chose `rollup` because it's can create efficient and optimized bundles for both the web and CLI applications, and it's specially useful for libraries. + +`rollup` also has many plugins, useful to allow code to pack additional filetypes, such as JSON, css, images or others, minifying or obfuscating the code. One such plugin calls the `TypeScript compiler`, and compile the code, avoiding the need to call the compiler directly. You will find that most project use this configuration instead of calling the compiler. + +You do not need to know rollup in detail unless you need to change the way a project is bundled or compiled. The configuration file, `rollup.config.js` is hidden by the `gobstones-script` module. You may always overwrite the default by **ejecting** the configuration files. + A good starting point to know the basics on `rollup.js` is [`rollupjs.org`](https://rollupjs.org/).
---- + + + - - - +----------------------------------------------------- + + + + + +### Vite + +We rely on `Vite` to bundle the code of the project react libraries. -### Package Scripts: `nps` -To define and execute custom scripts within `Node.js`, our project uses a `npm` feature called `nps` (Node Package Scripts) which can automate various tasks, such as building, testing, deploying, and more.
-Expand to view more about nps +Expand to view more about Vite + +`vite` is another bundler. It's focused on bundling web applications (not libraries), and we use it to bundle the react libraries as full application for testing and development. The final bundling for distribution is still performed by `Rollup`. + +You may find a `vite.config.ts` file with the configuration in the root of the react library projects. You should not change these configuration files, unless through updated of `gobstones-scripts`. -A good starting point to know the basics on `nps` is [`npmjs.com`](https://www.npmjs.com/package/nps). +You will probably not need to know much about may read about Vite in [`vitejs.dev`](https://vitejs.dev).
+ + + ---- +----------------------------------------------------- - - - +## Code format and style + + + + ### Prettier -To ensure uniformity in coding style, we integrate the opinionated code formatter `Prettier` to automatically enforce a standardized set of styling rules. + +We use `Prettier` to provide a uniform coding formatting through all projects. +
Expand to view more about Prettier -A good starting point to know the basics on `Prettier` is [`prettier.io`](https://prettier.io/). +To ensure uniformity in coding format, we integrate the opinionated code formatter `Prettier`. It allows to set a standardized set of formatting rules, such as indentation type, max length of lines, line endings and others. + +Note that prettier does not enforce the format, but rather allows you to reformat your code using the provided configuration. The IDE uses this to automatically reformat your code on saving a file. Also, `ESlint` integrates with `Prettier`, to verify that the format is compliant with the prettier configuration. + +The `Prettier` configuration files are present at the root of each project, as `.prettierrc` and `.prettierignore`, and should only be modified for all projects, through an update of `gobstones-script`. + +You do not need to know much about `Prettier` to start using it in the project, as all the configuration has already been done for you, that is, unless you use a different IDE than `VSCode`. If you want to learn more about the tool, you may read [`prettier.io`](https://prettier.io/).
---- + + + - - - +----------------------------------------------------- + + + + + +### EditorConfig + +We also include an `EditorConfig` file in every project. -### ESLint -In addition to `Prettier` for maintainability of codebase throughout our project, `ESLint` statically analyzes the code for common errors, stylistic issues, and potential pitfalls, thus providing actionable feedback to fix such problems for both `Javascript` and `Typescript`, ensuring the code's quality and reliability.
-Expand to view more about ESLint +Expand to view more about EditorConfig +Although `Prettier` is a great tool for code formatting, some IDEs do not play along with prettier, or they do not do it by default. To support more IDEs and code editors we have included an `EditorConfig` file in each project. + +The `EditorConfig` file, `.editorconfig` contains basic formatting configuration to tell the code editor how you require your files to be treated, uch as line endings, tab width and so on. -A good starting point to know the basics on `ESLint` is [`eslint.org`](https://eslint.org/). +This configuration should always match the one in your `Prettier` configuration, and should be the same through all projects, and as such, only should be changed through an update of `gobstones-scripts`. + +Again, you don't need to know much about `EditorConfig`, but it's a simple enough tool to understand by reading the provided documentation at[`editorconfig.org`](https://editorconfig.org/).
---- + + + - - - +----------------------------------------------------- + + + + + +### ESLint + +`ESLint` as a linter for maintaining coding standards. -### EditorConfig -For more style and formatting consistency, there is also the inclusion of `EditorConfig`, a file format that works across different code editors and IDEs.
-Expand to view more about EditorConfig +Expand to view more about ESLint + +Although `Prettier` provides formatting configuration, code styling is enforced through `ESLint`. This linter provides configuration that determine things such as the order in which methods should be declared, which are valid identifiers for a variable, where you should open and close your braces and other language aware style configuration. + +It statically analyzes the code for common errors, stylistic issues, and potential pitfalls, thus providing actionable feedback to fix such problems, ensuring the code's quality and reliability. + +`ESLint` uses the concept of plugins and templates, of which we use many to enforce some particular configuration. The linter is run by default before any test, and in case of style errors, the tests cannot pass. -A good starting point to know the basics on `EditorConfig` is [`editorconfig.org`](https://editorconfig.org/). +You will find the `ESLint` configuration file, `.eslintrc` at the root of every project. Again, it should not be changed unless through updates of `gobstones-scripts`. + +You will usually not require changing these rules, but to understand the basic idea behind the linter, you may read the documentation at [`eslint.org`](https://eslint.org/).
---- + + + + +----------------------------------------------------- + +## Documentation and Testing - - - + + + ### TypeDoc -As a way to generate documentation, the `TypeDoc` tool reads the `TypeScript` source files, parses comments contained within them, and creates API documentation for a more comprehensive and well-structured documentation of the project. + +We use `TypeDoc` to generate the project documentation. +
Expand to view more about TypeDoc +As a way to generate documentation, the `TypeDoc` tool reads the `TypeScript` source files, parses comments contained within them, and creates API documentation for a more comprehensive and well-structured documentation of the project. + +You **SHOULD** be aware of basic practices for documentation, as code without documentation will not be accepted as contribution. + +You may find that the configuration file `typedoc.js` is not present at the root of most projects, as it has been abstracted by the `gobstones-scripts` tool. If you require some particular configuration, you may **eject** the file into the project root. + A good starting point to know the basics on `TypeDoc` is [`typedoc.org`](https://typedoc.org/guides/overview/).
---- + + + + +----------------------------------------------------- + + + + + +### StoryBook + +We use `StoryBook` to generate a runnable version of react components. + +
+Expand to view more about StoryBook + +`StoryBook` is a tool for generating a testing/visualization page for a web component or react components. It allows you to visualize, modify and test a component easily. + +We use `StoryBook` to run in development mode when developing components, as well as generating a demo of the component for the documentation page published. + +You will see a `.storybook` folder, as well as a `stories` folder in each project containing components. That last folder requires user modification if new components are added or if current components are modified. + +In that sense, you **SHOULD** be aware of how these stories work. We recomend you to start by reading the documentation at [storybook.js.org](https://storybook.js.org). +
+ + + + - - - +----------------------------------------------------- + + + + ### Jest -Last but not least, you will be creating, running, and managing test suites with `Jest` testing framework. It works with `TypeScript` code, providing a comprehensive set of tools and features to simplify the process of writing and maintaining tests. + +We use `Jest` for testing. +
Expand to view more about Jest +`Jest` will handle running, and managing test suites. It works with `TypeScript` code, providing a comprehensive set of tools and features to simplify the process of writing and maintaining tests. + +You **SHOULD** learn how to properly create and run tests, as code that is not properly tested or breaks existing tests will not be accepted. + +You will fin that the `jest.config.js` file is not at the root of the library for most projects, as it's abstracted away by the `gobstones-scripts` module. You can always overwrite the configuration by **ejecting** the file. + A good starting point to know the basics on `Jest` is [`jestjs.io`](https://jestjs.io/).
---- + + + +----------------------------------------------------- + +## Git control + + + + + +### Husky + +`Husky` is used to provide and trigger `git hooks`. + +
+Expand to view more about Husky + +Git hooks are a way to provide automatic behavior when some particular git action is performed, such as a commit or a push. `Husky` provides a way to create such hooks in our projects in an eay fashion. + +In most projects you will find a `.husky` folder that contains the hooks to execute, as well as some other configurations. We use the hooks to validate commits and ensure **conventional commits**, as well as to automatically generate some files, such as the CHANGELOG. You will not likely have to change this, as it's intended to be changed through updates of `gobstones-scripts`. + +You will usually not need to know much about `Husky`, but you may find their documentation useful by going to [typicode.github.io/husky](https://typicode.github.io/husky) +
+ + + + +----------------------------------------------------- + + + + + +### Commitizen + +`Commitizen` is used to enforce a particular format in commit messages. + +
+Expand to view more about Commitizen + +When having to write a commit message it's tempting to provide a minimal description and just push the code. We attempt to follow **conventional commits**, and to help enforce proper messages, we use `Commitizen`. +This tool runs through a `Husky` hook whenever there's a commit (except the `--no-verify` flag is used or you are amending a commit). `Commitizen` provides a simple prompt with different questions, and once all are answered it will present you the fully generated commit message. +The questions presented will guide you through defining a proper conventional commit message. You may always modify the message at the end of the process if needed. + +You will find a `.czrc` file with the `Commitizen` configuration at the root of most projects, although changing the defaults is not recommended, as it's intended to be changed through updates of `gobstones-scripts`. + +You do not need to know much about `Commitizen`, but you can read their documentation at [commitizen at npmjs](https://www.npmjs.com/package/commitizen) +
+ + + + +----------------------------------------------------- + + + + + +### CommitLint + +`CommitLint` is used to lint the commit messages and ensure they follow the conventional commit structure. + +
+Expand to view more about CommitLint + +As `Commitizen` only guides you through creating a commit message with proper conventional commit style, but you are allowed to modify the message later, `CommitLint` is used to validate that the commit message actually uses the conventional commit style. + +This tool runs as a `Husky` hook after a commit message has been redacted, and just before the actual commit. If it finds any error in the style of the commit, it will abort the commit, else, the commit will pass and be performed. + +You will find a `commitlint.config.js` file with the `CommitLint` configuration at the root of most projects, although changing the defaults is not recommended, as it's intended to be changed through updates of `gobstones-scripts`. + +You do not need to know much about `CommitLint`, but you can read their documentation at [commitlint.js.org](https://commitlint.js.org/#/) + + + + + + +----------------------------------------------------- - - - To learn about the coding standards and workflow for the mentioned technologies and GobstonesWeb2 in general [consult coding standards and workflow section](../coding-standards/coding-standards.md). [Back to Introduction](../introduction.md).