From 8721a2216e5b2d3fc1ea044055b151986e39ab7e Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Thu, 29 Aug 2024 22:01:07 -0400 Subject: [PATCH] feat: initial version (#1) --- .github/workflows/ci.yml | 117 +++++ .gitignore | 13 + LICENSE | 661 +++++++++++++++++++++++++++++ README.md | 24 +- babel.config.js | 2 + codecov.yml | 19 + eslint.config.mjs | 33 ++ package.json | 59 +++ src/css/lizardbyte.scss | 171 ++++++++ src/js/crowdin-web-widget.js | 22 + src/js/crowdin.js | 53 +++ src/js/discord.js | 29 ++ src/js/levenshtein-distance.js | 36 ++ src/js/lizardbyte-css.js | 1 + src/js/load-script.js | 22 + src/js/random-quote.js | 25 ++ src/js/ranking-sorter.js | 26 ++ src/js/sleep.js | 10 + tests/levenshtein-distance.test.js | 26 ++ tests/load-script.test.js | 48 +++ tests/random-quote.test.js | 77 ++++ tests/ranking-sorter.test.js | 55 +++ tests/sleep.test.js | 41 ++ webpack.config.js | 95 +++++ 24 files changed, 1663 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 babel.config.js create mode 100644 codecov.yml create mode 100644 eslint.config.mjs create mode 100644 package.json create mode 100644 src/css/lizardbyte.scss create mode 100644 src/js/crowdin-web-widget.js create mode 100644 src/js/crowdin.js create mode 100644 src/js/discord.js create mode 100644 src/js/levenshtein-distance.js create mode 100644 src/js/lizardbyte-css.js create mode 100644 src/js/load-script.js create mode 100644 src/js/random-quote.js create mode 100644 src/js/ranking-sorter.js create mode 100644 src/js/sleep.js create mode 100644 tests/levenshtein-distance.test.js create mode 100644 tests/load-script.test.js create mode 100644 tests/random-quote.test.js create mode 100644 tests/ranking-sorter.test.js create mode 100644 tests/sleep.test.js create mode 100644 webpack.config.js diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..5979caa --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,117 @@ +--- +# This workflow will run tests using node and then publish a package to GitHub Packages on push events to master. +# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages + +name: CI + +on: + pull_request: + branches: [master] + types: [opened, synchronize, reopened] + push: + branches: [master] + +jobs: + setup_release: + name: Setup Release + outputs: + publish_release: ${{ steps.setup_release.outputs.publish_release }} + release_body: ${{ steps.setup_release.outputs.release_body }} + release_commit: ${{ steps.setup_release.outputs.release_commit }} + release_generate_release_notes: ${{ steps.setup_release.outputs.release_generate_release_notes }} + release_tag: ${{ steps.setup_release.outputs.release_tag }} + release_version: ${{ steps.setup_release.outputs.release_version }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Release + id: setup_release + uses: LizardByte/setup-release-action@v2024.801.192524 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup node + uses: actions/setup-node@v4 + with: + node-version: latest + + - name: Install dependencies + run: npm install + + - name: Test + id: test + env: + FORCE_COLOR: true + run: | + npm test + + - name: Build + run: npm run build + + - name: Upload test results to Codecov + # any except canceled or skipped + if: >- + always() && + (steps.test.outcome == 'success' || steps.test.outcome == 'failure') && + startsWith(github.repository, 'LizardByte/') + uses: codecov/test-results-action@v1 + with: + fail_ci_if_error: true + files: ./junit.xml,!./cache + token: ${{ secrets.CODECOV_TOKEN }} + verbose: true + + - name: Upload coverage + # any except canceled or skipped + if: >- + always() && + (steps.test.outcome == 'success' || steps.test.outcome == 'failure') && + startsWith(github.repository, 'LizardByte/') + uses: codecov/codecov-action@v4 + with: + disable_search: true + fail_ci_if_error: true + files: ./coverage/coverage-final.json + token: ${{ secrets.CODECOV_TOKEN }} + verbose: true + + publish-gpr: + if: ${{ needs.setup_release.outputs.publish_release == 'true' }} + needs: + - setup_release + - build + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup node + uses: actions/setup-node@v4 + with: + node-version: latest + registry-url: https://npm.pkg.github.com/ + + - name: Update package.json + run: npm version ${{ needs.setup_release.outputs.release_version }} + + - name: Install dependencies + run: npm install + + - name: Build + run: npm run build + + - name: Publish + run: npm publish + env: + NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ebdc25c --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +# Ignore JetBrains IDE files +.idea/ + +# Ignore node_modules +node_modules/ +package-lock.json + +# Ignore test coverage +junit.xml +coverage/ + +# Ignore build artifacts +dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index fd3e658..91b7ebc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# template-base -Base repository template for LizardByte. +# shared-web + +[![GitHub stars](https://img.shields.io/github/stars/lizardbyte/shared-web.svg?logo=github&style=for-the-badge)](https://github.com/LizardByte/shared-web) +[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/lizardbyte/shared-web/ci.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/shared-web/actions/workflows/CI.yml?query=branch%3Amaster) +[![Codecov](https://img.shields.io/codecov/c/gh/LizardByte/shared-web?token=gWHqqpMAuO&style=for-the-badge&logo=codecov&label=codecov)](https://codecov.io/gh/LizardByte/shared-web) + +Common web assets for use in LizardByte projects. + +## Installation +1. Add a `.npmrc` file to the root of your project with the following line: + ``` + @LizardByte:registry=https://npm.pkg.github.com + ``` + +2. Add the dependency to your package.json file: + ```json + { + "dependencies": { + "LizardByte/shared-web": "latest" + } + } + ``` diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 0000000..f95788a --- /dev/null +++ b/babel.config.js @@ -0,0 +1,2 @@ +// this allows jest to use ES6 module imports +module.exports = {presets: ['@babel/preset-env']} diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..e9c9c87 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,19 @@ +--- +codecov: + branch: master + +coverage: + status: + project: + default: + target: auto + threshold: 10% + +comment: + layout: "diff, flags, files" + behavior: default + require_changes: false # if true: only post the comment if coverage changes + +ignore: + - "tests" + - "third-party" diff --git a/eslint.config.mjs b/eslint.config.mjs new file mode 100644 index 0000000..872ac3b --- /dev/null +++ b/eslint.config.mjs @@ -0,0 +1,33 @@ +import globals from "globals"; +import pluginJs from "@eslint/js"; + +export default [ + pluginJs.configs.recommended, + { + ignores: [ + "coverage/**", + "dist/**", + ], + }, + { + languageOptions: { + globals: { + ...globals.browser, + ...globals.node, + "require": "readonly", + }, + }, + plugins: { + jest: { + extends: ["eslint:recommended"], + rules: { + "jest/no-disabled-tests": "error", + "jest/no-focused-tests": "error", + "jest/no-identical-title": "error", + "jest/prefer-to-have-length": "error", + "jest/valid-expect": "error", + }, + }, + }, + }, +]; diff --git a/package.json b/package.json new file mode 100644 index 0000000..885d483 --- /dev/null +++ b/package.json @@ -0,0 +1,59 @@ +{ + "name": "@lizardbyte/shared-web", + "repository": "https://github.com/LizardByte/shared-web.git", + "version": "0.0.0", + "description": "Shared web assets for LizardByte projects", + "files": [ + "dist/", + "src/", + "tests/", + "LICENSE", + "README.md" + ], + "dependencies": { + "bootstrap": "5.3.3" + }, + "devDependencies": { + "@babel/core": "7.25.2", + "@babel/preset-env": "7.25.3", + "@eslint/js": "9.9.0", + "@jest/globals": "29.7.0", + "babel-loader": "9.1.3", + "cross-env": "7.0.3", + "css-loader": "7.1.2", + "eslint": "9.9.0", + "eslint-plugin-jest": "28.8.0", + "globals": "15.9.0", + "jest": "29.7.0", + "jest-environment-jsdom": "29.7.0", + "jest-junit": "16.0.0", + "mini-css-extract-plugin": "2.9.1", + "node-fetch": "3.3.2", + "npm-run-all": "4.1.5", + "postcss": "8.4.41", + "postcss-loader": "8.1.1", + "postcss-preset-env": "10.0.2", + "sass": "1.77.8", + "sass-loader": "16.0.1", + "webpack": "5.94.0", + "webpack-cli": "5.1.4", + "webpack-dev-server": "5.0.4" + }, + "jest": { + "collectCoverageFrom": [ + "src/**/*.{js,jsx}" + ], + "testEnvironment": "jsdom" + }, + "publishConfig": { + "registry": "https://npm.pkg.github.com" + }, + "scripts": { + "build": "cross-env NODE_ENV=production webpack", + "start": "webpack serve", + "test": "npm-run-all test:unit test:report test:lint", + "test:unit": "jest --coverage", + "test:report": "jest --reporters=jest-junit", + "test:lint": "eslint ." + } +} diff --git a/src/css/lizardbyte.scss b/src/css/lizardbyte.scss new file mode 100644 index 0000000..b64217e --- /dev/null +++ b/src/css/lizardbyte.scss @@ -0,0 +1,171 @@ +body { + padding-top: 80px; +} + +/*Apply to elements that serve as anchors*/ +.offset-anchor { + border-top: 80px solid transparent; + margin: -80px 0 0; + -webkit-background-clip: padding-box; + -moz-background-clip: padding; + background-clip: padding-box; +} + +/*Because offset-anchor causes sections to overlap the bottom of previous ones,*/ +/*we need to put content higher so links aren't blocked by the transparent border.*/ +.container { + position: relative; + z-index: 1; +} + +.navbar { + min-height: 80px; + border-bottom: 1px solid white; +} + +.navbar-brand { + font-size: 1.75rem; +} + +.nav-link { + font-size: 1.25rem; +} + +.nav-link-sm { + font-size: 1rem; +} + +.bg-dark { + --bs-bg-opacity: 1; + background-color: #151515 !important; +} + +.bg-dark-gray { + --bs-bg-opacity: 1; + background-color: #303436 !important; +} + +.carousel-overlay-title { + position: absolute; + top: 20vh; + right: 10vw; + padding: 1rem; + text-shadow: 2px 2px 5px black; + user-select: none; + z-index: 1; +} + +.carousel-overlay-subtitle { + position: absolute; + top: 30vh; + right: 10vw; + padding: 1rem; + text-shadow: 2px 2px 5px black; + user-select: none; + z-index: 1; +} + +.carousel-item.active, .carousel-item .view { + height: 50vh !important; +} + +.carousel-item img { + object-fit: cover; + width:100% !important; + height: 100% !important; +} + +.content h1 { + font-size: 55px; +} + +@media screen and (max-width: 320px) { + .content h1 { + font-size: 30px; + } +} + +@media screen and (min-width: 321px) and (max-width: 768px) { + .content h1 { + font-size: 30px; + } +} + +.content h5 { + font-size: 23px; + margin-left: 80px; + margin-right: 80px; +} + +@media screen and (max-width: 320px) { + .content h5 { + font-size: 18px; + margin-left: 20px; + margin-right: 20px + } +} + +@media screen and (min-width: 321px) and (max-width: 768px) { + .content h5 { + font-size: 18px; + margin-left: 20px; + margin-right: 20px; + } +} + +.feature { + display: inline-flex; + align-items: center; + justify-content: center; + height: 3rem; + width: 3rem; + font-size: 1.5rem; +} + +.widgetbot { + display: flex; + align-items: center; + justify-content: space-around; +} + +.feedback { + display: flex; + align-items: center; + justify-content: space-around; +} + +iframe.feedback { + width: 100vw; + min-height: calc(100vh - 80px - 72px); /* subtract navbar and footer height */ +} + +@media screen and (min-width: 321px) and (max-width: 768px) { + iframe.feedback { + min-height: calc(100vh - 80px - 93px); /* subtract navbar and footer height */ + } +} + +@media screen and (max-width: 320px) { + iframe.feedback { + min-height: calc(100vh - 80px - 114px); /* subtract navbar and footer height */ + } +} + +/*card image hover*/ +.hover-zoom { + overflow: hidden; +} + +.hover-zoom img { + transition: all 1.5s ease; +} + +.hover-zoom:hover img { + transform: scale(1.1); +} + +/*custom text colors*/ +.text-purple { + --bs-text-opacity: 1; + color: var(--bs-purple) !important; +} diff --git a/src/js/crowdin-web-widget.js b/src/js/crowdin-web-widget.js new file mode 100644 index 0000000..4b9aa4d --- /dev/null +++ b/src/js/crowdin-web-widget.js @@ -0,0 +1,22 @@ +const loadScript = require('./load-script'); + +loadScript('https://crowdin.com/js/crowdjet/crowdjet.js', function() { + // crowdin web widget: https://crowdin.com/project/lizardbyte/tools/web-widget + // get body + let body = document.getElementsByTagName('body')[0] + + // create container (popup) + let container = document.createElement('div') + container.id = 'crowdjet-container' + container.dataset.projectId = '606145' + container.style.bottom = '90px' + container.style.left = '5px' + body.appendChild(container) + + // create expand container (button) + let expandContainer = document.createElement('div') + expandContainer.id = 'crowdjet-expand-container' + expandContainer.style.bottom = '0px' + expandContainer.style.left = '120px' + body.appendChild(expandContainer) +}); diff --git a/src/js/crowdin.js b/src/js/crowdin.js new file mode 100644 index 0000000..0fdc024 --- /dev/null +++ b/src/js/crowdin.js @@ -0,0 +1,53 @@ +const loadScript = require('./load-script'); + +loadScript('https://proxy-translator.app.crowdin.net/assets/proxy-translator.js', function() { + window.proxyTranslator.init({ + baseUrl: "https://app.lizardbyte.dev", + appUrl: "https://proxy-translator.app.crowdin.net", + valuesParams: "U2FsdGVkX19ClOT7gAzJBnfQPMcvqkPxFWxyPrnN7UEMztYDAOA+/W4kvMqRz2gDLv2/K3hTEtwbcq5imv5k5MUAykz0uklBcdH49kqeo1AhYpNKXdwXZNYBPXmNUm5F", + distributionBaseUrl: "https://distributions.crowdin.net", + filePath: "/app.lizardbyte.dev.json", + distribution: "0913bb75b61f0b26247ffa91bw4", + languagesData: { + "fr": {"code":"fr","name":"French","twoLettersCode":"fr"}, + "es-ES": {"code":"es-ES","name":"Spanish","twoLettersCode":"es"}, + "de": {"code":"de","name":"German","twoLettersCode":"de"}, + "it": {"code":"it","name":"Italian","twoLettersCode":"it"}, + "ja":{"code":"ja","name":"Japanese","twoLettersCode":"ja"}, + "pt-PT":{"code":"pt-PT","name":"Portuguese","twoLettersCode":"pt"}, + "ru": {"code":"ru","name":"Russian","twoLettersCode":"ru"}, + "sv-SE":{"code":"sv-SE","name":"Swedish","twoLettersCode":"sv"}, + "tr":{"code":"tr","name":"Turkish","twoLettersCode":"tr"}, + "zh-CN":{"code":"zh-CN","name":"Chinese Simplified","twoLettersCode":"zh"}, + "en": {"code":"en","name":"English","twoLettersCode":"en"}, + "en-US": {"code":"en-US","name":"English, United States","twoLettersCode":"en"}, + "en-GB": {"code":"en-GB","name":"English, United Kingdom","twoLettersCode":"en"} + }, + defaultLanguage: "en", + defaultLanguageTitle: "English", + languageDetectType: "default", + poweredBy: false, + position: "bottom-left", + submenuPosition: "top-left", + }); + + // change styling of language selector button + let button = document.getElementsByClassName('cr-picker-button')[0] + button.classList.add('border-white') + button.classList.add('btn') + button.classList.add('btn-outline-light') + button.classList.add('bg-dark') + button.classList.add('text-white') + button.classList.add('rounded-0') + + // change styling of language selector menu + let menu = document.getElementsByClassName('cr-picker-submenu')[0] + menu.classList.add('border-white') + menu.classList.add('bg-dark') + menu.classList.add('text-white') + menu.classList.add('rounded-0') + + // change styling of selected language in menu + let selected = document.getElementsByClassName('cr-selected')[0] + selected.classList.add('text-white') +}); diff --git a/src/js/discord.js b/src/js/discord.js new file mode 100644 index 0000000..fe90b10 --- /dev/null +++ b/src/js/discord.js @@ -0,0 +1,29 @@ +/* global Crate */ +// Crate is not defined... can we use npm version? +// https://github.com/widgetbot-io/crate/issues/26 + +const loadScript = require('./load-script'); +const { fetchRandomQuote } = require('./random-quote'); + +function randomQuote(quote, crate) { + let the_quote = quote['quote_safe'] || quote['quote']; + crate.notify(the_quote); +} + +// Widgetbot initialization +loadScript('https://cdn.jsdelivr.net/npm/@widgetbot/crate@3', function() { + let widgetbot = new Crate({ + server: '804382334370578482', + channel: '804383092822900797', + defer: false, + }); + + // get random video game quotes and notify the user on Widgetbot after 7 minutes + fetchRandomQuote().then(quote => { + setTimeout(() => { + if (widgetbot) { + randomQuote(quote, widgetbot); + } + }, 7 * 60 * 1000); + }); +}); diff --git a/src/js/levenshtein-distance.js b/src/js/levenshtein-distance.js new file mode 100644 index 0000000..7260364 --- /dev/null +++ b/src/js/levenshtein-distance.js @@ -0,0 +1,36 @@ +function levenshteinDistance(a, b) { + if (a.length === 0) return b.length; + if (b.length === 0) return a.length; + + let matrix = []; + + // increment along the first column of each row + let i; + for (i = 0; i <= b.length; i++) { + matrix[i] = [i]; + } + + // increment each column in the first row + let j; + for (j = 0; j <= a.length; j++) { + matrix[0][j] = j; + } + + // Fill in the rest of the matrix + for (i = 1; i <= b.length; i++) { + for (j = 1; j <= a.length; j++) { + if (b.charAt(i - 1) === a.charAt(j - 1)) { + matrix[i][j] = matrix[i - 1][j - 1]; + } else { + matrix[i][j] = Math.min(matrix[i - 1][j - 1] + 1, // substitution + Math.min(matrix[i][j - 1] + 1, // insertion + matrix[i - 1][j] + 1)); // deletion + } + } + } + + // return the percentage of the levenshtein distance + return (1 - (matrix[b.length][a.length] / Math.max(a.length, b.length))) * 100 +} + +module.exports = levenshteinDistance; diff --git a/src/js/lizardbyte-css.js b/src/js/lizardbyte-css.js new file mode 100644 index 0000000..1e84bfb --- /dev/null +++ b/src/js/lizardbyte-css.js @@ -0,0 +1 @@ +import "../css/lizardbyte.scss"; diff --git a/src/js/load-script.js b/src/js/load-script.js new file mode 100644 index 0000000..ed743ec --- /dev/null +++ b/src/js/load-script.js @@ -0,0 +1,22 @@ +/** + * Load a script asynchronously, and add it to the DOM. Optionally, call a callback when the script has loaded. + * @param url The URL of the script to load. + * @param callback An optional callback to call when the script has loaded. + */ +function loadScript(url, callback) { + const script = document.createElement('script'); + script.src = url; + script.async = true; + + script.onload = () => { + if (callback) callback(null, script); + }; + + script.onerror = () => { + if (callback) callback(new Error(`Failed to load script: ${url}`)); + }; + + document.head.appendChild(script); +} + +module.exports = loadScript; diff --git a/src/js/random-quote.js b/src/js/random-quote.js new file mode 100644 index 0000000..ed01ab8 --- /dev/null +++ b/src/js/random-quote.js @@ -0,0 +1,25 @@ +let quoteCache = null; + +/** + * Fetch a random quote from our API. + * @returns {Promise<*>} A promise that resolves with a random quote + */ +async function fetchRandomQuote() { + if (!quoteCache) { + const response = await fetch('https://app.lizardbyte.dev/uno/random-quotes/games.json'); + quoteCache = await response.json(); + } + return quoteCache[Math.floor(Math.random() * quoteCache.length)]; +} + +/** + * Reset the quote cache. + */ +function resetQuoteCache() { + quoteCache = null; +} + +module.exports = { + fetchRandomQuote, + resetQuoteCache, +}; diff --git a/src/js/ranking-sorter.js b/src/js/ranking-sorter.js new file mode 100644 index 0000000..5235a30 --- /dev/null +++ b/src/js/ranking-sorter.js @@ -0,0 +1,26 @@ +/** + * Sorts an array of objects by two keys in descending order. + * @param firstKey The primary key to sort by. + * @param secondKey The secondary key to sort by, in case the first key is equal. + * @returns {(function(*, *): (number))|*} The sorting function. + */ +let rankingSorter = function (firstKey, secondKey) { + return function(a, b) { + if (a[firstKey] > b[firstKey]) { + return -1; + } else if (a[firstKey] < b[firstKey]) { + return 1; + } + else { + if (a[secondKey] > b[secondKey]) { + return 1; + } else if (a[secondKey] < b[secondKey]) { + return -1; + } else { + return 0; + } + } + } +} + +module.exports = rankingSorter; diff --git a/src/js/sleep.js b/src/js/sleep.js new file mode 100644 index 0000000..19619a2 --- /dev/null +++ b/src/js/sleep.js @@ -0,0 +1,10 @@ +/** + * Sleep for a given amount of time. + * @param ms The time to sleep in milliseconds + * @returns {Promise} A promise that resolves after the given time + */ +function sleep(ms) { + return new Promise(resolve => setTimeout(resolve, ms)); +} + +module.exports = sleep; diff --git a/tests/levenshtein-distance.test.js b/tests/levenshtein-distance.test.js new file mode 100644 index 0000000..d5eb68c --- /dev/null +++ b/tests/levenshtein-distance.test.js @@ -0,0 +1,26 @@ +import { + describe, + expect, + test, +} from '@jest/globals'; + +const levenshteinDistance = require('../src/js/levenshtein-distance'); + +describe('levenshteinDistance', () => { + const testCases = [ + { a: 'test', b: 'test', expected: 100 }, + { a: 'abc', b: 'xyz', expected: 0 }, + { a: 'kitten', b: 'sitting', expected: 57.14 }, + { a: 'flaw', b: 'lawn', expected: 50 }, + { a: '', b: 'nonempty', expected: 8 }, + { a: 'nonempty', b: '', expected: 8 } + ]; + + test.each(testCases)( + 'should return $expected when comparing "$a" and "$b"', + ({ a, b, expected }) => { + const result = levenshteinDistance(a, b); + expect(result).toBeCloseTo(expected, 2); + } + ); +}); diff --git a/tests/load-script.test.js b/tests/load-script.test.js new file mode 100644 index 0000000..4f4a097 --- /dev/null +++ b/tests/load-script.test.js @@ -0,0 +1,48 @@ +import { + beforeEach, + describe, + expect, + it, +} from '@jest/globals'; + +const loadScript = require('../src/js/load-script'); + +describe('loadScript', () => { + beforeEach(() => { + document.head.innerHTML = ''; + }); + + it('should load a script and call the callback on success', (done) => { + const url = 'https://example.com/test-script.js'; + loadScript(url, (err, script) => { + expect(err).toBeNull(); + expect(script).toBeInstanceOf(HTMLScriptElement); + expect(script.src).toBe(url); + done(); + }); + + const script = document.head.querySelector('script'); + script.onload(); + }); + + it('should call the callback with an error on failure', (done) => { + const url = 'https://example.com/test-script.js'; + loadScript(url, (err) => { + expect(err).toBeInstanceOf(Error); + expect(err.message).toBe(`Failed to load script: ${url}`); + done(); + }); + + const script = document.head.querySelector('script'); + script.onerror(); + }); + + it('should load a script without a callback', () => { + const url = 'https://example.com/test-script.js'; + loadScript(url); + + const script = document.head.querySelector('script'); + expect(script).toBeInstanceOf(HTMLScriptElement); + expect(script.src).toBe(url); + }); +}); diff --git a/tests/random-quote.test.js b/tests/random-quote.test.js new file mode 100644 index 0000000..8dd9c4c --- /dev/null +++ b/tests/random-quote.test.js @@ -0,0 +1,77 @@ +import { + afterEach, + beforeEach, + describe, + expect, + it, + jest, +} from '@jest/globals'; + +const { fetchRandomQuote, resetQuoteCache } = require('../src/js/random-quote'); + +describe('fetchRandomQuote', () => { + let originalFetch; + + beforeEach(() => { + // Save the original fetch function + originalFetch = globalThis.fetch; + // Clear the quote cache before each test + jest.resetModules(); + // Reset the quotesCache + resetQuoteCache(); + }); + + afterEach(() => { + // Restore the original fetch function + globalThis.fetch = originalFetch; + }); + + it('should fetch and return a random quote', async () => { + const mockQuotes = [ + { quote: 'Quote 1' }, + { quote: 'Quote 2' }, + { quote: 'Quote 3' } + ]; + + globalThis.fetch = jest.fn(() => + Promise.resolve({ + json: () => Promise.resolve(mockQuotes) + }) + ); + + const quote = await fetchRandomQuote(); + expect(mockQuotes).toContainEqual(quote); + expect(globalThis.fetch).toHaveBeenCalledTimes(1); + }); + + it('should return a cached quote if already fetched', async () => { + const mockQuotes = [ + { quote: 'Quote 1' }, + { quote: 'Quote 2' }, + { quote: 'Quote 3' } + ]; + + globalThis.fetch = jest.fn(() => + Promise.resolve({ + json: () => Promise.resolve(mockQuotes) + }) + ); + + // First call to populate the cache + await fetchRandomQuote(); + // Second call should use the cache + const quote = await fetchRandomQuote(); + + expect(mockQuotes).toContainEqual(quote); + expect(globalThis.fetch).toHaveBeenCalledTimes(1); + }); + + it('should handle fetch errors gracefully', async () => { + globalThis.fetch = jest.fn(() => + Promise.reject(new Error('Failed to fetch')) + ); + + await expect(fetchRandomQuote()).rejects.toThrow('Failed to fetch'); + expect(globalThis.fetch).toHaveBeenCalledTimes(1); + }); +}); diff --git a/tests/ranking-sorter.test.js b/tests/ranking-sorter.test.js new file mode 100644 index 0000000..fc97818 --- /dev/null +++ b/tests/ranking-sorter.test.js @@ -0,0 +1,55 @@ +import { + describe, + expect, + it, +} from '@jest/globals'; + +const rankingSorter = require('../src/js/ranking-sorter'); + +describe('rankingSorter', () => { + const testCases = [ + { + description: 'should sort by firstKey descending and secondKey ascending', + data: [ + { key1: 1, key2: 2 }, + { key1: 2, key2: 1 }, + { key1: 1, key2: 1 } + ], + expected: [ + { key1: 2, key2: 1 }, + { key1: 1, key2: 1 }, + { key1: 1, key2: 2 } + ] + }, + { + description: 'should return 1 when firstKey values are equal and secondKey of first object is greater', + data: [ + { key1: 1, key2: 2 }, + { key1: 1, key2: 1 } + ], + expected: 1, + compare: true + }, + { + description: 'should return 0 when both firstKey and secondKey values are equal', + data: [ + { key1: 1, key2: 1 }, + { key1: 1, key2: 1 } + ], + expected: 0, + compare: true + } + ]; + + testCases.forEach(({ description, data, expected, compare }) => { + it(description, () => { + if (compare) { + const result = rankingSorter('key1', 'key2')(data[0], data[1]); + expect(result).toBe(expected); + } else { + const sorted = data.sort(rankingSorter('key1', 'key2')); + expect(sorted).toEqual(expected); + } + }); + }); +}); diff --git a/tests/sleep.test.js b/tests/sleep.test.js new file mode 100644 index 0000000..84db3dc --- /dev/null +++ b/tests/sleep.test.js @@ -0,0 +1,41 @@ +import { + afterAll, + beforeAll, + beforeEach, + describe, + expect, + jest, + test, +} from '@jest/globals'; + +const sleep = require('../src/js/sleep'); + +describe('sleep function', () => { + beforeAll(() => { + jest.useFakeTimers(); + }) + + beforeEach(() => { + jest.spyOn(global, 'setTimeout'); + }); + + test.each([ + [500], // 0.5 second + [1000], // 1 second + [1500], // 1.5 seconds + [2000], // 2 seconds + [60000], // 60 seconds + ])('resolves after %i milliseconds', async (delay) => { + let delay_value = delay[0]; + const sleepPromise = sleep(delay_value); + jest.advanceTimersByTime(delay_value); + await sleepPromise; + + // Allow a small margin of error for the timer + expect(setTimeout).toHaveBeenCalledWith(expect.any(Function), delay_value); + }); + + afterAll(() => { + jest.useRealTimers(); + }); +}); diff --git a/webpack.config.js b/webpack.config.js new file mode 100644 index 0000000..295c28b --- /dev/null +++ b/webpack.config.js @@ -0,0 +1,95 @@ +const path = require('path'); +const MiniCssExtractPlugin = require('mini-css-extract-plugin'); + +let production = process.env.NODE_ENV === 'production'; + +let config = { + entry: { + 'crowdin': './src/js/crowdin', + 'crowdin-web-widget': './src/js/crowdin-web-widget', + 'discord': './src/js/discord', + 'levenshtein-distance': './src/js/levenshtein-distance', + 'lizardbyte-css': './src/js/lizardbyte-css', + 'load-script': './src/js/load-script', + 'random-quote': './src/js/random-quote', + 'ranking-sorter': './src/js/ranking-sorter', + 'sleep': './src/js/sleep', + }, + output: { + filename: '[name].js', + path: path.resolve(__dirname, 'dist'), + clean: true, + }, + module: { + rules: [ + { + test: /\.js$/, + exclude: /node_modules/, + use: { + loader: 'babel-loader', + options: { + presets: ['@babel/preset-env'], + }, + }, + }, + { + test: /\.css$/, + exclude: /node_modules/, + use: [ + MiniCssExtractPlugin.loader, // this is processed last + "css-loader", + { + loader: "postcss-loader", + options: { + postcssOptions: { + plugins: [ + ["postcss-preset-env", {}], + ], + }, + }, + }, // this is processed first + ], + }, + { + test: /\.scss$/, + exclude: /node_modules/, + use: [ + MiniCssExtractPlugin.loader, // this is processed last + "css-loader", + { + loader: "postcss-loader", + options: { + postcssOptions: { + plugins: [ + ["postcss-preset-env", {}], + ], + }, + }, + }, + "sass-loader", // this is processed first + ], + }, + ], + }, + plugins: [ + new MiniCssExtractPlugin({ + filename: '[name].css', + }), + ], + resolve: { + extensions: ['.js'], + }, + devtool: 'inline-source-map', + mode: "development", + devServer: { + static: './dist', + watchFiles: ['src/**/*'], + }, +} + +if (production) { + config.mode = 'production'; + config.devtool = 'source-map'; +} + +module.exports = config;