From caf0dc3824dbd47579f7df52b77f048030b8dce4 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 19:29:03 +0100 Subject: [PATCH 1/8] ci: initial ci implementation - Also adds several Project related files Signed-off-by: thelooter --- .github/workflows/build.yaml | 46 ++++ .github/workflows/lint.yaml | 47 ++++ CODE_OF_CONDUCT.md | 134 +++++++++++ CONTRIBUTING.md | 112 +++++++++ README.md | 58 +++++ docs/LICENSE | 427 +++++++++++++++++++++++++++++++++++ 6 files changed, 824 insertions(+) create mode 100644 .github/workflows/build.yaml create mode 100644 .github/workflows/lint.yaml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 docs/LICENSE diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..dddde19 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,46 @@ +--- +name: pnpm Example Workflow + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + runs-on: ubuntu-22.04 + strategy: + matrix: + node-version: + - 18 + - 20 + - lts/* + - latest + steps: + - uses: actions/checkout@v4 + + - name: Get PNPM version from package.json + id: pnpm-version + shell: bash + run: echo "pnpm_version=$(node -p 'require(`./package.json`).engines.pnpm')" >> $GITHUB_OUTPUT + + - name: Install pnpm + uses: pnpm/action-setup@v4 + with: + version: ${{ steps.pnpm-version.outputs.pnpm_version }} + + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + cache: 'pnpm' + + - name: Install dependencies + run: pnpm install + + - name: Build documentation + run: pnpm run docs:build +... diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..00f9609 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,47 @@ +--- +name: Lint + +on: + push: + branches: + - main + pull_request: + branches: + - main + +permissions: {} +jobs: + lint: + runs-on: ubuntu-latest + + permissions: + contents: read + packages: read + statuses: write + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + # super-linter needs the full git history to get the + # list of files that changed across commits + fetch-depth: 0 + + - name: Lint Code Base + uses: super-linter/super-linter@v7.1.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: true + VALIDATE_CSS: false + VALIDATE_CSS_PRETTIER: false + VALIDATE_GIT_COMMITLINT: false + VALIDATE_HTML: false + VALIDATE_HTML_PRETTIER: false + VALIDATE_JAVASCRIPT_ES: false + VALIDATE_JAVASCRIPT_STANDARD: false + VALIDATE_JAVASCRIPT_PRETTIER: false + VALIDATE_TYPESCRIPT_ES: false + VALIDATE_TYPESCRIPT_STANDARD: false + VALIDATE_TYPESCRIPT_PRETTIER: false + VALIDATE_VUE: false +... diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..008f1f8 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[conduct@mockbukkit.org][conduct-mail]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations +[conduct-mail]: mailto:conduct@mockbukkit.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b568273 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,112 @@ +# Contributing to the Mockbukkit Documentation + +Thank you for your interest in contributing to our documentation! +We welcome contributions from the community to help improve and expand our documentation. + +## Getting Started + +### Prerequisites + +Before you start contributing, ensure you have the following prerequisites installed: + +- [Git](https://git-scm.com/) +- [Node.js](https://nodejs.org/) (version 18.x or higher) +- [pnpm](https://pnpm.io/) + +### Setting Up the Development Environment + +1. **Fork the Repository**: Start by forking the documentation repository to your own GitHub account. + +2. **Clone the Repository**: Next, clone the forked repository to your local machine. + + ```bash + git clone https://github.com/your-username/docs.git + ``` + +3. **Install Dependencies**: Install the necessary dependencies for the documentation project. + + ```bash + cd docs + pnpm install + ``` + +4. **Start the Development Server**: Start the Vitepress development server to preview your changes. + + ```bash + pnpm run docs:dev + ``` + + The development server will start, and you can access the documentation site at `http://localhost:5173`. + +## Making Changes + +1. **Create a New Branch**: Create a new branch for your changes. + + ```bash + git checkout -b my-feature-branch + ``` + +2. **Update the Documentation**: Make your changes to the documentation. This could include: + - Adding new pages + - Updating existing content + - Fixing typos or grammatical errors + - Improving the organization or structure of the documentation + - Adding new translations + +3. **Preview Your Changes**: Use the Vitepress development server to preview your changes and ensure they look as expected. + +4. **Commit and Push Your Changes**: Once you're satisfied with your changes, + commit them and push the branch to your forked repository. + + ```bash + git add . + git commit -m "Add a new guide for setting up the development environment" + git push origin my-feature-branch + ``` + +## Submitting a Pull Request + +1. **Create a Pull Request**: Go to the original repository on GitHub and create a new pull request, + comparing your feature branch with the main branch of the original repository. + +2. **Describe Your Changes**: In the pull request description, + provide a clear and concise explanation of the changes you've made and why they are valuable to the project. + +3. **Address Feedback**: The maintainers may request changes or provide feedback on your pull request. + Please be responsive to this feedback and make any necessary updates to your branch. + +## Coding Style and Guidelines + +- Follow the existing coding style and formatting used in the documentation repository. +- Ensure your changes are consistent with the overall tone and voice of the documentation. +- Make use of Vitepress's built-in features, such as frontmatter, custom components, and markdown extensions, where appropriate. +- Write clear and concise documentation that is easy for users to understand. + +### Code blocks + +For code blocks where multiple languages can be used, vitepress provides a way to +specify blocks for multiple languages. Use the following syntax: + +```md + ::: code-group + + ```java [Java] + // Java code goes here + ``` + + ```kotlin [Kotlin] + // Kotlin code goes here + ``` + + ::: +``` + +## Vitepress Markdown Extensions + +Vitepress provides a variety of markdown extensions that can be used to enhance the documentation. +You can find a list of available extensions in the [Vitepress documentation](https://vitepress.dev/guide/markdown). + +## Thank You + +We appreciate your contributions to the Mockbukkit documentation. +By working together, we can create high-quality, user-friendly documentation that benefits the entire community. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e9eef5f --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# Mockbukkit Docs + +This repository is the place where you can find the code for all documentation provided by the +MockBukkit project. The repository is published under [docs.mockbukkit.org](https://docs.mockbukkit.org). + +## Getting started + +This is how you can get started working on the docs on your local development machine. + +### Prerequisites: + +- [node](https://nodejs.org) +- [pnpm](https://pnpm.io/) + +### Building + +1. First, clone the repository: + + ```bash + git clone https://github.com/MockBukkit/docs.git + ``` + +2. Then, install the dependencies: + + ```bash + pnpm install + ``` + +3. Finally, run the server: + + ```bash + pnpm docs:dev // dev server + pnpm docs:build // build for production + ``` + +In the case of building for production, the site will be generated in the `.vitepress/dist` directory. + +### Previewing + +You can preview the site by running the following command: + +```bash +pnpm docs:preview +``` + +This will start a local server on port 5173. +You can then access the site at http://localhost:5173. + +## Contributing + +Contributions are welcome! Please read the [contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md) before submitting a pull request. + +## License + +The MockBukkit documentation is licensed under two licenses: + +- Docs: [Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE) +- Supporting Code: [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE) diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..795087c --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public +licenses to material it publishes and in those instances will be +considered the “Licensor.” The text of the Creative Commons public +licenses is dedicated to the public domain under the CC0 Public Domain +Dedication. Except for the limited purpose of indicating that material +is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the public +licenses. + +Creative Commons may be contacted at creativecommons.org. From 17e14aadf3960f3d35d0d2eced7ddb557423c666 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 19:45:27 +0100 Subject: [PATCH 2/8] fix(lint): start implementing lint fixes --- .github/workflows/build.yaml | 10 +++++----- .github/workflows/lint.yaml | 4 +++- CONTRIBUTING.md | 4 ++-- docs/en/contribution/maintainers/pr_guide.md | 6 +++--- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index dddde19..9aef57d 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -15,17 +15,17 @@ jobs: strategy: matrix: node-version: - - 18 - - 20 - - lts/* - - latest + - "18" + - "20" + - "lts/*" + - "latest" steps: - uses: actions/checkout@v4 - name: Get PNPM version from package.json id: pnpm-version shell: bash - run: echo "pnpm_version=$(node -p 'require(`./package.json`).engines.pnpm')" >> $GITHUB_OUTPUT + run: echo "pnpm_version=$(node -p "require('./package.json').engines.pnpm")" >> "$GITHUB_OUTPUT" - name: Install pnpm uses: pnpm/action-setup@v4 diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 00f9609..70f4dab 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -9,7 +9,9 @@ on: branches: - main -permissions: {} +permissions: + contents: read + jobs: lint: runs-on: ubuntu-latest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b568273..057c1f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,7 @@ Before you start contributing, ensure you have the following prerequisites insta - Follow the existing coding style and formatting used in the documentation repository. - Ensure your changes are consistent with the overall tone and voice of the documentation. -- Make use of Vitepress's built-in features, such as frontmatter, custom components, and markdown extensions, where appropriate. +- Make use of Vitepress's built-in features, such as frontmatter, custom components, and Markdown extensions, where appropriate. - Write clear and concise documentation that is easy for users to understand. ### Code blocks @@ -103,7 +103,7 @@ specify blocks for multiple languages. Use the following syntax: ## Vitepress Markdown Extensions -Vitepress provides a variety of markdown extensions that can be used to enhance the documentation. +Vitepress provides a variety of Markdown extensions that can be used to enhance the documentation. You can find a list of available extensions in the [Vitepress documentation](https://vitepress.dev/guide/markdown). ## Thank You diff --git a/docs/en/contribution/maintainers/pr_guide.md b/docs/en/contribution/maintainers/pr_guide.md index 69ef35e..8003f73 100644 --- a/docs/en/contribution/maintainers/pr_guide.md +++ b/docs/en/contribution/maintainers/pr_guide.md @@ -13,7 +13,7 @@ and attract new people to help drive this project forward! ::: -We use [Github Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) +We use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to automatically tag PRs with a version number on merge. This removes the tedious work of keeping version numbers up to date across several PRs at a time and eliminate Human error. The following custom labels, all of them following the pattern of `release/*`, are used by Mockbukkit: @@ -22,7 +22,7 @@ pattern of `release/*`, are used by Mockbukkit: |----------------------------------------------|:----------------------|:--|:---------------------------------------| | | Major Version (X.0.0) | | Only used for breaking changes | | | Minor Version (0.X.0) | | New Features | -| | Patch Version (0.0.X) | | Bug Fixes | +| | Patch Version (0.0.X) | | Bugfixes | | | None (-) | | Method Stubs or non code related fixes | -As you can probably tell, this project uses [Semantic Versioning](https://semver.org/). \ No newline at end of file +As you can probably tell, this project uses [Semantic Versioning](https://semver.org/). From d7ef2bc056d0a56bcd9d506ac5801305983e9a96 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 19:54:22 +0100 Subject: [PATCH 3/8] fix(lint): fix yaml files with prettier --- .github/workflows/build.yaml | 3 +- .github/workflows/lint.yaml | 1 - .prettierignore | 5 + .prettierrc | 1 + package.json | 7 +- pnpm-lock.yaml | 1549 +++++++++++++++++++++------------- 6 files changed, 980 insertions(+), 586 deletions(-) create mode 100644 .prettierignore create mode 100644 .prettierrc diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 9aef57d..42cf010 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -36,11 +36,10 @@ jobs: uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - cache: 'pnpm' + cache: "pnpm" - name: Install dependencies run: pnpm install - name: Build documentation run: pnpm run docs:build -... diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 70f4dab..8a667d1 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -46,4 +46,3 @@ jobs: VALIDATE_TYPESCRIPT_STANDARD: false VALIDATE_TYPESCRIPT_PRETTIER: false VALIDATE_VUE: false -... diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..5ca3287 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,5 @@ +# Ignore artifacts: +build +coverage +.vitepress/cache +.vitepress/dist diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/.prettierrc @@ -0,0 +1 @@ +{} diff --git a/package.json b/package.json index 11180ce..7bcf910 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,17 @@ { "devDependencies": { + "prettier": "3.3.3", "vitepress": "^1.3.1", "vue": "^3.4.34" }, "scripts": { "docs:dev": "vitepress dev", "docs:build": "vitepress build", - "docs:preview": "vitepress preview" + "docs:preview": "vitepress preview", + "lint:check": "prettier --check .", + "lint:fix": "prettier --write .", + "lint:fix:md": "prettier --write '**/*.md'", + "lint:fix:yaml": "prettier --write '**/*.{yml,yaml}'" }, "packageManager": "pnpm@9.12.2" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bfe8abf..98eae2d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,13 +1,15 @@ -lockfileVersion: '9.0' +lockfileVersion: "9.0" settings: autoInstallPeers: true excludeLinksFromLockfile: false importers: - .: devDependencies: + prettier: + specifier: 3.3.3 + version: 3.3.3 vitepress: specifier: ^1.3.1 version: 1.3.1(@algolia/client-search@4.24.0)(postcss@8.4.40)(search-insights@2.15.0) @@ -16,104 +18,181 @@ importers: version: 3.4.34 packages: - - '@algolia/autocomplete-core@1.9.3': - resolution: {integrity: sha512-009HdfugtGCdC4JdXUbVJClA0q0zh24yyePn+KUGk3rP7j8FEe/m5Yo/z65gn6nP/cM39PxpzqKrL7A6fP6PPw==} - - '@algolia/autocomplete-plugin-algolia-insights@1.9.3': - resolution: {integrity: sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==} + "@algolia/autocomplete-core@1.9.3": + resolution: + { + integrity: sha512-009HdfugtGCdC4JdXUbVJClA0q0zh24yyePn+KUGk3rP7j8FEe/m5Yo/z65gn6nP/cM39PxpzqKrL7A6fP6PPw==, + } + + "@algolia/autocomplete-plugin-algolia-insights@1.9.3": + resolution: + { + integrity: sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==, + } peerDependencies: - search-insights: '>= 1 < 3' + search-insights: ">= 1 < 3" - '@algolia/autocomplete-preset-algolia@1.9.3': - resolution: {integrity: sha512-d4qlt6YmrLMYy95n5TB52wtNDr6EgAIPH81dvvvW8UmuWRgxEtY0NJiPwl/h95JtG2vmRM804M0DSwMCNZlzRA==} + "@algolia/autocomplete-preset-algolia@1.9.3": + resolution: + { + integrity: sha512-d4qlt6YmrLMYy95n5TB52wtNDr6EgAIPH81dvvvW8UmuWRgxEtY0NJiPwl/h95JtG2vmRM804M0DSwMCNZlzRA==, + } peerDependencies: - '@algolia/client-search': '>= 4.9.1 < 6' - algoliasearch: '>= 4.9.1 < 6' - - '@algolia/autocomplete-shared@1.9.3': - resolution: {integrity: sha512-Wnm9E4Ye6Rl6sTTqjoymD+l8DjSTHsHboVRYrKgEt8Q7UHm9nYbqhN/i0fhUYA3OAEH7WA8x3jfpnmJm3rKvaQ==} + "@algolia/client-search": ">= 4.9.1 < 6" + algoliasearch: ">= 4.9.1 < 6" + + "@algolia/autocomplete-shared@1.9.3": + resolution: + { + integrity: sha512-Wnm9E4Ye6Rl6sTTqjoymD+l8DjSTHsHboVRYrKgEt8Q7UHm9nYbqhN/i0fhUYA3OAEH7WA8x3jfpnmJm3rKvaQ==, + } peerDependencies: - '@algolia/client-search': '>= 4.9.1 < 6' - algoliasearch: '>= 4.9.1 < 6' - - '@algolia/cache-browser-local-storage@4.24.0': - resolution: {integrity: sha512-t63W9BnoXVrGy9iYHBgObNXqYXM3tYXCjDSHeNwnsc324r4o5UiVKUiAB4THQ5z9U5hTj6qUvwg/Ez43ZD85ww==} - - '@algolia/cache-common@4.24.0': - resolution: {integrity: sha512-emi+v+DmVLpMGhp0V9q9h5CdkURsNmFC+cOS6uK9ndeJm9J4TiqSvPYVu+THUP8P/S08rxf5x2P+p3CfID0Y4g==} - - '@algolia/cache-in-memory@4.24.0': - resolution: {integrity: sha512-gDrt2so19jW26jY3/MkFg5mEypFIPbPoXsQGQWAi6TrCPsNOSEYepBMPlucqWigsmEy/prp5ug2jy/N3PVG/8w==} - - '@algolia/client-account@4.24.0': - resolution: {integrity: sha512-adcvyJ3KjPZFDybxlqnf+5KgxJtBjwTPTeyG2aOyoJvx0Y8dUQAEOEVOJ/GBxX0WWNbmaSrhDURMhc+QeevDsA==} - - '@algolia/client-analytics@4.24.0': - resolution: {integrity: sha512-y8jOZt1OjwWU4N2qr8G4AxXAzaa8DBvyHTWlHzX/7Me1LX8OayfgHexqrsL4vSBcoMmVw2XnVW9MhL+Y2ZDJXg==} - - '@algolia/client-common@4.24.0': - resolution: {integrity: sha512-bc2ROsNL6w6rqpl5jj/UywlIYC21TwSSoFHKl01lYirGMW+9Eek6r02Tocg4gZ8HAw3iBvu6XQiM3BEbmEMoiA==} - - '@algolia/client-personalization@4.24.0': - resolution: {integrity: sha512-l5FRFm/yngztweU0HdUzz1rC4yoWCFo3IF+dVIVTfEPg906eZg5BOd1k0K6rZx5JzyyoP4LdmOikfkfGsKVE9w==} - - '@algolia/client-search@4.24.0': - resolution: {integrity: sha512-uRW6EpNapmLAD0mW47OXqTP8eiIx5F6qN9/x/7HHO6owL3N1IXqydGwW5nhDFBrV+ldouro2W1VX3XlcUXEFCA==} - - '@algolia/logger-common@4.24.0': - resolution: {integrity: sha512-LLUNjkahj9KtKYrQhFKCzMx0BY3RnNP4FEtO+sBybCjJ73E8jNdaKJ/Dd8A/VA4imVHP5tADZ8pn5B8Ga/wTMA==} - - '@algolia/logger-console@4.24.0': - resolution: {integrity: sha512-X4C8IoHgHfiUROfoRCV+lzSy+LHMgkoEEU1BbKcsfnV0i0S20zyy0NLww9dwVHUWNfPPxdMU+/wKmLGYf96yTg==} - - '@algolia/recommend@4.24.0': - resolution: {integrity: sha512-P9kcgerfVBpfYHDfVZDvvdJv0lEoCvzNlOy2nykyt5bK8TyieYyiD0lguIJdRZZYGre03WIAFf14pgE+V+IBlw==} - - '@algolia/requester-browser-xhr@4.24.0': - resolution: {integrity: sha512-Z2NxZMb6+nVXSjF13YpjYTdvV3032YTBSGm2vnYvYPA6mMxzM3v5rsCiSspndn9rzIW4Qp1lPHBvuoKJV6jnAA==} - - '@algolia/requester-common@4.24.0': - resolution: {integrity: sha512-k3CXJ2OVnvgE3HMwcojpvY6d9kgKMPRxs/kVohrwF5WMr2fnqojnycZkxPoEg+bXm8fi5BBfFmOqgYztRtHsQA==} - - '@algolia/requester-node-http@4.24.0': - resolution: {integrity: sha512-JF18yTjNOVYvU/L3UosRcvbPMGT9B+/GQWNWnenIImglzNVGpyzChkXLnrSf6uxwVNO6ESGu6oN8MqcGQcjQJw==} - - '@algolia/transporter@4.24.0': - resolution: {integrity: sha512-86nI7w6NzWxd1Zp9q3413dRshDqAzSbsQjhcDhPIatEFiZrL1/TjnHL8S7jVKFePlIMzDsZWXAXwXzcok9c5oA==} - - '@babel/helper-string-parser@7.24.8': - resolution: {integrity: sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ==} - engines: {node: '>=6.9.0'} - - '@babel/helper-validator-identifier@7.24.7': - resolution: {integrity: sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==} - engines: {node: '>=6.9.0'} - - '@babel/parser@7.25.0': - resolution: {integrity: sha512-CzdIU9jdP0dg7HdyB+bHvDJGagUv+qtzZt5rYCWwW6tITNqV9odjp6Qu41gkG0ca5UfdDUWrKkiAnHHdGRnOrA==} - engines: {node: '>=6.0.0'} + "@algolia/client-search": ">= 4.9.1 < 6" + algoliasearch: ">= 4.9.1 < 6" + + "@algolia/cache-browser-local-storage@4.24.0": + resolution: + { + integrity: sha512-t63W9BnoXVrGy9iYHBgObNXqYXM3tYXCjDSHeNwnsc324r4o5UiVKUiAB4THQ5z9U5hTj6qUvwg/Ez43ZD85ww==, + } + + "@algolia/cache-common@4.24.0": + resolution: + { + integrity: sha512-emi+v+DmVLpMGhp0V9q9h5CdkURsNmFC+cOS6uK9ndeJm9J4TiqSvPYVu+THUP8P/S08rxf5x2P+p3CfID0Y4g==, + } + + "@algolia/cache-in-memory@4.24.0": + resolution: + { + integrity: sha512-gDrt2so19jW26jY3/MkFg5mEypFIPbPoXsQGQWAi6TrCPsNOSEYepBMPlucqWigsmEy/prp5ug2jy/N3PVG/8w==, + } + + "@algolia/client-account@4.24.0": + resolution: + { + integrity: sha512-adcvyJ3KjPZFDybxlqnf+5KgxJtBjwTPTeyG2aOyoJvx0Y8dUQAEOEVOJ/GBxX0WWNbmaSrhDURMhc+QeevDsA==, + } + + "@algolia/client-analytics@4.24.0": + resolution: + { + integrity: sha512-y8jOZt1OjwWU4N2qr8G4AxXAzaa8DBvyHTWlHzX/7Me1LX8OayfgHexqrsL4vSBcoMmVw2XnVW9MhL+Y2ZDJXg==, + } + + "@algolia/client-common@4.24.0": + resolution: + { + integrity: sha512-bc2ROsNL6w6rqpl5jj/UywlIYC21TwSSoFHKl01lYirGMW+9Eek6r02Tocg4gZ8HAw3iBvu6XQiM3BEbmEMoiA==, + } + + "@algolia/client-personalization@4.24.0": + resolution: + { + integrity: sha512-l5FRFm/yngztweU0HdUzz1rC4yoWCFo3IF+dVIVTfEPg906eZg5BOd1k0K6rZx5JzyyoP4LdmOikfkfGsKVE9w==, + } + + "@algolia/client-search@4.24.0": + resolution: + { + integrity: sha512-uRW6EpNapmLAD0mW47OXqTP8eiIx5F6qN9/x/7HHO6owL3N1IXqydGwW5nhDFBrV+ldouro2W1VX3XlcUXEFCA==, + } + + "@algolia/logger-common@4.24.0": + resolution: + { + integrity: sha512-LLUNjkahj9KtKYrQhFKCzMx0BY3RnNP4FEtO+sBybCjJ73E8jNdaKJ/Dd8A/VA4imVHP5tADZ8pn5B8Ga/wTMA==, + } + + "@algolia/logger-console@4.24.0": + resolution: + { + integrity: sha512-X4C8IoHgHfiUROfoRCV+lzSy+LHMgkoEEU1BbKcsfnV0i0S20zyy0NLww9dwVHUWNfPPxdMU+/wKmLGYf96yTg==, + } + + "@algolia/recommend@4.24.0": + resolution: + { + integrity: sha512-P9kcgerfVBpfYHDfVZDvvdJv0lEoCvzNlOy2nykyt5bK8TyieYyiD0lguIJdRZZYGre03WIAFf14pgE+V+IBlw==, + } + + "@algolia/requester-browser-xhr@4.24.0": + resolution: + { + integrity: sha512-Z2NxZMb6+nVXSjF13YpjYTdvV3032YTBSGm2vnYvYPA6mMxzM3v5rsCiSspndn9rzIW4Qp1lPHBvuoKJV6jnAA==, + } + + "@algolia/requester-common@4.24.0": + resolution: + { + integrity: sha512-k3CXJ2OVnvgE3HMwcojpvY6d9kgKMPRxs/kVohrwF5WMr2fnqojnycZkxPoEg+bXm8fi5BBfFmOqgYztRtHsQA==, + } + + "@algolia/requester-node-http@4.24.0": + resolution: + { + integrity: sha512-JF18yTjNOVYvU/L3UosRcvbPMGT9B+/GQWNWnenIImglzNVGpyzChkXLnrSf6uxwVNO6ESGu6oN8MqcGQcjQJw==, + } + + "@algolia/transporter@4.24.0": + resolution: + { + integrity: sha512-86nI7w6NzWxd1Zp9q3413dRshDqAzSbsQjhcDhPIatEFiZrL1/TjnHL8S7jVKFePlIMzDsZWXAXwXzcok9c5oA==, + } + + "@babel/helper-string-parser@7.24.8": + resolution: + { + integrity: sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ==, + } + engines: { node: ">=6.9.0" } + + "@babel/helper-validator-identifier@7.24.7": + resolution: + { + integrity: sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==, + } + engines: { node: ">=6.9.0" } + + "@babel/parser@7.25.0": + resolution: + { + integrity: sha512-CzdIU9jdP0dg7HdyB+bHvDJGagUv+qtzZt5rYCWwW6tITNqV9odjp6Qu41gkG0ca5UfdDUWrKkiAnHHdGRnOrA==, + } + engines: { node: ">=6.0.0" } hasBin: true - '@babel/types@7.25.0': - resolution: {integrity: sha512-LcnxQSsd9aXOIgmmSpvZ/1yo46ra2ESYyqLcryaBZOghxy5qqOBjvCWP5JfkI8yl9rlxRgdLTTMCQQRcN2hdCg==} - engines: {node: '>=6.9.0'} - - '@docsearch/css@3.6.1': - resolution: {integrity: sha512-VtVb5DS+0hRIprU2CO6ZQjK2Zg4QU5HrDM1+ix6rT0umsYvFvatMAnf97NHZlVWDaaLlx7GRfR/7FikANiM2Fg==} - - '@docsearch/js@3.6.1': - resolution: {integrity: sha512-erI3RRZurDr1xES5hvYJ3Imp7jtrXj6f1xYIzDzxiS7nNBufYWPbJwrmMqWC5g9y165PmxEmN9pklGCdLi0Iqg==} - - '@docsearch/react@3.6.1': - resolution: {integrity: sha512-qXZkEPvybVhSXj0K7U3bXc233tk5e8PfhoZ6MhPOiik/qUQxYC+Dn9DnoS7CxHQQhHfCvTiN0eY9M12oRghEXw==} + "@babel/types@7.25.0": + resolution: + { + integrity: sha512-LcnxQSsd9aXOIgmmSpvZ/1yo46ra2ESYyqLcryaBZOghxy5qqOBjvCWP5JfkI8yl9rlxRgdLTTMCQQRcN2hdCg==, + } + engines: { node: ">=6.9.0" } + + "@docsearch/css@3.6.1": + resolution: + { + integrity: sha512-VtVb5DS+0hRIprU2CO6ZQjK2Zg4QU5HrDM1+ix6rT0umsYvFvatMAnf97NHZlVWDaaLlx7GRfR/7FikANiM2Fg==, + } + + "@docsearch/js@3.6.1": + resolution: + { + integrity: sha512-erI3RRZurDr1xES5hvYJ3Imp7jtrXj6f1xYIzDzxiS7nNBufYWPbJwrmMqWC5g9y165PmxEmN9pklGCdLi0Iqg==, + } + + "@docsearch/react@3.6.1": + resolution: + { + integrity: sha512-qXZkEPvybVhSXj0K7U3bXc233tk5e8PfhoZ6MhPOiik/qUQxYC+Dn9DnoS7CxHQQhHfCvTiN0eY9M12oRghEXw==, + } peerDependencies: - '@types/react': '>= 16.8.0 < 19.0.0' - react: '>= 16.8.0 < 19.0.0' - react-dom: '>= 16.8.0 < 19.0.0' - search-insights: '>= 1 < 3' + "@types/react": ">= 16.8.0 < 19.0.0" + react: ">= 16.8.0 < 19.0.0" + react-dom: ">= 16.8.0 < 19.0.0" + search-insights: ">= 1 < 3" peerDependenciesMeta: - '@types/react': + "@types/react": optional: true react: optional: true @@ -122,304 +201,496 @@ packages: search-insights: optional: true - '@esbuild/aix-ppc64@0.21.5': - resolution: {integrity: sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==} - engines: {node: '>=12'} + "@esbuild/aix-ppc64@0.21.5": + resolution: + { + integrity: sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==, + } + engines: { node: ">=12" } cpu: [ppc64] os: [aix] - '@esbuild/android-arm64@0.21.5': - resolution: {integrity: sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==} - engines: {node: '>=12'} + "@esbuild/android-arm64@0.21.5": + resolution: + { + integrity: sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==, + } + engines: { node: ">=12" } cpu: [arm64] os: [android] - '@esbuild/android-arm@0.21.5': - resolution: {integrity: sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==} - engines: {node: '>=12'} + "@esbuild/android-arm@0.21.5": + resolution: + { + integrity: sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==, + } + engines: { node: ">=12" } cpu: [arm] os: [android] - '@esbuild/android-x64@0.21.5': - resolution: {integrity: sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==} - engines: {node: '>=12'} + "@esbuild/android-x64@0.21.5": + resolution: + { + integrity: sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==, + } + engines: { node: ">=12" } cpu: [x64] os: [android] - '@esbuild/darwin-arm64@0.21.5': - resolution: {integrity: sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==} - engines: {node: '>=12'} + "@esbuild/darwin-arm64@0.21.5": + resolution: + { + integrity: sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==, + } + engines: { node: ">=12" } cpu: [arm64] os: [darwin] - '@esbuild/darwin-x64@0.21.5': - resolution: {integrity: sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==} - engines: {node: '>=12'} + "@esbuild/darwin-x64@0.21.5": + resolution: + { + integrity: sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==, + } + engines: { node: ">=12" } cpu: [x64] os: [darwin] - '@esbuild/freebsd-arm64@0.21.5': - resolution: {integrity: sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==} - engines: {node: '>=12'} + "@esbuild/freebsd-arm64@0.21.5": + resolution: + { + integrity: sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==, + } + engines: { node: ">=12" } cpu: [arm64] os: [freebsd] - '@esbuild/freebsd-x64@0.21.5': - resolution: {integrity: sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==} - engines: {node: '>=12'} + "@esbuild/freebsd-x64@0.21.5": + resolution: + { + integrity: sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==, + } + engines: { node: ">=12" } cpu: [x64] os: [freebsd] - '@esbuild/linux-arm64@0.21.5': - resolution: {integrity: sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==} - engines: {node: '>=12'} + "@esbuild/linux-arm64@0.21.5": + resolution: + { + integrity: sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==, + } + engines: { node: ">=12" } cpu: [arm64] os: [linux] - '@esbuild/linux-arm@0.21.5': - resolution: {integrity: sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==} - engines: {node: '>=12'} + "@esbuild/linux-arm@0.21.5": + resolution: + { + integrity: sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==, + } + engines: { node: ">=12" } cpu: [arm] os: [linux] - '@esbuild/linux-ia32@0.21.5': - resolution: {integrity: sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==} - engines: {node: '>=12'} + "@esbuild/linux-ia32@0.21.5": + resolution: + { + integrity: sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==, + } + engines: { node: ">=12" } cpu: [ia32] os: [linux] - '@esbuild/linux-loong64@0.21.5': - resolution: {integrity: sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==} - engines: {node: '>=12'} + "@esbuild/linux-loong64@0.21.5": + resolution: + { + integrity: sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==, + } + engines: { node: ">=12" } cpu: [loong64] os: [linux] - '@esbuild/linux-mips64el@0.21.5': - resolution: {integrity: sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==} - engines: {node: '>=12'} + "@esbuild/linux-mips64el@0.21.5": + resolution: + { + integrity: sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==, + } + engines: { node: ">=12" } cpu: [mips64el] os: [linux] - '@esbuild/linux-ppc64@0.21.5': - resolution: {integrity: sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==} - engines: {node: '>=12'} + "@esbuild/linux-ppc64@0.21.5": + resolution: + { + integrity: sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==, + } + engines: { node: ">=12" } cpu: [ppc64] os: [linux] - '@esbuild/linux-riscv64@0.21.5': - resolution: {integrity: sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==} - engines: {node: '>=12'} + "@esbuild/linux-riscv64@0.21.5": + resolution: + { + integrity: sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==, + } + engines: { node: ">=12" } cpu: [riscv64] os: [linux] - '@esbuild/linux-s390x@0.21.5': - resolution: {integrity: sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==} - engines: {node: '>=12'} + "@esbuild/linux-s390x@0.21.5": + resolution: + { + integrity: sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==, + } + engines: { node: ">=12" } cpu: [s390x] os: [linux] - '@esbuild/linux-x64@0.21.5': - resolution: {integrity: sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==} - engines: {node: '>=12'} + "@esbuild/linux-x64@0.21.5": + resolution: + { + integrity: sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==, + } + engines: { node: ">=12" } cpu: [x64] os: [linux] - '@esbuild/netbsd-x64@0.21.5': - resolution: {integrity: sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==} - engines: {node: '>=12'} + "@esbuild/netbsd-x64@0.21.5": + resolution: + { + integrity: sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==, + } + engines: { node: ">=12" } cpu: [x64] os: [netbsd] - '@esbuild/openbsd-x64@0.21.5': - resolution: {integrity: sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==} - engines: {node: '>=12'} + "@esbuild/openbsd-x64@0.21.5": + resolution: + { + integrity: sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==, + } + engines: { node: ">=12" } cpu: [x64] os: [openbsd] - '@esbuild/sunos-x64@0.21.5': - resolution: {integrity: sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==} - engines: {node: '>=12'} + "@esbuild/sunos-x64@0.21.5": + resolution: + { + integrity: sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==, + } + engines: { node: ">=12" } cpu: [x64] os: [sunos] - '@esbuild/win32-arm64@0.21.5': - resolution: {integrity: sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==} - engines: {node: '>=12'} + "@esbuild/win32-arm64@0.21.5": + resolution: + { + integrity: sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==, + } + engines: { node: ">=12" } cpu: [arm64] os: [win32] - '@esbuild/win32-ia32@0.21.5': - resolution: {integrity: sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==} - engines: {node: '>=12'} + "@esbuild/win32-ia32@0.21.5": + resolution: + { + integrity: sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==, + } + engines: { node: ">=12" } cpu: [ia32] os: [win32] - '@esbuild/win32-x64@0.21.5': - resolution: {integrity: sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==} - engines: {node: '>=12'} + "@esbuild/win32-x64@0.21.5": + resolution: + { + integrity: sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==, + } + engines: { node: ">=12" } cpu: [x64] os: [win32] - '@jridgewell/sourcemap-codec@1.5.0': - resolution: {integrity: sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==} - - '@rollup/rollup-android-arm-eabi@4.19.1': - resolution: {integrity: sha512-XzqSg714++M+FXhHfXpS1tDnNZNpgxxuGZWlRG/jSj+VEPmZ0yg6jV4E0AL3uyBKxO8mO3xtOsP5mQ+XLfrlww==} + "@jridgewell/sourcemap-codec@1.5.0": + resolution: + { + integrity: sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==, + } + + "@rollup/rollup-android-arm-eabi@4.19.1": + resolution: + { + integrity: sha512-XzqSg714++M+FXhHfXpS1tDnNZNpgxxuGZWlRG/jSj+VEPmZ0yg6jV4E0AL3uyBKxO8mO3xtOsP5mQ+XLfrlww==, + } cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.19.1': - resolution: {integrity: sha512-thFUbkHteM20BGShD6P08aungq4irbIZKUNbG70LN8RkO7YztcGPiKTTGZS7Kw+x5h8hOXs0i4OaHwFxlpQN6A==} + "@rollup/rollup-android-arm64@4.19.1": + resolution: + { + integrity: sha512-thFUbkHteM20BGShD6P08aungq4irbIZKUNbG70LN8RkO7YztcGPiKTTGZS7Kw+x5h8hOXs0i4OaHwFxlpQN6A==, + } cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.19.1': - resolution: {integrity: sha512-8o6eqeFZzVLia2hKPUZk4jdE3zW7LCcZr+MD18tXkgBBid3lssGVAYuox8x6YHoEPDdDa9ixTaStcmx88lio5Q==} + "@rollup/rollup-darwin-arm64@4.19.1": + resolution: + { + integrity: sha512-8o6eqeFZzVLia2hKPUZk4jdE3zW7LCcZr+MD18tXkgBBid3lssGVAYuox8x6YHoEPDdDa9ixTaStcmx88lio5Q==, + } cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.19.1': - resolution: {integrity: sha512-4T42heKsnbjkn7ovYiAdDVRRWZLU9Kmhdt6HafZxFcUdpjlBlxj4wDrt1yFWLk7G4+E+8p2C9tcmSu0KA6auGA==} + "@rollup/rollup-darwin-x64@4.19.1": + resolution: + { + integrity: sha512-4T42heKsnbjkn7ovYiAdDVRRWZLU9Kmhdt6HafZxFcUdpjlBlxj4wDrt1yFWLk7G4+E+8p2C9tcmSu0KA6auGA==, + } cpu: [x64] os: [darwin] - '@rollup/rollup-linux-arm-gnueabihf@4.19.1': - resolution: {integrity: sha512-MXg1xp+e5GhZ3Vit1gGEyoC+dyQUBy2JgVQ+3hUrD9wZMkUw/ywgkpK7oZgnB6kPpGrxJ41clkPPnsknuD6M2Q==} + "@rollup/rollup-linux-arm-gnueabihf@4.19.1": + resolution: + { + integrity: sha512-MXg1xp+e5GhZ3Vit1gGEyoC+dyQUBy2JgVQ+3hUrD9wZMkUw/ywgkpK7oZgnB6kPpGrxJ41clkPPnsknuD6M2Q==, + } cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.19.1': - resolution: {integrity: sha512-DZNLwIY4ftPSRVkJEaxYkq7u2zel7aah57HESuNkUnz+3bZHxwkCUkrfS2IWC1sxK6F2QNIR0Qr/YXw7nkF3Pw==} + "@rollup/rollup-linux-arm-musleabihf@4.19.1": + resolution: + { + integrity: sha512-DZNLwIY4ftPSRVkJEaxYkq7u2zel7aah57HESuNkUnz+3bZHxwkCUkrfS2IWC1sxK6F2QNIR0Qr/YXw7nkF3Pw==, + } cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.19.1': - resolution: {integrity: sha512-C7evongnjyxdngSDRRSQv5GvyfISizgtk9RM+z2biV5kY6S/NF/wta7K+DanmktC5DkuaJQgoKGf7KUDmA7RUw==} + "@rollup/rollup-linux-arm64-gnu@4.19.1": + resolution: + { + integrity: sha512-C7evongnjyxdngSDRRSQv5GvyfISizgtk9RM+z2biV5kY6S/NF/wta7K+DanmktC5DkuaJQgoKGf7KUDmA7RUw==, + } cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.19.1': - resolution: {integrity: sha512-89tFWqxfxLLHkAthAcrTs9etAoBFRduNfWdl2xUs/yLV+7XDrJ5yuXMHptNqf1Zw0UCA3cAutkAiAokYCkaPtw==} + "@rollup/rollup-linux-arm64-musl@4.19.1": + resolution: + { + integrity: sha512-89tFWqxfxLLHkAthAcrTs9etAoBFRduNfWdl2xUs/yLV+7XDrJ5yuXMHptNqf1Zw0UCA3cAutkAiAokYCkaPtw==, + } cpu: [arm64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.19.1': - resolution: {integrity: sha512-PromGeV50sq+YfaisG8W3fd+Cl6mnOOiNv2qKKqKCpiiEke2KiKVyDqG/Mb9GWKbYMHj5a01fq/qlUR28PFhCQ==} + "@rollup/rollup-linux-powerpc64le-gnu@4.19.1": + resolution: + { + integrity: sha512-PromGeV50sq+YfaisG8W3fd+Cl6mnOOiNv2qKKqKCpiiEke2KiKVyDqG/Mb9GWKbYMHj5a01fq/qlUR28PFhCQ==, + } cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.19.1': - resolution: {integrity: sha512-/1BmHYh+iz0cNCP0oHCuF8CSiNj0JOGf0jRlSo3L/FAyZyG2rGBuKpkZVH9YF+x58r1jgWxvm1aRg3DHrLDt6A==} + "@rollup/rollup-linux-riscv64-gnu@4.19.1": + resolution: + { + integrity: sha512-/1BmHYh+iz0cNCP0oHCuF8CSiNj0JOGf0jRlSo3L/FAyZyG2rGBuKpkZVH9YF+x58r1jgWxvm1aRg3DHrLDt6A==, + } cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.19.1': - resolution: {integrity: sha512-0cYP5rGkQWRZKy9/HtsWVStLXzCF3cCBTRI+qRL8Z+wkYlqN7zrSYm6FuY5Kd5ysS5aH0q5lVgb/WbG4jqXN1Q==} + "@rollup/rollup-linux-s390x-gnu@4.19.1": + resolution: + { + integrity: sha512-0cYP5rGkQWRZKy9/HtsWVStLXzCF3cCBTRI+qRL8Z+wkYlqN7zrSYm6FuY5Kd5ysS5aH0q5lVgb/WbG4jqXN1Q==, + } cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.19.1': - resolution: {integrity: sha512-XUXeI9eM8rMP8aGvii/aOOiMvTs7xlCosq9xCjcqI9+5hBxtjDpD+7Abm1ZhVIFE1J2h2VIg0t2DX/gjespC2Q==} + "@rollup/rollup-linux-x64-gnu@4.19.1": + resolution: + { + integrity: sha512-XUXeI9eM8rMP8aGvii/aOOiMvTs7xlCosq9xCjcqI9+5hBxtjDpD+7Abm1ZhVIFE1J2h2VIg0t2DX/gjespC2Q==, + } cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.19.1': - resolution: {integrity: sha512-V7cBw/cKXMfEVhpSvVZhC+iGifD6U1zJ4tbibjjN+Xi3blSXaj/rJynAkCFFQfoG6VZrAiP7uGVzL440Q6Me2Q==} + "@rollup/rollup-linux-x64-musl@4.19.1": + resolution: + { + integrity: sha512-V7cBw/cKXMfEVhpSvVZhC+iGifD6U1zJ4tbibjjN+Xi3blSXaj/rJynAkCFFQfoG6VZrAiP7uGVzL440Q6Me2Q==, + } cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.19.1': - resolution: {integrity: sha512-88brja2vldW/76jWATlBqHEoGjJLRnP0WOEKAUbMcXaAZnemNhlAHSyj4jIwMoP2T750LE9lblvD4e2jXleZsA==} + "@rollup/rollup-win32-arm64-msvc@4.19.1": + resolution: + { + integrity: sha512-88brja2vldW/76jWATlBqHEoGjJLRnP0WOEKAUbMcXaAZnemNhlAHSyj4jIwMoP2T750LE9lblvD4e2jXleZsA==, + } cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.19.1': - resolution: {integrity: sha512-LdxxcqRVSXi6k6JUrTah1rHuaupoeuiv38du8Mt4r4IPer3kwlTo+RuvfE8KzZ/tL6BhaPlzJ3835i6CxrFIRQ==} + "@rollup/rollup-win32-ia32-msvc@4.19.1": + resolution: + { + integrity: sha512-LdxxcqRVSXi6k6JUrTah1rHuaupoeuiv38du8Mt4r4IPer3kwlTo+RuvfE8KzZ/tL6BhaPlzJ3835i6CxrFIRQ==, + } cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.19.1': - resolution: {integrity: sha512-2bIrL28PcK3YCqD9anGxDxamxdiJAxA+l7fWIwM5o8UqNy1t3d1NdAweO2XhA0KTDJ5aH1FsuiT5+7VhtHliXg==} + "@rollup/rollup-win32-x64-msvc@4.19.1": + resolution: + { + integrity: sha512-2bIrL28PcK3YCqD9anGxDxamxdiJAxA+l7fWIwM5o8UqNy1t3d1NdAweO2XhA0KTDJ5aH1FsuiT5+7VhtHliXg==, + } cpu: [x64] os: [win32] - '@shikijs/core@1.12.0': - resolution: {integrity: sha512-mc1cLbm6UQ8RxLc0dZES7v5rkH+99LxQp/ZvTqV3NLyYsO/fD6JhEflP1H5b2SDq9gI0+0G36AVZWxvounfR9w==} - - '@shikijs/transformers@1.12.0': - resolution: {integrity: sha512-ZS6RzDCWbnDljViMaeuraGaoMesCzDxzO2Slhpvic6j+Wqq4RXfQgb2ITTSrtBjv2HGCLP22mvXydtWCOKea8g==} - - '@types/estree@1.0.5': - resolution: {integrity: sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==} - - '@types/hast@3.0.4': - resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==} - - '@types/linkify-it@5.0.0': - resolution: {integrity: sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==} - - '@types/markdown-it@14.1.2': - resolution: {integrity: sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==} - - '@types/mdurl@2.0.0': - resolution: {integrity: sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==} - - '@types/unist@3.0.2': - resolution: {integrity: sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==} - - '@types/web-bluetooth@0.0.20': - resolution: {integrity: sha512-g9gZnnXVq7gM7v3tJCWV/qw7w+KeOlSHAhgF9RytFyifW6AF61hdT2ucrYhPq9hLs5JIryeupHV3qGk95dH9ow==} - - '@vitejs/plugin-vue@5.1.1': - resolution: {integrity: sha512-sDckXxlHpMsjRQbAH9WanangrfrblsOd3pNifePs+FOHjJg1jfWq5L/P0PsBRndEt3nmdUnmvieP8ULDeX5AvA==} - engines: {node: ^18.0.0 || >=20.0.0} + "@shikijs/core@1.12.0": + resolution: + { + integrity: sha512-mc1cLbm6UQ8RxLc0dZES7v5rkH+99LxQp/ZvTqV3NLyYsO/fD6JhEflP1H5b2SDq9gI0+0G36AVZWxvounfR9w==, + } + + "@shikijs/transformers@1.12.0": + resolution: + { + integrity: sha512-ZS6RzDCWbnDljViMaeuraGaoMesCzDxzO2Slhpvic6j+Wqq4RXfQgb2ITTSrtBjv2HGCLP22mvXydtWCOKea8g==, + } + + "@types/estree@1.0.5": + resolution: + { + integrity: sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==, + } + + "@types/hast@3.0.4": + resolution: + { + integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==, + } + + "@types/linkify-it@5.0.0": + resolution: + { + integrity: sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==, + } + + "@types/markdown-it@14.1.2": + resolution: + { + integrity: sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==, + } + + "@types/mdurl@2.0.0": + resolution: + { + integrity: sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==, + } + + "@types/unist@3.0.2": + resolution: + { + integrity: sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==, + } + + "@types/web-bluetooth@0.0.20": + resolution: + { + integrity: sha512-g9gZnnXVq7gM7v3tJCWV/qw7w+KeOlSHAhgF9RytFyifW6AF61hdT2ucrYhPq9hLs5JIryeupHV3qGk95dH9ow==, + } + + "@vitejs/plugin-vue@5.1.1": + resolution: + { + integrity: sha512-sDckXxlHpMsjRQbAH9WanangrfrblsOd3pNifePs+FOHjJg1jfWq5L/P0PsBRndEt3nmdUnmvieP8ULDeX5AvA==, + } + engines: { node: ^18.0.0 || >=20.0.0 } peerDependencies: vite: ^5.0.0 vue: ^3.2.25 - '@vue/compiler-core@3.4.34': - resolution: {integrity: sha512-Z0izUf32+wAnQewjHu+pQf1yw00EGOmevl1kE+ljjjMe7oEfpQ+BI3/JNK7yMB4IrUsqLDmPecUrpj3mCP+yJQ==} - - '@vue/compiler-dom@3.4.34': - resolution: {integrity: sha512-3PUOTS1h5cskdOJMExCu2TInXuM0j60DRPpSCJDqOCupCfUZCJoyQmKtRmA8EgDNZ5kcEE7vketamRZfrEuVDw==} - - '@vue/compiler-sfc@3.4.34': - resolution: {integrity: sha512-x6lm0UrM03jjDXTPZgD9Ad8bIVD1ifWNit2EaWQIZB5CULr46+FbLQ5RpK7AXtDHGjx9rmvC7QRCTjsiGkAwRw==} - - '@vue/compiler-ssr@3.4.34': - resolution: {integrity: sha512-8TDBcLaTrFm5rnF+Qm4BlliaopJgqJ28Nsrc80qazynm5aJO+Emu7y0RWw34L8dNnTRdcVBpWzJxhGYzsoVu4g==} - - '@vue/devtools-api@7.3.7': - resolution: {integrity: sha512-kvjQ6nmsqTp7SrmpwI2G0MgbC4ys0bPsgQirHXJM8y1m7siQ5RnWQUHJVfyUrHNguCySW1cevAdIw87zrPTl9g==} - - '@vue/devtools-kit@7.3.7': - resolution: {integrity: sha512-ktHhhjI4CoUrwdSUF5b/MFfjrtAtK8r4vhOkFyRN5Yp9kdXTwsRBYcwarHuP+wFPKf4/KM7DVBj2ELO8SBwdsw==} - - '@vue/devtools-shared@7.3.7': - resolution: {integrity: sha512-M9EU1/bWi5GNS/+IZrAhwGOVZmUTN4MH22Hvh35nUZZg9AZP2R2OhfCb+MG4EtAsrUEYlu3R43/SIj3G7EZYtQ==} - - '@vue/reactivity@3.4.34': - resolution: {integrity: sha512-ua+Lo+wBRlBEX9TtgPOShE2JwIO7p6BTZ7t1KZVPoaBRfqbC7N3c8Mpzicx173fXxx5VXeU6ykiHo7WgLzJQDA==} - - '@vue/runtime-core@3.4.34': - resolution: {integrity: sha512-PXhkiRPwcPGJ1BnyBZFI96GfInCVskd0HPNIAZn7i3YOmLbtbTZpB7/kDTwC1W7IqdGPkTVC63IS7J2nZs4Ebg==} - - '@vue/runtime-dom@3.4.34': - resolution: {integrity: sha512-dXqIe+RqFAK2Euak4UsvbIupalrhc67OuQKpD7HJ3W2fv8jlqvI7szfBCsAEcE8o/wyNpkloxB6J8viuF/E3gw==} - - '@vue/server-renderer@3.4.34': - resolution: {integrity: sha512-GeyEUfMVRZMD/mZcNONEqg7MiU10QQ1DB3O/Qr6+8uXpbwdlmVgQ5Qs1/ZUAFX1X2UUtqMoGrDRbxdWfOJFT7Q==} + "@vue/compiler-core@3.4.34": + resolution: + { + integrity: sha512-Z0izUf32+wAnQewjHu+pQf1yw00EGOmevl1kE+ljjjMe7oEfpQ+BI3/JNK7yMB4IrUsqLDmPecUrpj3mCP+yJQ==, + } + + "@vue/compiler-dom@3.4.34": + resolution: + { + integrity: sha512-3PUOTS1h5cskdOJMExCu2TInXuM0j60DRPpSCJDqOCupCfUZCJoyQmKtRmA8EgDNZ5kcEE7vketamRZfrEuVDw==, + } + + "@vue/compiler-sfc@3.4.34": + resolution: + { + integrity: sha512-x6lm0UrM03jjDXTPZgD9Ad8bIVD1ifWNit2EaWQIZB5CULr46+FbLQ5RpK7AXtDHGjx9rmvC7QRCTjsiGkAwRw==, + } + + "@vue/compiler-ssr@3.4.34": + resolution: + { + integrity: sha512-8TDBcLaTrFm5rnF+Qm4BlliaopJgqJ28Nsrc80qazynm5aJO+Emu7y0RWw34L8dNnTRdcVBpWzJxhGYzsoVu4g==, + } + + "@vue/devtools-api@7.3.7": + resolution: + { + integrity: sha512-kvjQ6nmsqTp7SrmpwI2G0MgbC4ys0bPsgQirHXJM8y1m7siQ5RnWQUHJVfyUrHNguCySW1cevAdIw87zrPTl9g==, + } + + "@vue/devtools-kit@7.3.7": + resolution: + { + integrity: sha512-ktHhhjI4CoUrwdSUF5b/MFfjrtAtK8r4vhOkFyRN5Yp9kdXTwsRBYcwarHuP+wFPKf4/KM7DVBj2ELO8SBwdsw==, + } + + "@vue/devtools-shared@7.3.7": + resolution: + { + integrity: sha512-M9EU1/bWi5GNS/+IZrAhwGOVZmUTN4MH22Hvh35nUZZg9AZP2R2OhfCb+MG4EtAsrUEYlu3R43/SIj3G7EZYtQ==, + } + + "@vue/reactivity@3.4.34": + resolution: + { + integrity: sha512-ua+Lo+wBRlBEX9TtgPOShE2JwIO7p6BTZ7t1KZVPoaBRfqbC7N3c8Mpzicx173fXxx5VXeU6ykiHo7WgLzJQDA==, + } + + "@vue/runtime-core@3.4.34": + resolution: + { + integrity: sha512-PXhkiRPwcPGJ1BnyBZFI96GfInCVskd0HPNIAZn7i3YOmLbtbTZpB7/kDTwC1W7IqdGPkTVC63IS7J2nZs4Ebg==, + } + + "@vue/runtime-dom@3.4.34": + resolution: + { + integrity: sha512-dXqIe+RqFAK2Euak4UsvbIupalrhc67OuQKpD7HJ3W2fv8jlqvI7szfBCsAEcE8o/wyNpkloxB6J8viuF/E3gw==, + } + + "@vue/server-renderer@3.4.34": + resolution: + { + integrity: sha512-GeyEUfMVRZMD/mZcNONEqg7MiU10QQ1DB3O/Qr6+8uXpbwdlmVgQ5Qs1/ZUAFX1X2UUtqMoGrDRbxdWfOJFT7Q==, + } peerDependencies: vue: 3.4.34 - '@vue/shared@3.4.34': - resolution: {integrity: sha512-x5LmiRLpRsd9KTjAB8MPKf0CDPMcuItjP0gbNqFCIgL1I8iYp4zglhj9w9FPCdIbHG2M91RVeIbArFfFTz9I3A==} - - '@vueuse/core@10.11.0': - resolution: {integrity: sha512-x3sD4Mkm7PJ+pcq3HX8PLPBadXCAlSDR/waK87dz0gQE+qJnaaFhc/dZVfJz+IUYzTMVGum2QlR7ImiJQN4s6g==} - - '@vueuse/integrations@10.11.0': - resolution: {integrity: sha512-Pp6MtWEIr+NDOccWd8j59Kpjy5YDXogXI61Kb1JxvSfVBO8NzFQkmrKmSZz47i+ZqHnIzxaT38L358yDHTncZg==} + "@vue/shared@3.4.34": + resolution: + { + integrity: sha512-x5LmiRLpRsd9KTjAB8MPKf0CDPMcuItjP0gbNqFCIgL1I8iYp4zglhj9w9FPCdIbHG2M91RVeIbArFfFTz9I3A==, + } + + "@vueuse/core@10.11.0": + resolution: + { + integrity: sha512-x3sD4Mkm7PJ+pcq3HX8PLPBadXCAlSDR/waK87dz0gQE+qJnaaFhc/dZVfJz+IUYzTMVGum2QlR7ImiJQN4s6g==, + } + + "@vueuse/integrations@10.11.0": + resolution: + { + integrity: sha512-Pp6MtWEIr+NDOccWd8j59Kpjy5YDXogXI61Kb1JxvSfVBO8NzFQkmrKmSZz47i+ZqHnIzxaT38L358yDHTncZg==, + } peerDependencies: async-validator: ^4 axios: ^1 @@ -459,129 +730,233 @@ packages: universal-cookie: optional: true - '@vueuse/metadata@10.11.0': - resolution: {integrity: sha512-kQX7l6l8dVWNqlqyN3ePW3KmjCQO3ZMgXuBMddIu83CmucrsBfXlH+JoviYyRBws/yLTQO8g3Pbw+bdIoVm4oQ==} + "@vueuse/metadata@10.11.0": + resolution: + { + integrity: sha512-kQX7l6l8dVWNqlqyN3ePW3KmjCQO3ZMgXuBMddIu83CmucrsBfXlH+JoviYyRBws/yLTQO8g3Pbw+bdIoVm4oQ==, + } - '@vueuse/shared@10.11.0': - resolution: {integrity: sha512-fyNoIXEq3PfX1L3NkNhtVQUSRtqYwJtJg+Bp9rIzculIZWHTkKSysujrOk2J+NrRulLTQH9+3gGSfYLWSEWU1A==} + "@vueuse/shared@10.11.0": + resolution: + { + integrity: sha512-fyNoIXEq3PfX1L3NkNhtVQUSRtqYwJtJg+Bp9rIzculIZWHTkKSysujrOk2J+NrRulLTQH9+3gGSfYLWSEWU1A==, + } algoliasearch@4.24.0: - resolution: {integrity: sha512-bf0QV/9jVejssFBmz2HQLxUadxk574t4iwjCKp5E7NBzwKkrDEhKPISIIjAU/p6K5qDx3qoeh4+26zWN1jmw3g==} + resolution: + { + integrity: sha512-bf0QV/9jVejssFBmz2HQLxUadxk574t4iwjCKp5E7NBzwKkrDEhKPISIIjAU/p6K5qDx3qoeh4+26zWN1jmw3g==, + } birpc@0.2.17: - resolution: {integrity: sha512-+hkTxhot+dWsLpp3gia5AkVHIsKlZybNT5gIYiDlNzJrmYPcTM9k5/w2uaj3IPpd7LlEYpmCj4Jj1nC41VhDFg==} + resolution: + { + integrity: sha512-+hkTxhot+dWsLpp3gia5AkVHIsKlZybNT5gIYiDlNzJrmYPcTM9k5/w2uaj3IPpd7LlEYpmCj4Jj1nC41VhDFg==, + } copy-anything@3.0.5: - resolution: {integrity: sha512-yCEafptTtb4bk7GLEQoM8KVJpxAfdBJYaXyzQEgQQQgYrZiDp8SJmGKlYza6CYjEDNstAdNdKA3UuoULlEbS6w==} - engines: {node: '>=12.13'} + resolution: + { + integrity: sha512-yCEafptTtb4bk7GLEQoM8KVJpxAfdBJYaXyzQEgQQQgYrZiDp8SJmGKlYza6CYjEDNstAdNdKA3UuoULlEbS6w==, + } + engines: { node: ">=12.13" } csstype@3.1.3: - resolution: {integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==} + resolution: + { + integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==, + } entities@4.5.0: - resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} - engines: {node: '>=0.12'} + resolution: + { + integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==, + } + engines: { node: ">=0.12" } esbuild@0.21.5: - resolution: {integrity: sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==} - engines: {node: '>=12'} + resolution: + { + integrity: sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==, + } + engines: { node: ">=12" } hasBin: true estree-walker@2.0.2: - resolution: {integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==} + resolution: + { + integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==, + } focus-trap@7.5.4: - resolution: {integrity: sha512-N7kHdlgsO/v+iD/dMoJKtsSqs5Dz/dXZVebRgJw23LDk+jMi/974zyiOYDziY2JPp8xivq9BmUGwIJMiuSBi7w==} + resolution: + { + integrity: sha512-N7kHdlgsO/v+iD/dMoJKtsSqs5Dz/dXZVebRgJw23LDk+jMi/974zyiOYDziY2JPp8xivq9BmUGwIJMiuSBi7w==, + } fsevents@2.3.3: - resolution: {integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==} - engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + resolution: + { + integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==, + } + engines: { node: ^8.16.0 || ^10.6.0 || >=11.0.0 } os: [darwin] hookable@5.5.3: - resolution: {integrity: sha512-Yc+BQe8SvoXH1643Qez1zqLRmbA5rCL+sSmk6TVos0LWVfNIB7PGncdlId77WzLGSIB5KaWgTaNTs2lNVEI6VQ==} + resolution: + { + integrity: sha512-Yc+BQe8SvoXH1643Qez1zqLRmbA5rCL+sSmk6TVos0LWVfNIB7PGncdlId77WzLGSIB5KaWgTaNTs2lNVEI6VQ==, + } is-what@4.1.16: - resolution: {integrity: sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==} - engines: {node: '>=12.13'} + resolution: + { + integrity: sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==, + } + engines: { node: ">=12.13" } magic-string@0.30.11: - resolution: {integrity: sha512-+Wri9p0QHMy+545hKww7YAu5NyzF8iomPL/RQazugQ9+Ez4Ic3mERMd8ZTX5rfK944j+560ZJi8iAwgak1Ac7A==} + resolution: + { + integrity: sha512-+Wri9p0QHMy+545hKww7YAu5NyzF8iomPL/RQazugQ9+Ez4Ic3mERMd8ZTX5rfK944j+560ZJi8iAwgak1Ac7A==, + } mark.js@8.11.1: - resolution: {integrity: sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==} + resolution: + { + integrity: sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==, + } minisearch@7.1.0: - resolution: {integrity: sha512-tv7c/uefWdEhcu6hvrfTihflgeEi2tN6VV7HJnCjK6VxM75QQJh4t9FwJCsA2EsRS8LCnu3W87CuGPWMocOLCA==} + resolution: + { + integrity: sha512-tv7c/uefWdEhcu6hvrfTihflgeEi2tN6VV7HJnCjK6VxM75QQJh4t9FwJCsA2EsRS8LCnu3W87CuGPWMocOLCA==, + } mitt@3.0.1: - resolution: {integrity: sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==} + resolution: + { + integrity: sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==, + } nanoid@3.3.7: - resolution: {integrity: sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==} - engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + resolution: + { + integrity: sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==, + } + engines: { node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1 } hasBin: true perfect-debounce@1.0.0: - resolution: {integrity: sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==} + resolution: + { + integrity: sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==, + } picocolors@1.0.1: - resolution: {integrity: sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==} + resolution: + { + integrity: sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==, + } postcss@8.4.40: - resolution: {integrity: sha512-YF2kKIUzAofPMpfH6hOi2cGnv/HrUlfucspc7pDyvv7kGdqXrfj8SCl/t8owkEgKEuu8ZcRjSOxFxVLqwChZ2Q==} - engines: {node: ^10 || ^12 || >=14} + resolution: + { + integrity: sha512-YF2kKIUzAofPMpfH6hOi2cGnv/HrUlfucspc7pDyvv7kGdqXrfj8SCl/t8owkEgKEuu8ZcRjSOxFxVLqwChZ2Q==, + } + engines: { node: ^10 || ^12 || >=14 } preact@10.23.1: - resolution: {integrity: sha512-O5UdRsNh4vdZaTieWe3XOgSpdMAmkIYBCT3VhQDlKrzyCm8lUYsk0fmVEvoQQifoOjFRTaHZO69ylrzTW2BH+A==} + resolution: + { + integrity: sha512-O5UdRsNh4vdZaTieWe3XOgSpdMAmkIYBCT3VhQDlKrzyCm8lUYsk0fmVEvoQQifoOjFRTaHZO69ylrzTW2BH+A==, + } + + prettier@3.3.3: + resolution: + { + integrity: sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==, + } + engines: { node: ">=14" } + hasBin: true rfdc@1.4.1: - resolution: {integrity: sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==} + resolution: + { + integrity: sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==, + } rollup@4.19.1: - resolution: {integrity: sha512-K5vziVlg7hTpYfFBI+91zHBEMo6jafYXpkMlqZjg7/zhIG9iHqazBf4xz9AVdjS9BruRn280ROqLI7G3OFRIlw==} - engines: {node: '>=18.0.0', npm: '>=8.0.0'} + resolution: + { + integrity: sha512-K5vziVlg7hTpYfFBI+91zHBEMo6jafYXpkMlqZjg7/zhIG9iHqazBf4xz9AVdjS9BruRn280ROqLI7G3OFRIlw==, + } + engines: { node: ">=18.0.0", npm: ">=8.0.0" } hasBin: true search-insights@2.15.0: - resolution: {integrity: sha512-ch2sPCUDD4sbPQdknVl9ALSi9H7VyoeVbsxznYz6QV55jJ8CI3EtwpO1i84keN4+hF5IeHWIeGvc08530JkVXQ==} + resolution: + { + integrity: sha512-ch2sPCUDD4sbPQdknVl9ALSi9H7VyoeVbsxznYz6QV55jJ8CI3EtwpO1i84keN4+hF5IeHWIeGvc08530JkVXQ==, + } shiki@1.12.0: - resolution: {integrity: sha512-BuAxWOm5JhRcbSOl7XCei8wGjgJJonnV0oipUupPY58iULxUGyHhW5CF+9FRMuM1pcJ5cGEJGll1LusX6FwpPA==} + resolution: + { + integrity: sha512-BuAxWOm5JhRcbSOl7XCei8wGjgJJonnV0oipUupPY58iULxUGyHhW5CF+9FRMuM1pcJ5cGEJGll1LusX6FwpPA==, + } source-map-js@1.2.0: - resolution: {integrity: sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==} - engines: {node: '>=0.10.0'} + resolution: + { + integrity: sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==, + } + engines: { node: ">=0.10.0" } speakingurl@14.0.1: - resolution: {integrity: sha512-1POYv7uv2gXoyGFpBCmpDVSNV74IfsWlDW216UPjbWufNf+bSU6GdbDsxdcxtfwb4xlI3yxzOTKClUosxARYrQ==} - engines: {node: '>=0.10.0'} + resolution: + { + integrity: sha512-1POYv7uv2gXoyGFpBCmpDVSNV74IfsWlDW216UPjbWufNf+bSU6GdbDsxdcxtfwb4xlI3yxzOTKClUosxARYrQ==, + } + engines: { node: ">=0.10.0" } superjson@2.2.1: - resolution: {integrity: sha512-8iGv75BYOa0xRJHK5vRLEjE2H/i4lulTjzpUXic3Eg8akftYjkmQDa8JARQ42rlczXyFR3IeRoeFCc7RxHsYZA==} - engines: {node: '>=16'} + resolution: + { + integrity: sha512-8iGv75BYOa0xRJHK5vRLEjE2H/i4lulTjzpUXic3Eg8akftYjkmQDa8JARQ42rlczXyFR3IeRoeFCc7RxHsYZA==, + } + engines: { node: ">=16" } tabbable@6.2.0: - resolution: {integrity: sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==} + resolution: + { + integrity: sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==, + } to-fast-properties@2.0.0: - resolution: {integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==} - engines: {node: '>=4'} + resolution: + { + integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==, + } + engines: { node: ">=4" } vite@5.3.5: - resolution: {integrity: sha512-MdjglKR6AQXQb9JGiS7Rc2wC6uMjcm7Go/NHNO63EwiJXfuk9PgqiP/n5IDJCziMkfw9n4Ubp7lttNwz+8ZVKA==} - engines: {node: ^18.0.0 || >=20.0.0} + resolution: + { + integrity: sha512-MdjglKR6AQXQb9JGiS7Rc2wC6uMjcm7Go/NHNO63EwiJXfuk9PgqiP/n5IDJCziMkfw9n4Ubp7lttNwz+8ZVKA==, + } + engines: { node: ^18.0.0 || >=20.0.0 } hasBin: true peerDependencies: - '@types/node': ^18.0.0 || >=20.0.0 - less: '*' + "@types/node": ^18.0.0 || >=20.0.0 + less: "*" lightningcss: ^1.21.0 - sass: '*' - stylus: '*' - sugarss: '*' + sass: "*" + stylus: "*" + sugarss: "*" terser: ^5.4.0 peerDependenciesMeta: - '@types/node': + "@types/node": optional: true less: optional: true @@ -597,7 +972,10 @@ packages: optional: true vitepress@1.3.1: - resolution: {integrity: sha512-soZDpg2rRVJNIM/IYMNDPPr+zTHDA5RbLDHAxacRu+Q9iZ2GwSR0QSUlLs+aEZTkG0SOX1dc8RmUYwyuxK8dfQ==} + resolution: + { + integrity: sha512-soZDpg2rRVJNIM/IYMNDPPr+zTHDA5RbLDHAxacRu+Q9iZ2GwSR0QSUlLs+aEZTkG0SOX1dc8RmUYwyuxK8dfQ==, + } hasBin: true peerDependencies: markdown-it-mathjax3: ^4 @@ -609,356 +987,361 @@ packages: optional: true vue-demi@0.14.10: - resolution: {integrity: sha512-nMZBOwuzabUO0nLgIcc6rycZEebF6eeUfaiQx9+WSk8e29IbLvPU9feI6tqW4kTo3hvoYAJkMh8n8D0fuISphg==} - engines: {node: '>=12'} + resolution: + { + integrity: sha512-nMZBOwuzabUO0nLgIcc6rycZEebF6eeUfaiQx9+WSk8e29IbLvPU9feI6tqW4kTo3hvoYAJkMh8n8D0fuISphg==, + } + engines: { node: ">=12" } hasBin: true peerDependencies: - '@vue/composition-api': ^1.0.0-rc.1 + "@vue/composition-api": ^1.0.0-rc.1 vue: ^3.0.0-0 || ^2.6.0 peerDependenciesMeta: - '@vue/composition-api': + "@vue/composition-api": optional: true vue@3.4.34: - resolution: {integrity: sha512-VZze05HWlA3ItreQ/ka7Sx7PoD0/3St8FEiSlSTVgb6l4hL+RjtP2/8g5WQBzZgyf8WG2f+g1bXzC7zggLhAJA==} + resolution: + { + integrity: sha512-VZze05HWlA3ItreQ/ka7Sx7PoD0/3St8FEiSlSTVgb6l4hL+RjtP2/8g5WQBzZgyf8WG2f+g1bXzC7zggLhAJA==, + } peerDependencies: - typescript: '*' + typescript: "*" peerDependenciesMeta: typescript: optional: true snapshots: - - '@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0)': + "@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0)": dependencies: - '@algolia/autocomplete-plugin-algolia-insights': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0) - '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) + "@algolia/autocomplete-plugin-algolia-insights": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0) + "@algolia/autocomplete-shared": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) transitivePeerDependencies: - - '@algolia/client-search' + - "@algolia/client-search" - algoliasearch - search-insights - '@algolia/autocomplete-plugin-algolia-insights@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0)': + "@algolia/autocomplete-plugin-algolia-insights@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0)": dependencies: - '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) + "@algolia/autocomplete-shared": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) search-insights: 2.15.0 transitivePeerDependencies: - - '@algolia/client-search' + - "@algolia/client-search" - algoliasearch - '@algolia/autocomplete-preset-algolia@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)': + "@algolia/autocomplete-preset-algolia@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)": dependencies: - '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) - '@algolia/client-search': 4.24.0 + "@algolia/autocomplete-shared": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) + "@algolia/client-search": 4.24.0 algoliasearch: 4.24.0 - '@algolia/autocomplete-shared@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)': + "@algolia/autocomplete-shared@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)": dependencies: - '@algolia/client-search': 4.24.0 + "@algolia/client-search": 4.24.0 algoliasearch: 4.24.0 - '@algolia/cache-browser-local-storage@4.24.0': + "@algolia/cache-browser-local-storage@4.24.0": dependencies: - '@algolia/cache-common': 4.24.0 + "@algolia/cache-common": 4.24.0 - '@algolia/cache-common@4.24.0': {} + "@algolia/cache-common@4.24.0": {} - '@algolia/cache-in-memory@4.24.0': + "@algolia/cache-in-memory@4.24.0": dependencies: - '@algolia/cache-common': 4.24.0 + "@algolia/cache-common": 4.24.0 - '@algolia/client-account@4.24.0': + "@algolia/client-account@4.24.0": dependencies: - '@algolia/client-common': 4.24.0 - '@algolia/client-search': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/client-search": 4.24.0 + "@algolia/transporter": 4.24.0 - '@algolia/client-analytics@4.24.0': + "@algolia/client-analytics@4.24.0": dependencies: - '@algolia/client-common': 4.24.0 - '@algolia/client-search': 4.24.0 - '@algolia/requester-common': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/client-search": 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/transporter": 4.24.0 - '@algolia/client-common@4.24.0': + "@algolia/client-common@4.24.0": dependencies: - '@algolia/requester-common': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/transporter": 4.24.0 - '@algolia/client-personalization@4.24.0': + "@algolia/client-personalization@4.24.0": dependencies: - '@algolia/client-common': 4.24.0 - '@algolia/requester-common': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/transporter": 4.24.0 - '@algolia/client-search@4.24.0': + "@algolia/client-search@4.24.0": dependencies: - '@algolia/client-common': 4.24.0 - '@algolia/requester-common': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/transporter": 4.24.0 - '@algolia/logger-common@4.24.0': {} + "@algolia/logger-common@4.24.0": {} - '@algolia/logger-console@4.24.0': + "@algolia/logger-console@4.24.0": dependencies: - '@algolia/logger-common': 4.24.0 + "@algolia/logger-common": 4.24.0 - '@algolia/recommend@4.24.0': + "@algolia/recommend@4.24.0": dependencies: - '@algolia/cache-browser-local-storage': 4.24.0 - '@algolia/cache-common': 4.24.0 - '@algolia/cache-in-memory': 4.24.0 - '@algolia/client-common': 4.24.0 - '@algolia/client-search': 4.24.0 - '@algolia/logger-common': 4.24.0 - '@algolia/logger-console': 4.24.0 - '@algolia/requester-browser-xhr': 4.24.0 - '@algolia/requester-common': 4.24.0 - '@algolia/requester-node-http': 4.24.0 - '@algolia/transporter': 4.24.0 - - '@algolia/requester-browser-xhr@4.24.0': + "@algolia/cache-browser-local-storage": 4.24.0 + "@algolia/cache-common": 4.24.0 + "@algolia/cache-in-memory": 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/client-search": 4.24.0 + "@algolia/logger-common": 4.24.0 + "@algolia/logger-console": 4.24.0 + "@algolia/requester-browser-xhr": 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/requester-node-http": 4.24.0 + "@algolia/transporter": 4.24.0 + + "@algolia/requester-browser-xhr@4.24.0": dependencies: - '@algolia/requester-common': 4.24.0 + "@algolia/requester-common": 4.24.0 - '@algolia/requester-common@4.24.0': {} + "@algolia/requester-common@4.24.0": {} - '@algolia/requester-node-http@4.24.0': + "@algolia/requester-node-http@4.24.0": dependencies: - '@algolia/requester-common': 4.24.0 + "@algolia/requester-common": 4.24.0 - '@algolia/transporter@4.24.0': + "@algolia/transporter@4.24.0": dependencies: - '@algolia/cache-common': 4.24.0 - '@algolia/logger-common': 4.24.0 - '@algolia/requester-common': 4.24.0 + "@algolia/cache-common": 4.24.0 + "@algolia/logger-common": 4.24.0 + "@algolia/requester-common": 4.24.0 - '@babel/helper-string-parser@7.24.8': {} + "@babel/helper-string-parser@7.24.8": {} - '@babel/helper-validator-identifier@7.24.7': {} + "@babel/helper-validator-identifier@7.24.7": {} - '@babel/parser@7.25.0': + "@babel/parser@7.25.0": dependencies: - '@babel/types': 7.25.0 + "@babel/types": 7.25.0 - '@babel/types@7.25.0': + "@babel/types@7.25.0": dependencies: - '@babel/helper-string-parser': 7.24.8 - '@babel/helper-validator-identifier': 7.24.7 + "@babel/helper-string-parser": 7.24.8 + "@babel/helper-validator-identifier": 7.24.7 to-fast-properties: 2.0.0 - '@docsearch/css@3.6.1': {} + "@docsearch/css@3.6.1": {} - '@docsearch/js@3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0)': + "@docsearch/js@3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0)": dependencies: - '@docsearch/react': 3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0) + "@docsearch/react": 3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0) preact: 10.23.1 transitivePeerDependencies: - - '@algolia/client-search' - - '@types/react' + - "@algolia/client-search" + - "@types/react" - react - react-dom - search-insights - '@docsearch/react@3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0)': + "@docsearch/react@3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0)": dependencies: - '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0) - '@algolia/autocomplete-preset-algolia': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) - '@docsearch/css': 3.6.1 + "@algolia/autocomplete-core": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.15.0) + "@algolia/autocomplete-preset-algolia": 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) + "@docsearch/css": 3.6.1 algoliasearch: 4.24.0 optionalDependencies: search-insights: 2.15.0 transitivePeerDependencies: - - '@algolia/client-search' + - "@algolia/client-search" - '@esbuild/aix-ppc64@0.21.5': + "@esbuild/aix-ppc64@0.21.5": optional: true - '@esbuild/android-arm64@0.21.5': + "@esbuild/android-arm64@0.21.5": optional: true - '@esbuild/android-arm@0.21.5': + "@esbuild/android-arm@0.21.5": optional: true - '@esbuild/android-x64@0.21.5': + "@esbuild/android-x64@0.21.5": optional: true - '@esbuild/darwin-arm64@0.21.5': + "@esbuild/darwin-arm64@0.21.5": optional: true - '@esbuild/darwin-x64@0.21.5': + "@esbuild/darwin-x64@0.21.5": optional: true - '@esbuild/freebsd-arm64@0.21.5': + "@esbuild/freebsd-arm64@0.21.5": optional: true - '@esbuild/freebsd-x64@0.21.5': + "@esbuild/freebsd-x64@0.21.5": optional: true - '@esbuild/linux-arm64@0.21.5': + "@esbuild/linux-arm64@0.21.5": optional: true - '@esbuild/linux-arm@0.21.5': + "@esbuild/linux-arm@0.21.5": optional: true - '@esbuild/linux-ia32@0.21.5': + "@esbuild/linux-ia32@0.21.5": optional: true - '@esbuild/linux-loong64@0.21.5': + "@esbuild/linux-loong64@0.21.5": optional: true - '@esbuild/linux-mips64el@0.21.5': + "@esbuild/linux-mips64el@0.21.5": optional: true - '@esbuild/linux-ppc64@0.21.5': + "@esbuild/linux-ppc64@0.21.5": optional: true - '@esbuild/linux-riscv64@0.21.5': + "@esbuild/linux-riscv64@0.21.5": optional: true - '@esbuild/linux-s390x@0.21.5': + "@esbuild/linux-s390x@0.21.5": optional: true - '@esbuild/linux-x64@0.21.5': + "@esbuild/linux-x64@0.21.5": optional: true - '@esbuild/netbsd-x64@0.21.5': + "@esbuild/netbsd-x64@0.21.5": optional: true - '@esbuild/openbsd-x64@0.21.5': + "@esbuild/openbsd-x64@0.21.5": optional: true - '@esbuild/sunos-x64@0.21.5': + "@esbuild/sunos-x64@0.21.5": optional: true - '@esbuild/win32-arm64@0.21.5': + "@esbuild/win32-arm64@0.21.5": optional: true - '@esbuild/win32-ia32@0.21.5': + "@esbuild/win32-ia32@0.21.5": optional: true - '@esbuild/win32-x64@0.21.5': + "@esbuild/win32-x64@0.21.5": optional: true - '@jridgewell/sourcemap-codec@1.5.0': {} + "@jridgewell/sourcemap-codec@1.5.0": {} - '@rollup/rollup-android-arm-eabi@4.19.1': + "@rollup/rollup-android-arm-eabi@4.19.1": optional: true - '@rollup/rollup-android-arm64@4.19.1': + "@rollup/rollup-android-arm64@4.19.1": optional: true - '@rollup/rollup-darwin-arm64@4.19.1': + "@rollup/rollup-darwin-arm64@4.19.1": optional: true - '@rollup/rollup-darwin-x64@4.19.1': + "@rollup/rollup-darwin-x64@4.19.1": optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.19.1': + "@rollup/rollup-linux-arm-gnueabihf@4.19.1": optional: true - '@rollup/rollup-linux-arm-musleabihf@4.19.1': + "@rollup/rollup-linux-arm-musleabihf@4.19.1": optional: true - '@rollup/rollup-linux-arm64-gnu@4.19.1': + "@rollup/rollup-linux-arm64-gnu@4.19.1": optional: true - '@rollup/rollup-linux-arm64-musl@4.19.1': + "@rollup/rollup-linux-arm64-musl@4.19.1": optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.19.1': + "@rollup/rollup-linux-powerpc64le-gnu@4.19.1": optional: true - '@rollup/rollup-linux-riscv64-gnu@4.19.1': + "@rollup/rollup-linux-riscv64-gnu@4.19.1": optional: true - '@rollup/rollup-linux-s390x-gnu@4.19.1': + "@rollup/rollup-linux-s390x-gnu@4.19.1": optional: true - '@rollup/rollup-linux-x64-gnu@4.19.1': + "@rollup/rollup-linux-x64-gnu@4.19.1": optional: true - '@rollup/rollup-linux-x64-musl@4.19.1': + "@rollup/rollup-linux-x64-musl@4.19.1": optional: true - '@rollup/rollup-win32-arm64-msvc@4.19.1': + "@rollup/rollup-win32-arm64-msvc@4.19.1": optional: true - '@rollup/rollup-win32-ia32-msvc@4.19.1': + "@rollup/rollup-win32-ia32-msvc@4.19.1": optional: true - '@rollup/rollup-win32-x64-msvc@4.19.1': + "@rollup/rollup-win32-x64-msvc@4.19.1": optional: true - '@shikijs/core@1.12.0': + "@shikijs/core@1.12.0": dependencies: - '@types/hast': 3.0.4 + "@types/hast": 3.0.4 - '@shikijs/transformers@1.12.0': + "@shikijs/transformers@1.12.0": dependencies: shiki: 1.12.0 - '@types/estree@1.0.5': {} + "@types/estree@1.0.5": {} - '@types/hast@3.0.4': + "@types/hast@3.0.4": dependencies: - '@types/unist': 3.0.2 + "@types/unist": 3.0.2 - '@types/linkify-it@5.0.0': {} + "@types/linkify-it@5.0.0": {} - '@types/markdown-it@14.1.2': + "@types/markdown-it@14.1.2": dependencies: - '@types/linkify-it': 5.0.0 - '@types/mdurl': 2.0.0 + "@types/linkify-it": 5.0.0 + "@types/mdurl": 2.0.0 - '@types/mdurl@2.0.0': {} + "@types/mdurl@2.0.0": {} - '@types/unist@3.0.2': {} + "@types/unist@3.0.2": {} - '@types/web-bluetooth@0.0.20': {} + "@types/web-bluetooth@0.0.20": {} - '@vitejs/plugin-vue@5.1.1(vite@5.3.5)(vue@3.4.34)': + "@vitejs/plugin-vue@5.1.1(vite@5.3.5)(vue@3.4.34)": dependencies: vite: 5.3.5 vue: 3.4.34 - '@vue/compiler-core@3.4.34': + "@vue/compiler-core@3.4.34": dependencies: - '@babel/parser': 7.25.0 - '@vue/shared': 3.4.34 + "@babel/parser": 7.25.0 + "@vue/shared": 3.4.34 entities: 4.5.0 estree-walker: 2.0.2 source-map-js: 1.2.0 - '@vue/compiler-dom@3.4.34': + "@vue/compiler-dom@3.4.34": dependencies: - '@vue/compiler-core': 3.4.34 - '@vue/shared': 3.4.34 + "@vue/compiler-core": 3.4.34 + "@vue/shared": 3.4.34 - '@vue/compiler-sfc@3.4.34': + "@vue/compiler-sfc@3.4.34": dependencies: - '@babel/parser': 7.25.0 - '@vue/compiler-core': 3.4.34 - '@vue/compiler-dom': 3.4.34 - '@vue/compiler-ssr': 3.4.34 - '@vue/shared': 3.4.34 + "@babel/parser": 7.25.0 + "@vue/compiler-core": 3.4.34 + "@vue/compiler-dom": 3.4.34 + "@vue/compiler-ssr": 3.4.34 + "@vue/shared": 3.4.34 estree-walker: 2.0.2 magic-string: 0.30.11 postcss: 8.4.40 source-map-js: 1.2.0 - '@vue/compiler-ssr@3.4.34': + "@vue/compiler-ssr@3.4.34": dependencies: - '@vue/compiler-dom': 3.4.34 - '@vue/shared': 3.4.34 + "@vue/compiler-dom": 3.4.34 + "@vue/shared": 3.4.34 - '@vue/devtools-api@7.3.7': + "@vue/devtools-api@7.3.7": dependencies: - '@vue/devtools-kit': 7.3.7 + "@vue/devtools-kit": 7.3.7 - '@vue/devtools-kit@7.3.7': + "@vue/devtools-kit@7.3.7": dependencies: - '@vue/devtools-shared': 7.3.7 + "@vue/devtools-shared": 7.3.7 birpc: 0.2.17 hookable: 5.5.3 mitt: 3.0.1 @@ -966,81 +1349,81 @@ snapshots: speakingurl: 14.0.1 superjson: 2.2.1 - '@vue/devtools-shared@7.3.7': + "@vue/devtools-shared@7.3.7": dependencies: rfdc: 1.4.1 - '@vue/reactivity@3.4.34': + "@vue/reactivity@3.4.34": dependencies: - '@vue/shared': 3.4.34 + "@vue/shared": 3.4.34 - '@vue/runtime-core@3.4.34': + "@vue/runtime-core@3.4.34": dependencies: - '@vue/reactivity': 3.4.34 - '@vue/shared': 3.4.34 + "@vue/reactivity": 3.4.34 + "@vue/shared": 3.4.34 - '@vue/runtime-dom@3.4.34': + "@vue/runtime-dom@3.4.34": dependencies: - '@vue/reactivity': 3.4.34 - '@vue/runtime-core': 3.4.34 - '@vue/shared': 3.4.34 + "@vue/reactivity": 3.4.34 + "@vue/runtime-core": 3.4.34 + "@vue/shared": 3.4.34 csstype: 3.1.3 - '@vue/server-renderer@3.4.34(vue@3.4.34)': + "@vue/server-renderer@3.4.34(vue@3.4.34)": dependencies: - '@vue/compiler-ssr': 3.4.34 - '@vue/shared': 3.4.34 + "@vue/compiler-ssr": 3.4.34 + "@vue/shared": 3.4.34 vue: 3.4.34 - '@vue/shared@3.4.34': {} + "@vue/shared@3.4.34": {} - '@vueuse/core@10.11.0(vue@3.4.34)': + "@vueuse/core@10.11.0(vue@3.4.34)": dependencies: - '@types/web-bluetooth': 0.0.20 - '@vueuse/metadata': 10.11.0 - '@vueuse/shared': 10.11.0(vue@3.4.34) + "@types/web-bluetooth": 0.0.20 + "@vueuse/metadata": 10.11.0 + "@vueuse/shared": 10.11.0(vue@3.4.34) vue-demi: 0.14.10(vue@3.4.34) transitivePeerDependencies: - - '@vue/composition-api' + - "@vue/composition-api" - vue - '@vueuse/integrations@10.11.0(focus-trap@7.5.4)(vue@3.4.34)': + "@vueuse/integrations@10.11.0(focus-trap@7.5.4)(vue@3.4.34)": dependencies: - '@vueuse/core': 10.11.0(vue@3.4.34) - '@vueuse/shared': 10.11.0(vue@3.4.34) + "@vueuse/core": 10.11.0(vue@3.4.34) + "@vueuse/shared": 10.11.0(vue@3.4.34) vue-demi: 0.14.10(vue@3.4.34) optionalDependencies: focus-trap: 7.5.4 transitivePeerDependencies: - - '@vue/composition-api' + - "@vue/composition-api" - vue - '@vueuse/metadata@10.11.0': {} + "@vueuse/metadata@10.11.0": {} - '@vueuse/shared@10.11.0(vue@3.4.34)': + "@vueuse/shared@10.11.0(vue@3.4.34)": dependencies: vue-demi: 0.14.10(vue@3.4.34) transitivePeerDependencies: - - '@vue/composition-api' + - "@vue/composition-api" - vue algoliasearch@4.24.0: dependencies: - '@algolia/cache-browser-local-storage': 4.24.0 - '@algolia/cache-common': 4.24.0 - '@algolia/cache-in-memory': 4.24.0 - '@algolia/client-account': 4.24.0 - '@algolia/client-analytics': 4.24.0 - '@algolia/client-common': 4.24.0 - '@algolia/client-personalization': 4.24.0 - '@algolia/client-search': 4.24.0 - '@algolia/logger-common': 4.24.0 - '@algolia/logger-console': 4.24.0 - '@algolia/recommend': 4.24.0 - '@algolia/requester-browser-xhr': 4.24.0 - '@algolia/requester-common': 4.24.0 - '@algolia/requester-node-http': 4.24.0 - '@algolia/transporter': 4.24.0 + "@algolia/cache-browser-local-storage": 4.24.0 + "@algolia/cache-common": 4.24.0 + "@algolia/cache-in-memory": 4.24.0 + "@algolia/client-account": 4.24.0 + "@algolia/client-analytics": 4.24.0 + "@algolia/client-common": 4.24.0 + "@algolia/client-personalization": 4.24.0 + "@algolia/client-search": 4.24.0 + "@algolia/logger-common": 4.24.0 + "@algolia/logger-console": 4.24.0 + "@algolia/recommend": 4.24.0 + "@algolia/requester-browser-xhr": 4.24.0 + "@algolia/requester-common": 4.24.0 + "@algolia/requester-node-http": 4.24.0 + "@algolia/transporter": 4.24.0 birpc@0.2.17: {} @@ -1054,29 +1437,29 @@ snapshots: esbuild@0.21.5: optionalDependencies: - '@esbuild/aix-ppc64': 0.21.5 - '@esbuild/android-arm': 0.21.5 - '@esbuild/android-arm64': 0.21.5 - '@esbuild/android-x64': 0.21.5 - '@esbuild/darwin-arm64': 0.21.5 - '@esbuild/darwin-x64': 0.21.5 - '@esbuild/freebsd-arm64': 0.21.5 - '@esbuild/freebsd-x64': 0.21.5 - '@esbuild/linux-arm': 0.21.5 - '@esbuild/linux-arm64': 0.21.5 - '@esbuild/linux-ia32': 0.21.5 - '@esbuild/linux-loong64': 0.21.5 - '@esbuild/linux-mips64el': 0.21.5 - '@esbuild/linux-ppc64': 0.21.5 - '@esbuild/linux-riscv64': 0.21.5 - '@esbuild/linux-s390x': 0.21.5 - '@esbuild/linux-x64': 0.21.5 - '@esbuild/netbsd-x64': 0.21.5 - '@esbuild/openbsd-x64': 0.21.5 - '@esbuild/sunos-x64': 0.21.5 - '@esbuild/win32-arm64': 0.21.5 - '@esbuild/win32-ia32': 0.21.5 - '@esbuild/win32-x64': 0.21.5 + "@esbuild/aix-ppc64": 0.21.5 + "@esbuild/android-arm": 0.21.5 + "@esbuild/android-arm64": 0.21.5 + "@esbuild/android-x64": 0.21.5 + "@esbuild/darwin-arm64": 0.21.5 + "@esbuild/darwin-x64": 0.21.5 + "@esbuild/freebsd-arm64": 0.21.5 + "@esbuild/freebsd-x64": 0.21.5 + "@esbuild/linux-arm": 0.21.5 + "@esbuild/linux-arm64": 0.21.5 + "@esbuild/linux-ia32": 0.21.5 + "@esbuild/linux-loong64": 0.21.5 + "@esbuild/linux-mips64el": 0.21.5 + "@esbuild/linux-ppc64": 0.21.5 + "@esbuild/linux-riscv64": 0.21.5 + "@esbuild/linux-s390x": 0.21.5 + "@esbuild/linux-x64": 0.21.5 + "@esbuild/netbsd-x64": 0.21.5 + "@esbuild/openbsd-x64": 0.21.5 + "@esbuild/sunos-x64": 0.21.5 + "@esbuild/win32-arm64": 0.21.5 + "@esbuild/win32-ia32": 0.21.5 + "@esbuild/win32-x64": 0.21.5 estree-walker@2.0.2: {} @@ -1093,7 +1476,7 @@ snapshots: magic-string@0.30.11: dependencies: - '@jridgewell/sourcemap-codec': 1.5.0 + "@jridgewell/sourcemap-codec": 1.5.0 mark.js@8.11.1: {} @@ -1115,36 +1498,38 @@ snapshots: preact@10.23.1: {} + prettier@3.3.3: {} + rfdc@1.4.1: {} rollup@4.19.1: dependencies: - '@types/estree': 1.0.5 + "@types/estree": 1.0.5 optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.19.1 - '@rollup/rollup-android-arm64': 4.19.1 - '@rollup/rollup-darwin-arm64': 4.19.1 - '@rollup/rollup-darwin-x64': 4.19.1 - '@rollup/rollup-linux-arm-gnueabihf': 4.19.1 - '@rollup/rollup-linux-arm-musleabihf': 4.19.1 - '@rollup/rollup-linux-arm64-gnu': 4.19.1 - '@rollup/rollup-linux-arm64-musl': 4.19.1 - '@rollup/rollup-linux-powerpc64le-gnu': 4.19.1 - '@rollup/rollup-linux-riscv64-gnu': 4.19.1 - '@rollup/rollup-linux-s390x-gnu': 4.19.1 - '@rollup/rollup-linux-x64-gnu': 4.19.1 - '@rollup/rollup-linux-x64-musl': 4.19.1 - '@rollup/rollup-win32-arm64-msvc': 4.19.1 - '@rollup/rollup-win32-ia32-msvc': 4.19.1 - '@rollup/rollup-win32-x64-msvc': 4.19.1 + "@rollup/rollup-android-arm-eabi": 4.19.1 + "@rollup/rollup-android-arm64": 4.19.1 + "@rollup/rollup-darwin-arm64": 4.19.1 + "@rollup/rollup-darwin-x64": 4.19.1 + "@rollup/rollup-linux-arm-gnueabihf": 4.19.1 + "@rollup/rollup-linux-arm-musleabihf": 4.19.1 + "@rollup/rollup-linux-arm64-gnu": 4.19.1 + "@rollup/rollup-linux-arm64-musl": 4.19.1 + "@rollup/rollup-linux-powerpc64le-gnu": 4.19.1 + "@rollup/rollup-linux-riscv64-gnu": 4.19.1 + "@rollup/rollup-linux-s390x-gnu": 4.19.1 + "@rollup/rollup-linux-x64-gnu": 4.19.1 + "@rollup/rollup-linux-x64-musl": 4.19.1 + "@rollup/rollup-win32-arm64-msvc": 4.19.1 + "@rollup/rollup-win32-ia32-msvc": 4.19.1 + "@rollup/rollup-win32-x64-msvc": 4.19.1 fsevents: 2.3.3 search-insights@2.15.0: {} shiki@1.12.0: dependencies: - '@shikijs/core': 1.12.0 - '@types/hast': 3.0.4 + "@shikijs/core": 1.12.0 + "@types/hast": 3.0.4 source-map-js@1.2.0: {} @@ -1168,16 +1553,16 @@ snapshots: vitepress@1.3.1(@algolia/client-search@4.24.0)(postcss@8.4.40)(search-insights@2.15.0): dependencies: - '@docsearch/css': 3.6.1 - '@docsearch/js': 3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0) - '@shikijs/core': 1.12.0 - '@shikijs/transformers': 1.12.0 - '@types/markdown-it': 14.1.2 - '@vitejs/plugin-vue': 5.1.1(vite@5.3.5)(vue@3.4.34) - '@vue/devtools-api': 7.3.7 - '@vue/shared': 3.4.34 - '@vueuse/core': 10.11.0(vue@3.4.34) - '@vueuse/integrations': 10.11.0(focus-trap@7.5.4)(vue@3.4.34) + "@docsearch/css": 3.6.1 + "@docsearch/js": 3.6.1(@algolia/client-search@4.24.0)(search-insights@2.15.0) + "@shikijs/core": 1.12.0 + "@shikijs/transformers": 1.12.0 + "@types/markdown-it": 14.1.2 + "@vitejs/plugin-vue": 5.1.1(vite@5.3.5)(vue@3.4.34) + "@vue/devtools-api": 7.3.7 + "@vue/shared": 3.4.34 + "@vueuse/core": 10.11.0(vue@3.4.34) + "@vueuse/integrations": 10.11.0(focus-trap@7.5.4)(vue@3.4.34) focus-trap: 7.5.4 mark.js: 8.11.1 minisearch: 7.1.0 @@ -1187,10 +1572,10 @@ snapshots: optionalDependencies: postcss: 8.4.40 transitivePeerDependencies: - - '@algolia/client-search' - - '@types/node' - - '@types/react' - - '@vue/composition-api' + - "@algolia/client-search" + - "@types/node" + - "@types/react" + - "@vue/composition-api" - async-validator - axios - change-case @@ -1219,8 +1604,8 @@ snapshots: vue@3.4.34: dependencies: - '@vue/compiler-dom': 3.4.34 - '@vue/compiler-sfc': 3.4.34 - '@vue/runtime-dom': 3.4.34 - '@vue/server-renderer': 3.4.34(vue@3.4.34) - '@vue/shared': 3.4.34 + "@vue/compiler-dom": 3.4.34 + "@vue/compiler-sfc": 3.4.34 + "@vue/runtime-dom": 3.4.34 + "@vue/server-renderer": 3.4.34(vue@3.4.34) + "@vue/shared": 3.4.34 From 47b906ad93e72ba58aad76818f427c3e913e93f0 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 19:56:56 +0100 Subject: [PATCH 4/8] fix(lint): fix javascript/css files with prettier --- .vitepress/config.mts | 203 +++++++++++++++++++++---------------- .vitepress/theme/index.ts | 14 +-- .vitepress/theme/style.css | 3 +- package.json | 5 +- 4 files changed, 127 insertions(+), 98 deletions(-) diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 3aeabaf..52f5b14 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -1,101 +1,128 @@ -import {defineConfig} from 'vitepress' +import { defineConfig } from "vitepress"; // https://vitepress.dev/reference/site-config export default defineConfig({ - title: 'Mockbukkit Docs', - description: "Documentation for Mockbukkit, a powerful and flexible Mocking framework for Minecraft plugins.", + title: "Mockbukkit Docs", + description: + "Documentation for Mockbukkit, a powerful and flexible Mocking framework for Minecraft plugins.", - head: [ - ['link', {rel: 'icon', href: './favicon.ico'}], + head: [["link", { rel: "icon", href: "./favicon.ico" }]], + themeConfig: { + // https://vitepress.dev/reference/default-theme-config + nav: [ + { text: "Home", link: "/" }, + { + text: "Getting Started", + link: "docs/en/user_guide/introduction/getting_started", + }, + { + text: "Contribution Guides", + link: "docs/en/contribution/maintainers/pr_guide", + }, ], - themeConfig: { - // https://vitepress.dev/reference/default-theme-config - nav: [ - {text: 'Home', link: '/'}, - {text: 'Getting Started', link: 'docs/en/user_guide/introduction/getting_started'}, - {text: 'Contribution Guides', link: 'docs/en/contribution/maintainers/pr_guide'}, - ], - logo: '/images/mockbukkit_logo.png', - editLink: { - pattern: "https://github.com/MockBukkit/docs/tree/main/:path", - text: "Edit this page on Github!" + logo: "/images/mockbukkit_logo.png", + editLink: { + pattern: "https://github.com/MockBukkit/docs/tree/main/:path", + text: "Edit this page on Github!", + }, + search: { + provider: "local", + }, + lastUpdated: true, + sidebar: { + "/docs/en/user_guide": [ + { + text: "Introduction", + collapsed: false, + items: [ + { + text: "Getting Started", + link: "docs/en/user_guide/introduction/getting_started", + }, + { + text: "Writing your first test", + link: "docs/en/user_guide/introduction/first_test", + }, + { + text: "Create a World Mock", + link: "docs/en/user_guide/introduction/mock_world.md", + }, + ], }, - search: { - provider: "local" + { + text: "Entities", + collapsed: false, + items: [ + { text: "Entities", link: "docs/en/user_guide/entities/entity" }, + { text: "Player", link: "docs/en/user_guide/entities/player" }, + { + text: "MessageTarget", + link: "docs/en/user_guide/entities/message_target", + }, + ], }, - lastUpdated: true, - sidebar: { - '/docs/en/user_guide': [ - { - text: 'Introduction', - collapsed: false, - items: [ - {text: 'Getting Started', link: 'docs/en/user_guide/introduction/getting_started'}, - {text: 'Writing your first test', link: 'docs/en/user_guide/introduction/first_test'}, - {text: 'Create a World Mock', link: 'docs/en/user_guide/introduction/mock_world.md'}, - ] - }, - { - text: "Entities", - collapsed: false, - items: [ - {text: 'Entities', link: 'docs/en/user_guide/entities/entity'}, - {text: 'Player', link: 'docs/en/user_guide/entities/player'}, - {text: 'MessageTarget', link: 'docs/en/user_guide/entities/message_target'}, - ] - }, + { + text: "Advanced Topics", + collapsed: false, + items: [ + { + text: "Scheduler", + link: "docs/en/user_guide/advanced/scheduler", + }, + { text: "Events", link: "docs/en/user_guide/advanced/events" }, + { + text: "Custom ServerMock", + link: "docs/en/user_guide/advanced/custom_server_mock", + }, + { + text: "Adventure", + link: "docs/en/user_guide/advanced/adventure", + }, + ], + }, + { + text: "Migrations", + collapsed: false, + items: [ + { + text: "3.x to - 4.x Migration", + link: "docs/en/user_guide/migration/migrate_mockbukkit_4.0", + items: [ { - text: "Advanced Topics", - collapsed: false, - items: [ - {text: 'Scheduler', link: 'docs/en/user_guide/advanced/scheduler'}, - {text: 'Events', link: 'docs/en/user_guide/advanced/events'}, - {text: 'Custom ServerMock', link: 'docs/en/user_guide/advanced/custom_server_mock'}, - {text: 'Adventure', link: 'docs/en/user_guide/advanced/adventure'} - ] + text: "Migration with OpenRewrite", + link: "docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite", }, - { - text: "Migrations", - collapsed: false, - items: [ - { - text: "3.x to - 4.x Migration", - link: "docs/en/user_guide/migration/migrate_mockbukkit_4.0", - items: [ - { - text: "Migration with OpenRewrite", - link: "docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite" - } - ] - } - ] - } - ], - '/docs/en/contribution': [ - { - text: "For Maintainers", - collapsed: false, - items: [ - {text: "Maintainer PR Guide", link: 'docs/en/contribution/maintainers/pr_guide'}, - ] - } - ] + ], + }, + ], }, - - socialLinks: [ - {icon: 'github', link: 'https://github.com/Mockbukkit/Mockbukkit'}, - {icon: 'discord', link: 'https://discord.gg/Xunsn6D8MB'}, - ], - footer: { - message: 'Released under the MIT License.', - copyright: 'Copyright © 2017-2024 Mockbukkit' - } + ], + "/docs/en/contribution": [ + { + text: "For Maintainers", + collapsed: false, + items: [ + { + text: "Maintainer PR Guide", + link: "docs/en/contribution/maintainers/pr_guide", + }, + ], + }, + ], }, - ignoreDeadLinks: [ - /^https?:\/\/localhost/, + + socialLinks: [ + { icon: "github", link: "https://github.com/Mockbukkit/Mockbukkit" }, + { icon: "discord", link: "https://discord.gg/Xunsn6D8MB" }, ], - vite: { - publicDir: "./public" - } -}) + footer: { + message: "Released under the MIT License.", + copyright: "Copyright © 2017-2024 Mockbukkit", + }, + }, + ignoreDeadLinks: [/^https?:\/\/localhost/], + vite: { + publicDir: "./public", + }, +}); diff --git a/.vitepress/theme/index.ts b/.vitepress/theme/index.ts index def4cfc..f90bd40 100644 --- a/.vitepress/theme/index.ts +++ b/.vitepress/theme/index.ts @@ -1,17 +1,17 @@ // https://vitepress.dev/guide/custom-theme -import { h } from 'vue' -import type { Theme } from 'vitepress' -import DefaultTheme from 'vitepress/theme' -import './style.css' +import { h } from "vue"; +import type { Theme } from "vitepress"; +import DefaultTheme from "vitepress/theme"; +import "./style.css"; export default { extends: DefaultTheme, Layout: () => { return h(DefaultTheme.Layout, null, { // https://vitepress.dev/guide/extending-default-theme#layout-slots - }) + }); }, enhanceApp({ app, router, siteData }) { // ... - } -} satisfies Theme + }, +} satisfies Theme; diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css index 76551ab..8fcc4b3 100644 --- a/.vitepress/theme/style.css +++ b/.vitepress/theme/style.css @@ -43,7 +43,7 @@ * in custom container, badges, etc. * -------------------------------------------------------------------------- */ - :root { +:root { --vp-c-default-1: var(--vp-c-gray-1); --vp-c-default-2: var(--vp-c-gray-2); --vp-c-default-3: var(--vp-c-gray-3); @@ -136,4 +136,3 @@ .DocSearch { --docsearch-primary-color: var(--vp-c-brand-1) !important; } - diff --git a/package.json b/package.json index 7bcf910..28c007f 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,10 @@ "lint:check": "prettier --check .", "lint:fix": "prettier --write .", "lint:fix:md": "prettier --write '**/*.md'", - "lint:fix:yaml": "prettier --write '**/*.{yml,yaml}'" + "lint:fix:yaml": "prettier --write '**/*.{yml,yaml}'", + "lint:fix:json": "prettier --write '**/*.json'", + "lint:fix:js": "prettier --write '**/*.{js,jsx,mts,ts,tsx,vue}'", + "lint:fix:css": "prettier --write '**/*.css'" }, "packageManager": "pnpm@9.12.2" } From d347be71bc6730a024802a43c5ee3a09b6945ed1 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 20:01:11 +0100 Subject: [PATCH 5/8] fix(lint): fix markdown files with prettier --- CODE_OF_CONDUCT.md | 21 +++++----- CONTRIBUTING.md | 39 ++++++++++--------- README.md | 24 ++++++------ docs/en/contribution/maintainers/pr_guide.md | 12 +++--- docs/en/user_guide/advanced/adventure.md | 6 +-- .../user_guide/advanced/custom_server_mock.md | 10 ++--- docs/en/user_guide/advanced/events.md | 10 ++--- docs/en/user_guide/advanced/scheduler.md | 10 ++--- docs/en/user_guide/entities/entity.md | 13 +++---- docs/en/user_guide/entities/message_target.md | 8 ++-- docs/en/user_guide/entities/player.md | 25 ++++++------ docs/en/user_guide/introduction/first_test.md | 26 ++++++++----- .../introduction/getting_started.md | 5 ++- docs/en/user_guide/introduction/mock_world.md | 10 ++--- .../migration/migrate_mockbukkit_4.0.md | 7 ++-- .../migrate_mockbukkit_4.0_openrewrite.md | 17 +++++--- index.md | 4 +- 17 files changed, 129 insertions(+), 118 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 008f1f8..61dd561 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,3 @@ - # Contributor Covenant Code of Conduct ## Our Pledge @@ -18,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or advances of +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 057c1f5..7562198 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,11 +47,12 @@ Before you start contributing, ensure you have the following prerequisites insta ``` 2. **Update the Documentation**: Make your changes to the documentation. This could include: - - Adding new pages - - Updating existing content - - Fixing typos or grammatical errors - - Improving the organization or structure of the documentation - - Adding new translations + + - Adding new pages + - Updating existing content + - Fixing typos or grammatical errors + - Improving the organization or structure of the documentation + - Adding new translations 3. **Preview Your Changes**: Use the Vitepress development server to preview your changes and ensure they look as expected. @@ -66,7 +67,7 @@ Before you start contributing, ensure you have the following prerequisites insta ## Submitting a Pull Request -1. **Create a Pull Request**: Go to the original repository on GitHub and create a new pull request, +1. **Create a Pull Request**: Go to the original repository on GitHub and create a new pull request, comparing your feature branch with the main branch of the original repository. 2. **Describe Your Changes**: In the pull request description, @@ -84,23 +85,23 @@ Before you start contributing, ensure you have the following prerequisites insta ### Code blocks -For code blocks where multiple languages can be used, vitepress provides a way to +For code blocks where multiple languages can be used, vitepress provides a way to specify blocks for multiple languages. Use the following syntax: -```md - ::: code-group - - ```java [Java] - // Java code goes here - ``` - - ```kotlin [Kotlin] - // Kotlin code goes here - ``` - - ::: +````md +::: code-group + +```java [Java] +// Java code goes here ``` +```kotlin [Kotlin] +// Kotlin code goes here +``` + +::: +```` + ## Vitepress Markdown Extensions Vitepress provides a variety of Markdown extensions that can be used to enhance the documentation. diff --git a/README.md b/README.md index e9eef5f..e95129a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Mockbukkit Docs -This repository is the place where you can find the code for all documentation provided by the +This repository is the place where you can find the code for all documentation provided by the MockBukkit project. The repository is published under [docs.mockbukkit.org](https://docs.mockbukkit.org). ## Getting started @@ -16,23 +16,23 @@ This is how you can get started working on the docs on your local development ma 1. First, clone the repository: - ```bash - git clone https://github.com/MockBukkit/docs.git - ``` + ```bash + git clone https://github.com/MockBukkit/docs.git + ``` 2. Then, install the dependencies: - ```bash - pnpm install - ``` + ```bash + pnpm install + ``` 3. Finally, run the server: - ```bash - pnpm docs:dev // dev server - pnpm docs:build // build for production - ``` - + ```bash + pnpm docs:dev // dev server + pnpm docs:build // build for production + ``` + In the case of building for production, the site will be generated in the `.vitepress/dist` directory. ### Previewing diff --git a/docs/en/contribution/maintainers/pr_guide.md b/docs/en/contribution/maintainers/pr_guide.md index 8003f73..be20332 100644 --- a/docs/en/contribution/maintainers/pr_guide.md +++ b/docs/en/contribution/maintainers/pr_guide.md @@ -18,11 +18,11 @@ to automatically tag PRs with a version number on merge. This removes the tediou to date across several PRs at a time and eliminate Human error. The following custom labels, all of them following the pattern of `release/*`, are used by Mockbukkit: -| Label | Semantic Version Type | | Description | -|----------------------------------------------|:----------------------|:--|:---------------------------------------| -| | Major Version (X.0.0) | | Only used for breaking changes | -| | Minor Version (0.X.0) | | New Features | -| | Patch Version (0.0.X) | | Bugfixes | -| | None (-) | | Method Stubs or non code related fixes | +| Label | Semantic Version Type | | Description | +| -------------------------------------------- | :-------------------- | :-- | :------------------------------------- | +| | Major Version (X.0.0) | | Only used for breaking changes | +| | Minor Version (0.X.0) | | New Features | +| | Patch Version (0.0.X) | | Bugfixes | +| | None (-) | | Method Stubs or non code related fixes | As you can probably tell, this project uses [Semantic Versioning](https://semver.org/). diff --git a/docs/en/user_guide/advanced/adventure.md b/docs/en/user_guide/advanced/adventure.md index 48253d5..935e2de 100644 --- a/docs/en/user_guide/advanced/adventure.md +++ b/docs/en/user_guide/advanced/adventure.md @@ -3,8 +3,8 @@ outline: deep title: Adventure next: false prev: - text: 'Create a Custom Server Mock' - link: '/docs/en/user_guide/advanced/custom_server_mock' + text: "Create a Custom Server Mock" + link: "/docs/en/user_guide/advanced/custom_server_mock" --- # Adventure @@ -49,4 +49,4 @@ override fun onEnable() { override fun onDisable() { platform.close() } -``` \ No newline at end of file +``` diff --git a/docs/en/user_guide/advanced/custom_server_mock.md b/docs/en/user_guide/advanced/custom_server_mock.md index e1e9285..bb9b988 100644 --- a/docs/en/user_guide/advanced/custom_server_mock.md +++ b/docs/en/user_guide/advanced/custom_server_mock.md @@ -2,11 +2,11 @@ outline: deep title: Create a Custom Server Mock prev: - text: 'Events' - link: '/docs/en/user_guide/advanced/events' + text: "Events" + link: "/docs/en/user_guide/advanced/events" next: - text: 'Adventure' - link: '/docs/en/user_guide/advanced/adventure' + text: "Adventure" + link: "/docs/en/user_guide/advanced/adventure" --- # Create a Custom Server Mock @@ -28,4 +28,4 @@ val server: MyCustomServerMock = Mockbukkit.mock(MyCustomServerMock()) ::: -Note that `MockBukkit.getMock()` will return a reference to your instance. \ No newline at end of file +Note that `MockBukkit.getMock()` will return a reference to your instance. diff --git a/docs/en/user_guide/advanced/events.md b/docs/en/user_guide/advanced/events.md index f823a2f..ab67b9f 100644 --- a/docs/en/user_guide/advanced/events.md +++ b/docs/en/user_guide/advanced/events.md @@ -2,11 +2,11 @@ outline: deep title: Events prev: - text: 'Scheduler' - link: '/docs/en/user_guide/advanced/scheduler' + text: "Scheduler" + link: "/docs/en/user_guide/advanced/scheduler" next: - text: 'Custom ServerMock' - link: '/docs/en/user_guide/advanced/custom_server_mock' + text: "Custom ServerMock" + link: "/docs/en/user_guide/advanced/custom_server_mock" --- # Events @@ -309,4 +309,4 @@ class MyPluginTests { } ``` -::: \ No newline at end of file +::: diff --git a/docs/en/user_guide/advanced/scheduler.md b/docs/en/user_guide/advanced/scheduler.md index c00efba..607c30a 100644 --- a/docs/en/user_guide/advanced/scheduler.md +++ b/docs/en/user_guide/advanced/scheduler.md @@ -2,11 +2,11 @@ outline: deep title: Scheduler Mock next: - text: 'Events' - link: '/docs/en/user_guide/advanced/events' + text: "Events" + link: "/docs/en/user_guide/advanced/events" prev: - text: 'MessageTarget' - link: 'docs/en/user_guide/entities/message_target' + text: "MessageTarget" + link: "docs/en/user_guide/entities/message_target" --- # Scheduler Mock @@ -65,4 +65,4 @@ long tick = server.getScheduler().getCurrentTick(); val tick: Long = server.scheduler.getCurrentTick(); ``` -::: \ No newline at end of file +::: diff --git a/docs/en/user_guide/entities/entity.md b/docs/en/user_guide/entities/entity.md index 1dc2ba4..2945afb 100644 --- a/docs/en/user_guide/entities/entity.md +++ b/docs/en/user_guide/entities/entity.md @@ -2,11 +2,11 @@ outline: deep title: Entities prev: - text: 'Creating a Mock World' - link: '/docs/en/user_guide/introduction/mock_world' + text: "Creating a Mock World" + link: "/docs/en/user_guide/introduction/mock_world" next: - text: 'Player' - link: '/docs/en/user_guide/entities/player' + text: "Player" + link: "/docs/en/user_guide/entities/player" --- # Entities @@ -17,10 +17,9 @@ We added several Methods to our `EntityMock` implementation that will make testi As Entity also implements [MessageTarget](message_target.md), you can also use the methods provided there - ## Asserting Location -Oftentimes you want to check the Location of an entity. To simply this, +Oftentimes you want to check the Location of an entity. To simply this, Mockbukkit provides the `EntityMock.assertLocation(Location,double)` method. It allows you to check if the entity is within a given range around the specified `Location` @@ -86,7 +85,6 @@ In Bukkit, the only way to move a Entity is by teleporting it. As this might interfere with tests, we added the `EntityMock.setLocation(location)` method to move an entity without changing the teleported flag - ## Rename an Entity In Mockbukkit you can also rename the entity to your hearts content @@ -102,4 +100,3 @@ entity.setName("new-name") ``` ::: - diff --git a/docs/en/user_guide/entities/message_target.md b/docs/en/user_guide/entities/message_target.md index fef7084..41a0d94 100644 --- a/docs/en/user_guide/entities/message_target.md +++ b/docs/en/user_guide/entities/message_target.md @@ -2,11 +2,11 @@ outline: deep title: MessageTarget next: - text: 'Scheduler Mock' - link: '/docs/en/user_guide/advanced/scheduler' + text: "Scheduler Mock" + link: "/docs/en/user_guide/advanced/scheduler" prev: - text: 'Player' - link: '/docs/en/user_guide/entities/player' + text: "Player" + link: "/docs/en/user_guide/entities/player" --- # MessageTarget diff --git a/docs/en/user_guide/entities/player.md b/docs/en/user_guide/entities/player.md index 4a49a32..0268ee1 100644 --- a/docs/en/user_guide/entities/player.md +++ b/docs/en/user_guide/entities/player.md @@ -2,11 +2,11 @@ outline: deep title: Player prev: - text: 'Entities' - link: '/docs/en/user_guide/entities/entity' + text: "Entities" + link: "/docs/en/user_guide/entities/entity" next: - text: 'MessageTarget' - link: '/docs/en/user_guide/entities/message_target' + text: "MessageTarget" + link: "/docs/en/user_guide/entities/message_target" --- # Player @@ -39,7 +39,7 @@ val player: PlayerMock = server.addPlayer() #### `ServerMock.addPlayer(String)` -This method adds a player to the server with the given name. +This method adds a player to the server with the given name. ::: code-group @@ -55,7 +55,7 @@ val player: PlayerMock = server.addPlayer("Player1") #### `ServerMock.addPlayer(PlayerMock)` -If you want to customize the Player object even further, you can specify +If you want to customize the Player object even further, you can specify the object you want to be added to the Server by providing a `PlayerMock` instance. ::: code-group @@ -63,9 +63,9 @@ the object you want to be added to the Server by providing a `PlayerMock` instan ```java public PlayerMock getCustomPlayer(){ PlayerMock playerMock = new PlayerMock(server, "custom_name", UUID.randomUUID()); - + playerMock.setGameMode(GameMode.CREATIVE); - + return playerMock; } @@ -108,6 +108,7 @@ server.setPlayers(20); val server = Mockbukkit.getMock() server.setPlayers(20) ``` + ::: After this, you can easily reference these Players with the `Server.getPlayer(int)` method @@ -137,8 +138,8 @@ This section isn't an exhaustive list of Methods we have added, please refer to ### Asserting the Gamemode of the player -A common task is checking the Gamemode a player currently is using. We provide a -convenience Method to make testing these a little bit easier. The `assertGameMode(Gamemode)` +A common task is checking the Gamemode a player currently is using. We provide a +convenience Method to make testing these a little bit easier. The `assertGameMode(Gamemode)` method throws and `AssertionException`, which will cause the test to fail if the Gamemode is different from the expected one. @@ -156,7 +157,7 @@ player.assertGameMode(GameMode.SURVIVAL) ### Simulate player disconnecting -To simulate a Player disconnecting, use the `disconnect()` method. This will set the +To simulate a Player disconnecting, use the `disconnect()` method. This will set the Player as offline but keeps it as an `OfflinePlayer`. :::code-group @@ -186,4 +187,4 @@ player.reconnect(); player.reconnect() ``` -::: \ No newline at end of file +::: diff --git a/docs/en/user_guide/introduction/first_test.md b/docs/en/user_guide/introduction/first_test.md index 57b4383..81088d1 100644 --- a/docs/en/user_guide/introduction/first_test.md +++ b/docs/en/user_guide/introduction/first_test.md @@ -2,11 +2,11 @@ outline: deep title: Writing your first test next: - text: 'Creating a Mock World' - link: '/docs/en/user_guide/introduction/mock_world' + text: "Creating a Mock World" + link: "/docs/en/user_guide/introduction/mock_world" prev: - text: 'Getting Started' - link: '/docs/en/user_guide/introduction/getting_started' + text: "Getting Started" + link: "/docs/en/user_guide/introduction/getting_started" --- # Writing your first test @@ -22,7 +22,7 @@ Create a new class called `HelloWorldTest.java` in the `src/test/java` directory ::: tip Its common practice to name test classes with the `Test` suffix, -so `HelloWorldTest` is a good name if you are writing a test +so `HelloWorldTest` is a good name if you are writing a test for the `HelloWorld` class. The name doesn't matter, but it's a good convention. The `Test` suffix helps identify test classes easily, and it's recognized by most build tools and testing frameworks for running tests automatically. @@ -30,7 +30,7 @@ for running tests automatically. ::: warning You're class can't be `final`. This is because MockBukkit uses reflection to -modify the behavior of the class under test. In Kotlin, classes are `final` by default, +modify the behavior of the class under test. In Kotlin, classes are `final` by default, so you must declare them as `open` for MockBukkit to function properly. ::: @@ -106,6 +106,7 @@ the missing functionality. If you are interested in contributing, please read the [Contributing Guide](https://github.com/Mockbukkit/Mockbukkit/blob/master/CONTRIBUTING.md). ### Example + This shows an example with a Method that at the time of writing is not yet implemented. ::: info @@ -113,7 +114,7 @@ This shows an example with a Method that at the time of writing is not yet imple The method used in this example might be implemented down the road. Since most of our effort goes into developing the production code, the documentation might become out of date. -This doesn't diminish this example, just the output might be different. +This doesn't diminish this example, just the output might be different. If you want to contribute a better example to the documentation, feel free to open a Pull Request changing this. @@ -121,6 +122,7 @@ feel free to open a Pull Request changing this. ::: #### Plugin Class + ::: code-group ```java [Java] @@ -143,7 +145,7 @@ public class DemoPlugin extends JavaPlugin { } ``` -```kotlin [Kotlin] +```kotlin [Kotlin] package org.mockbukkit.docsdemo import org.bukkit.plugin.java.JavaPlugin @@ -234,6 +236,7 @@ class DemoPluginTest { } ``` + ::: #### Executing the code @@ -245,15 +248,18 @@ Executing the test with Gradle, the task will still succeed, since there are onl ``` ::: details Output + ``` BUILD SUCCESSFUL in 522ms 4 actionable tasks: 4 up-to-date ``` + ::: With `JUnit`'s `assertThrow()` assertion, we can still get the actual error -::: details Excpetion +::: details Exception + ``` Not implemented org.mockbukkit.mockbukkit.UnimplementedOperationException: Not implemented @@ -345,4 +351,4 @@ org.mockbukkit.mockbukkit.UnimplementedOperationException: Not implemented at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74) ``` -::: \ No newline at end of file +::: diff --git a/docs/en/user_guide/introduction/getting_started.md b/docs/en/user_guide/introduction/getting_started.md index 791b153..a27f572 100644 --- a/docs/en/user_guide/introduction/getting_started.md +++ b/docs/en/user_guide/introduction/getting_started.md @@ -2,8 +2,8 @@ outline: deep title: Getting Started next: - text: 'Writing your first test' - link: '/docs/en/user_guide/introduction/first_test' + text: "Writing your first test" + link: "/docs/en/user_guide/introduction/first_test" --- # Getting Started @@ -52,6 +52,7 @@ dependencies { testImplementation("org.mockbukkit.mockbukkit:MockBukkit-v1.21:4.0.0") } ``` + ::: ## Running MockBukkit diff --git a/docs/en/user_guide/introduction/mock_world.md b/docs/en/user_guide/introduction/mock_world.md index df43dac..f157c40 100644 --- a/docs/en/user_guide/introduction/mock_world.md +++ b/docs/en/user_guide/introduction/mock_world.md @@ -2,11 +2,11 @@ outline: deep title: Creating a Mock World next: - text: 'Entities' - link: '/docs/en/user_guide/entities/entity' + text: "Entities" + link: "/docs/en/user_guide/entities/entity" prev: - text: 'Writing your first test' - link: '/docs/en/user_guide/introduction/first_test' + text: "Writing your first test" + link: "/docs/en/user_guide/introduction/first_test" --- # Creating a Mock World @@ -31,4 +31,4 @@ val world = server.addSimpleWorld("my_world") ::: Every time MockBukkit is started a world called `world` is automatically created. -All players are also added to this default world. \ No newline at end of file +All players are also added to this default world. diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md index 9fb3a0f..28a3ed6 100644 --- a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md +++ b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md @@ -2,9 +2,8 @@ outline: deep title: Migrate to Mockbukkit 4 next: - text: 'Migrate to Mockbukkit 4 using OpenRewrite' - link: '/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.html' - + text: "Migrate to Mockbukkit 4 using OpenRewrite" + link: "/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.html" --- # Migrate to Mockbukkit 4 @@ -29,7 +28,7 @@ Some class names have been renamed for easier interpretation. The table below creates a mapping between the class names from version 3 and the version 4. | v3 | v4 | -|-----------------------------------------------------------|-----------------------------------------------------------------| +| --------------------------------------------------------- | --------------------------------------------------------------- | | be.seeseemelk.mockbukkit.ban.MockIpBanEntry | org.mockbukkit.mockbukkit.ban.IpbanEntryMock | | be.seeseemelk.mockbukkit.ban.MockIpBanEList | org.mockbukkit.mockbukkit.ban.IpbanListMock | | be.seeseemelk.mockbukkit.block.data.AmethystClusterMock | org.mockbukkit.mockbukkit.block.data.AmethystClusterDataMock | diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md index c10aef9..acf8300 100644 --- a/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md +++ b/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md @@ -3,8 +3,8 @@ outline: deep title: Migrate to Mockbukkit 4 using OpenRewrite next: false prev: - link: '/docs/en/user_guide/migration/migrate_mockbukkit_4.0' - text: 'Migrate to Mockbukkit 4' + link: "/docs/en/user_guide/migration/migrate_mockbukkit_4.0" + text: "Migrate to Mockbukkit 4" --- # Migrate to Mockbukkit 4 using OpenRewrite @@ -26,6 +26,7 @@ mvn org.openrewrite.maven:rewrite-maven-plugin:run \ Otherwise, you will need to add OpenRewrite plugin to your project with the correct configuration: ::: code-group + ```xml [Maven] @@ -51,6 +52,7 @@ Otherwise, you will need to add OpenRewrite plugin to your project with the corr ``` + ```kotlin [Gradle Kotlin DSL] plugins { id("org.openrewrite.rewrite") version "6.x.x" @@ -58,7 +60,7 @@ plugins { dependencies { // Add the Mockbukkit recipes - rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2") + rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2") } // Add the recipe source to your project’s rewrite configuration @@ -67,6 +69,7 @@ rewrite { activeRecipe("org.mockbukkit.rewrite.ClassRename") } ``` + ```groovy [Gradle Groovy DSL] plugins { id("org.openrewrite.rewrite") version "6.x.x" @@ -74,7 +77,7 @@ plugins { dependencies { // Add the Mockbukkit recipes - rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2") + rewrite("org.mockbukkit.rewrite:openrewrite-recipes:1.0.2") } // Add the recipe source to your project’s rewrite configuration @@ -83,15 +86,19 @@ rewrite { activeRecipe("org.mockbukkit.rewrite.ClassRename") } ``` + ::: Run OpenRewrite to refactor your code: ::: code-group + ```bash [Maven] mvn rewrite:run ``` + ```bash [Gradle] ./gradlew rewriteRun ``` -::: \ No newline at end of file + +::: diff --git a/index.md b/index.md index 8af9e61..a985a4f 100644 --- a/index.md +++ b/index.md @@ -28,8 +28,8 @@ features: details: Unit testing accelerates delivery by reducing the time spent on debugging and error correction. - icon: 🔧 title: Less Manual Testing - details: Unit testing decreases the reliance on manual testing by automating the validation of code components. + details: Unit testing decreases the reliance on manual testing by automating the validation of code components. - icon: 🧪 title: Less Regressions - details: Unit testing minimizes regression risks by constantly verifying existing functionality. + details: Unit testing minimizes regression risks by constantly verifying existing functionality. --- From 104f0263796ec15e647553e6e8fd9aef5ae876ac Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 20:59:36 +0100 Subject: [PATCH 6/8] fix(lint): fix markdown files issues raised by markdownlint also fixes checkov issue --- .github/workflows/lint.yaml | 3 +- .markdownlint.jsonc | 9 + CONTRIBUTING.md | 62 ++++-- README.md | 26 ++- docs/en/contribution/maintainers/pr_guide.md | 24 ++- docs/en/user_guide/advanced/adventure.md | 10 +- .../user_guide/advanced/custom_server_mock.md | 8 +- docs/en/user_guide/advanced/events.md | 38 ++-- docs/en/user_guide/advanced/scheduler.md | 15 +- docs/en/user_guide/entities/entity.md | 19 +- docs/en/user_guide/entities/message_target.md | 8 +- docs/en/user_guide/entities/player.md | 42 ++-- docs/en/user_guide/introduction/first_test.md | 204 +++++++++--------- .../introduction/getting_started.md | 24 ++- .../migration/migrate_mockbukkit_4.0.md | 22 +- .../migrate_mockbukkit_4.0_openrewrite.md | 11 +- 16 files changed, 303 insertions(+), 222 deletions(-) create mode 100644 .markdownlint.jsonc diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 8a667d1..81a097a 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -9,8 +9,7 @@ on: branches: - main -permissions: - contents: read +permissions: read-all jobs: lint: diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..11acbf4 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,9 @@ +{ + "default": true, + "MD013": { + "code_block_line_length": 120 + }, + "MD025": { + "front_matter_title": "" + } +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7562198..f427807 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,14 @@ # Contributing to the Mockbukkit Documentation -Thank you for your interest in contributing to our documentation! -We welcome contributions from the community to help improve and expand our documentation. +Thank you for your interest in contributing to our documentation! We welcome +contributions from the community to help improve and expand our documentation. ## Getting Started ### Prerequisites -Before you start contributing, ensure you have the following prerequisites installed: +Before you start contributing, ensure you have the following prerequisites +installed: - [Git](https://git-scm.com/) - [Node.js](https://nodejs.org/) (version 18.x or higher) @@ -15,28 +16,33 @@ Before you start contributing, ensure you have the following prerequisites insta ### Setting Up the Development Environment -1. **Fork the Repository**: Start by forking the documentation repository to your own GitHub account. +1. **Fork the Repository**: Start by forking the documentation repository to + your own GitHub account. -2. **Clone the Repository**: Next, clone the forked repository to your local machine. +2. **Clone the Repository**: Next, clone the forked repository to your local + machine. ```bash git clone https://github.com/your-username/docs.git ``` -3. **Install Dependencies**: Install the necessary dependencies for the documentation project. +3. **Install Dependencies**: Install the necessary dependencies for the + documentation project. ```bash cd docs pnpm install ``` -4. **Start the Development Server**: Start the Vitepress development server to preview your changes. +4. **Start the Development Server**: Start the Vitepress development server to + preview your changes. ```bash pnpm run docs:dev ``` - The development server will start, and you can access the documentation site at `http://localhost:5173`. + The development server will start, and you can access the documentation site + at . ## Making Changes @@ -46,7 +52,8 @@ Before you start contributing, ensure you have the following prerequisites insta git checkout -b my-feature-branch ``` -2. **Update the Documentation**: Make your changes to the documentation. This could include: +2. **Update the Documentation**: Make your changes to the documentation. This + could include: - Adding new pages - Updating existing content @@ -54,7 +61,8 @@ Before you start contributing, ensure you have the following prerequisites insta - Improving the organization or structure of the documentation - Adding new translations -3. **Preview Your Changes**: Use the Vitepress development server to preview your changes and ensure they look as expected. +3. **Preview Your Changes**: Use the Vitepress development server to preview + your changes and ensure they look as expected. 4. **Commit and Push Your Changes**: Once you're satisfied with your changes, commit them and push the branch to your forked repository. @@ -67,26 +75,32 @@ Before you start contributing, ensure you have the following prerequisites insta ## Submitting a Pull Request -1. **Create a Pull Request**: Go to the original repository on GitHub and create a new pull request, - comparing your feature branch with the main branch of the original repository. +1. **Create a Pull Request**: Go to the original repository on GitHub and create + a new pull request, comparing your feature branch with the main branch of + the original repository. 2. **Describe Your Changes**: In the pull request description, - provide a clear and concise explanation of the changes you've made and why they are valuable to the project. + provide a clear and concise explanation of the changes you've made and why + they are valuable to the project. -3. **Address Feedback**: The maintainers may request changes or provide feedback on your pull request. - Please be responsive to this feedback and make any necessary updates to your branch. +3. **Address Feedback**: The maintainers may request changes or provide feedback + on your pull request. Please be responsive to this feedback and make any + necessary updates to your branch. ## Coding Style and Guidelines -- Follow the existing coding style and formatting used in the documentation repository. -- Ensure your changes are consistent with the overall tone and voice of the documentation. -- Make use of Vitepress's built-in features, such as frontmatter, custom components, and Markdown extensions, where appropriate. +- Follow the existing coding style and formatting used in the documentation + repository. +- Ensure your changes are consistent with the overall tone and voice of the + documentation. +- Make use of Vitepress's built-in features, such as frontmatter, custom + components, and Markdown extensions, where appropriate. - Write clear and concise documentation that is easy for users to understand. ### Code blocks -For code blocks where multiple languages can be used, vitepress provides a way to -specify blocks for multiple languages. Use the following syntax: +For code blocks where multiple languages can be used, vitepress provides a way +to specify blocks for multiple languages. Use the following syntax: ````md ::: code-group @@ -104,10 +118,12 @@ specify blocks for multiple languages. Use the following syntax: ## Vitepress Markdown Extensions -Vitepress provides a variety of Markdown extensions that can be used to enhance the documentation. -You can find a list of available extensions in the [Vitepress documentation](https://vitepress.dev/guide/markdown). +Vitepress provides a variety of Markdown extensions that can be used to enhance +the documentation. You can find a list of available extensions in +the [Vitepress documentation](https://vitepress.dev/guide/markdown). ## Thank You We appreciate your contributions to the Mockbukkit documentation. -By working together, we can create high-quality, user-friendly documentation that benefits the entire community. +By working together, we can create high-quality, user-friendly documentation +that benefits the entire community. diff --git a/README.md b/README.md index e95129a..3d3eebc 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Mockbukkit Docs -This repository is the place where you can find the code for all documentation provided by the -MockBukkit project. The repository is published under [docs.mockbukkit.org](https://docs.mockbukkit.org). +This repository is the place where you can find the code for all documentation +provided by the MockBukkit project. The repository is published under +[docs.mockbukkit.org](https://docs.mockbukkit.org). ## Getting started -This is how you can get started working on the docs on your local development machine. +This is how you can get started working on the docs on your local development +machine. -### Prerequisites: +### Prerequisites - [node](https://nodejs.org) - [pnpm](https://pnpm.io/) @@ -33,7 +35,8 @@ This is how you can get started working on the docs on your local development ma pnpm docs:build // build for production ``` -In the case of building for production, the site will be generated in the `.vitepress/dist` directory. +In the case of building for production, the site will be generated in the +`.vitepress/dist` directory. ### Previewing @@ -44,15 +47,20 @@ pnpm docs:preview ``` This will start a local server on port 5173. -You can then access the site at http://localhost:5173. +You can then access the site at . ## Contributing -Contributions are welcome! Please read the [contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md) before submitting a pull request. +Contributions are welcome! Please read the + +[contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md) +before submitting a pull request. ## License The MockBukkit documentation is licensed under two licenses: -- Docs: [Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE) -- Supporting Code: [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE) +- Docs: + [Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE) +- Supporting Code: +- [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE) diff --git a/docs/en/contribution/maintainers/pr_guide.md b/docs/en/contribution/maintainers/pr_guide.md index be20332..d06574f 100644 --- a/docs/en/contribution/maintainers/pr_guide.md +++ b/docs/en/contribution/maintainers/pr_guide.md @@ -13,16 +13,20 @@ and attract new people to help drive this project forward! ::: -We use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) -to automatically tag PRs with a version number on merge. This removes the tedious work of keeping version numbers up -to date across several PRs at a time and eliminate Human error. The following custom labels, all of them following the +We +use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) +to automatically tag PRs with a version number on merge. This removes the +tedious work of keeping version numbers up +to date across several PRs at a time and eliminate Human error. The following +custom labels, all of them following the pattern of `release/*`, are used by Mockbukkit: -| Label | Semantic Version Type | | Description | -| -------------------------------------------- | :-------------------- | :-- | :------------------------------------- | -| | Major Version (X.0.0) | | Only used for breaking changes | -| | Minor Version (0.X.0) | | New Features | -| | Patch Version (0.0.X) | | Bugfixes | -| | None (-) | | Method Stubs or non code related fixes | +| Label | Semantic Version Type | | Description | +|----------------------------------------------|:----------------------|:----|:---------------------------------------| +| | Major Version (X.0.0) | | Only used for breaking changes | +| | Minor Version (0.X.0) | | New Features | +| | Patch Version (0.0.X) | | Bugfixes | +| | None (-) | | Method Stubs or non code related fixes | -As you can probably tell, this project uses [Semantic Versioning](https://semver.org/). +As you can probably tell, this project +uses [Semantic Versioning](https://semver.org/). diff --git a/docs/en/user_guide/advanced/adventure.md b/docs/en/user_guide/advanced/adventure.md index 935e2de..8052050 100644 --- a/docs/en/user_guide/advanced/adventure.md +++ b/docs/en/user_guide/advanced/adventure.md @@ -11,7 +11,8 @@ prev: ::: info -This talks about the [Kyori Adventure](https://github.com/KyoriPowered/adventure-platform) Library. +This talks about the +[Kyori Adventure](https://github.com/KyoriPowered/adventure-platform)Library. This has no connection to the Adventure Gamemode ::: @@ -20,10 +21,11 @@ This has no connection to the Adventure Gamemode When using MockBukkit with the non-native implementation of Adventure, you may run into issues with static fields persisting with `Audiences`, -even after executing `MockBukkit.unmock()`. -This can cause undesired issues when running consecutive tests like chat messages not sending. +even after executing `MockBukkit.unmock()`.This can cause undesired issues when +running consecutive tests like chat messages not sending. -The solution is to include a `platform.close()` statement in the `onDisable()` method of your plugin. +The solution is to include a `platform.close()` statement in the `onDisable()` +method of your plugin. ::: code-group diff --git a/docs/en/user_guide/advanced/custom_server_mock.md b/docs/en/user_guide/advanced/custom_server_mock.md index bb9b988..6b889ac 100644 --- a/docs/en/user_guide/advanced/custom_server_mock.md +++ b/docs/en/user_guide/advanced/custom_server_mock.md @@ -11,10 +11,12 @@ next: # Create a Custom Server Mock -Sometimes it may be needed to use a custom implementation of the `ServerMock` class. -This could be if you want to implement some of the unimplemented methods or simply provide your own mocks for certain methods. +Sometimes it may be needed to use a custom implementation of the `ServerMock` +class. This could be if you want to implement some of the unimplemented methods +or simply provide your own mocks for certain methods. -To do that you can simply pass your custom mock that extends `ServerMock` to the `MockBukkit#mock(ServerNock)` method. +To do that you can simply pass your custom mock that extends `ServerMock` to the +`MockBukkit#mock(ServerNock)` method. ::: code-group diff --git a/docs/en/user_guide/advanced/events.md b/docs/en/user_guide/advanced/events.md index ab67b9f..6569e8e 100644 --- a/docs/en/user_guide/advanced/events.md +++ b/docs/en/user_guide/advanced/events.md @@ -11,18 +11,18 @@ next: # Events -Checking the status of events is one of the most common task done by any Bukkit Developer. -Therefore Mockbukkit provides support for these kind of tasks. +Checking the status of events is one of the most common task done by any Bukkit +Developer. Therefore, MockBukkit provides support for these kinds of tasks. ## Asserting that Events were fired -Mockbukkit provides a way to check if Events are fired. -Events are Classes that extend `org.bukkit.event.Event` and are fired by Bukkit. +Mockbukkit provides a way to check if Events are fired.Events are Classes that +extend `org.bukkit.event.Event` and are fired by Bukkit. -To check if an event is fired, -you can use the `PluginManagerMock#assertEventFired(Class)` method. -This method takes a class that extends `org.bukkit.event.Event`. -It will then check if an event of that type was fired. +To check if an event is fired, you can use the +`PluginManagerMock#assertEventFired(Class)`method. This method +takes a class that extends `org.bukkit.event.Event`. It will then check if an +event of that type was fired. ::: code-group @@ -79,8 +79,10 @@ class MyPluginTests { ### Assert Event with specific values -If you want to check if an event was fired with a specific value, -you can use the `PluginManagerMock#assertEventFired(Class, Predicate)` method. +If you want to check if an event was fired with a specific value, you can use +the +`PluginManagerMock#assertEventFired(Class, Predicate)` +method. ::: code-group @@ -139,10 +141,10 @@ class MyPluginTests { ::: -### Custom Failure Message +### Custom Failure Message with `assertEventFired` -You can also set a custom failure message for the assertion -by using the `PluginManagerMock#assertEventFired(Class, String)` method. +You can also set a custom failure message for the assertion by using the +`PluginManagerMock#assertEventFired(Class, String)` method. ::: code-group @@ -199,8 +201,8 @@ class MyPluginTests { ## Asserting that Events were not fired -You can also check if an event was not fired by -using the `PluginManagerMock#assertEventNotFired(Class)` method. +You can also check if an event was not fired by using the +`PluginManagerMock#assertEventNotFired(Class)` method. ::: code-group @@ -253,10 +255,10 @@ class MyPluginTests { } ``` -### Custom Failure Message +### Custom Failure Message with `assertEventNotFired` -You can also set a custom failure message for the assertion by -using the `PluginManagerMock#assertEventNotFired(Class, String)` method. +You can also set a custom failure message for the assertion by using the +`PluginManagerMock#assertEventNotFired(Class, String)` method. ::: code-group diff --git a/docs/en/user_guide/advanced/scheduler.md b/docs/en/user_guide/advanced/scheduler.md index 607c30a..f78a598 100644 --- a/docs/en/user_guide/advanced/scheduler.md +++ b/docs/en/user_guide/advanced/scheduler.md @@ -11,8 +11,9 @@ prev: # Scheduler Mock -MockBukkit allows the testing of timers and delays that are normally created using the Bukkit scheduler. -This schedulers is used in the same way as a normal scheduler except that it adds several extra methods. +MockBukkit allows the testing of timers and delays that are normally created +using the Bukkit scheduler.This schedulers is used in the same way as a normal +scheduler except that it adds several extra methods. ## Executing Ticks @@ -32,8 +33,8 @@ server.scheduler.performOneTick() ::: -If more ticks need to be executed in quick succession, it’s possible to execute many ticks at once. -The following code will perform a hundred ticks. +If more ticks need to be executed in quick succession, it’s possible to execute +many ticks at once. The following code will perform a hundred ticks. ::: code-group @@ -49,11 +50,13 @@ server.scheduler.performTicks(100L) ::: -Using this method executes all ticks in order, as if they were executed on a real server. +Using this method executes all ticks in order, as if they were executed on a +real server. ## Getting the current tick -MockBukkit has an extra method that allows to get the number of ticks since MockBukkit was last started. +MockBukkit has an extra method that allows to get the number of ticks since +MockBukkit was last started. ::: code-group diff --git a/docs/en/user_guide/entities/entity.md b/docs/en/user_guide/entities/entity.md index 2945afb..781ffe7 100644 --- a/docs/en/user_guide/entities/entity.md +++ b/docs/en/user_guide/entities/entity.md @@ -12,16 +12,19 @@ next: # Entities In Spigot and all derivative forks, `Entity` is the parent class of all animals, -mobs and several more things. Therefore it's a common abstraction used in a lot of code. -We added several Methods to our `EntityMock` implementation that will make testing much easier. +mobs and several more things. Therefore it's a common abstraction used in a lot +of code. We added several Methods to our `EntityMock` implementation that will +make testing much easier. -As Entity also implements [MessageTarget](message_target.md), you can also use the methods provided there +As Entity also implements [MessageTarget](message_target.md), you can also use +the methods provided there ## Asserting Location Oftentimes you want to check the Location of an entity. To simply this, Mockbukkit provides the `EntityMock.assertLocation(Location,double)` method. -It allows you to check if the entity is within a given range around the specified `Location` +It allows you to check if the entity is within a given range around the +specified `Location` ::: code-group @@ -78,11 +81,11 @@ fun test_assertTeleported() { ::: -If you want to reset the `teleported` flag, -just call the `EntityMock.clearTeleported()` method +If you want to reset the `teleported` flag, just call the +`EntityMock.clearTeleported()` method -In Bukkit, the only way to move a Entity is by teleporting it. -As this might interfere with tests, we added the `EntityMock.setLocation(location)` method +In Bukkit, the only way to move a Entity is by teleporting it. As this might +interfere with tests, we added the`EntityMock.setLocation(location)` method to move an entity without changing the teleported flag ## Rename an Entity diff --git a/docs/en/user_guide/entities/message_target.md b/docs/en/user_guide/entities/message_target.md index 41a0d94..27488a3 100644 --- a/docs/en/user_guide/entities/message_target.md +++ b/docs/en/user_guide/entities/message_target.md @@ -11,8 +11,9 @@ prev: # MessageTarget -The `MessageTarget` interface is a small interface implemented by methods that can receive messages. -Two examples of message targets are `ConsoleCommandSenderMock` and `EntityMock`. +The `MessageTarget` interface is a small interface implemented by methods that +can receive messages. Two examples of message targets are +`ConsoleCommandSenderMock` and `EntityMock`. ## Using `MessageTarget` @@ -40,7 +41,8 @@ fun test_receive() { ::: -It also contains two assert methods to check if a message was or wasn’t received. +It also contains two assert methods to check if a message was or wasn’t +received. ::: code-group diff --git a/docs/en/user_guide/entities/player.md b/docs/en/user_guide/entities/player.md index 0268ee1..0017513 100644 --- a/docs/en/user_guide/entities/player.md +++ b/docs/en/user_guide/entities/player.md @@ -11,8 +11,8 @@ next: # Player -The `Player` class is the main class for interacting with players in MockBukkit. We provide a mock for it -in form of the `PlayerMock`. +The `Player` class is the main class for interacting with players in MockBukkit. +We provide a mock for it in form of the `PlayerMock`. ## Adding a Player @@ -22,8 +22,8 @@ Mockbukkit has several methods to add players to the test server. #### `ServerMock.addPlayer()` -This method adds a player to the server. It returns a `PlayerMock` object which can be used to interact with the player. -This method creates a random player. +This method adds a player to the server. It returns a `PlayerMock` object which +can be used to interact with the player. This method creates a random player. ::: code-group @@ -56,7 +56,8 @@ val player: PlayerMock = server.addPlayer("Player1") #### `ServerMock.addPlayer(PlayerMock)` If you want to customize the Player object even further, you can specify -the object you want to be added to the Server by providing a `PlayerMock` instance. +the object you want to be added to the Server by providing a `PlayerMock` +instance. ::: code-group @@ -111,13 +112,13 @@ server.setPlayers(20) ::: -After this, you can easily reference these Players with the `Server.getPlayer(int)` method -by specifying the index. +After this, you can easily reference these Players with the +`Server.getPlayer(int)` method by specifying the index. ## PlayerMock Methods -Mockbukkit has added several methods that make unit testing players easier and nicer. -In all examples we assume that your unit Tests starts with +Mockbukkit has added several methods that make unit testing players easier and +nicer. In all examples we assume that your unit Tests starts with ::: code-group @@ -131,17 +132,19 @@ val player = server.addPlayer() ::: -As `PlayerMock` extends the `EntityMock` class, the methods referenced int [Entities](entity.md) also apply. +As `PlayerMock` extends the `EntityMock` class, the methods referenced +int [Entities](entity.md) also apply. -This section isn't an exhaustive list of Methods we have added, please refer to the -[Javadocs](https://javadoc.io/doc/com.github.seeseemelk/MockBukkit-v1.21) for more information. +This section isn't an exhaustive list of Methods we have added, please refer to +the [Javadocs](https://javadoc.io/doc/com.github.seeseemelk/MockBukkit-v1.21) +for more information. ### Asserting the Gamemode of the player A common task is checking the Gamemode a player currently is using. We provide a -convenience Method to make testing these a little bit easier. The `assertGameMode(Gamemode)` -method throws and `AssertionException`, -which will cause the test to fail if the Gamemode is different from the expected one. +convenience Method to make testing these a little bit easier. The +`assertGameMode(Gamemode)`method throws and `AssertionException`, which will +cause the test to fail if the Gamemode is different from the expected one. ::: code-group @@ -157,8 +160,8 @@ player.assertGameMode(GameMode.SURVIVAL) ### Simulate player disconnecting -To simulate a Player disconnecting, use the `disconnect()` method. This will set the -Player as offline but keeps it as an `OfflinePlayer`. +To simulate a Player disconnecting, use the `disconnect()` method. This will set +the Player as offline but keeps it as an `OfflinePlayer`. :::code-group @@ -174,8 +177,9 @@ player.disconnect() ### Simulate a player reconnecting -After a Player has been [disconnected](#simulate-player-disconnecting), it’s possible to simulate a reconnection. -This will set the Player as online and restore it’s full Functionality. +After a Player has been [disconnected](#simulate-player-disconnecting), it’s +possible to simulate a reconnection. This will set the Player as online and +restore it’s full Functionality. :::code-group diff --git a/docs/en/user_guide/introduction/first_test.md b/docs/en/user_guide/introduction/first_test.md index 81088d1..7ec049b 100644 --- a/docs/en/user_guide/introduction/first_test.md +++ b/docs/en/user_guide/introduction/first_test.md @@ -16,21 +16,25 @@ This page will guide you through the process of writing your first test. ## Creating a test class The first step is to create a test class. The convention is to put this class -in the `src/test/java` or `src/test/kotlin` directory, depending on your language of choice. +in the `src/test/java` or `src/test/kotlin` directory, depending on your +language of choice. -Create a new class called `HelloWorldTest.java` in the `src/test/java` directory. +Create a new class called `HelloWorldTest.java` in the `src/test/java` +directory. ::: tip Its common practice to name test classes with the `Test` suffix, so `HelloWorldTest` is a good name if you are writing a test for the `HelloWorld` class. The name doesn't matter, but it's a good convention. -The `Test` suffix helps identify test classes easily, and it's recognized by most build tools and testing frameworks +The `Test` suffix helps identify test classes easily, and it's recognized by +most build tools and testing frameworks for running tests automatically. ::: ::: warning You're class can't be `final`. This is because MockBukkit uses reflection to -modify the behavior of the class under test. In Kotlin, classes are `final` by default, +modify the behavior of the class under test. In Kotlin, classes are `final` by +default, so you must declare them as `open` for MockBukkit to function properly. ::: @@ -98,16 +102,19 @@ class MyPluginTests { Sometimes, you will need to test a method that is not implemented yet. When this happens, MockBukkit will throw an `UnimplementedOperationException`. -This exception extends `TestAbortedException`, so it will cause the test to skip. +This exception extends `TestAbortedException`, so it will cause the test to +skip. These can be ignored, as a skipped test will not affect the overall test result. However, we always welcome any contributions to MockBukkit that implement the missing functionality. If you are interested in contributing, please -read the [Contributing Guide](https://github.com/Mockbukkit/Mockbukkit/blob/master/CONTRIBUTING.md). +read +the [Contributing Guide](https://github.com/Mockbukkit/Mockbukkit/blob/master/CONTRIBUTING.md). ### Example -This shows an example with a Method that at the time of writing is not yet implemented. +This shows an example with a Method that at the time of writing is not yet +implemented. ::: info @@ -132,12 +139,12 @@ import org.bukkit.plugin.java.JavaPlugin; public class DemoPlugin extends JavaPlugin { - @Override +@Override public void onEnable() { getLogger().info("DemoPlugin enabled"); } - @Override + @Override public void onDisable() { getLogger().info("Plugin disabled"); } @@ -241,7 +248,8 @@ class DemoPluginTest { #### Executing the code -Executing the test with Gradle, the task will still succeed, since there are only skipped tests. +Executing the test with Gradle, the task will still succeed, since there are +only skipped tests. ```bash ./gradlew test @@ -249,7 +257,7 @@ Executing the test with Gradle, the task will still succeed, since there are onl ::: details Output -``` +```bash BUILD SUCCESSFUL in 522ms 4 actionable tasks: 4 up-to-date ``` @@ -260,95 +268,95 @@ With `JUnit`'s `assertThrow()` assertion, we can still get the actual error ::: details Exception -``` +```stacktrace Not implemented org.mockbukkit.mockbukkit.UnimplementedOperationException: Not implemented - at app//org.mockbukkit.mockbukkit.WorldMock.createExplosion(WorldMock.java:1928) - at app//org.mockbukkit.docsdemo.DemoPluginTest.lambda$test$0(DemoPluginTest.java:32) - at app//org.junit.jupiter.api.AssertThrows.assertThrows(AssertThrows.java:53) - at app//org.junit.jupiter.api.AssertThrows.assertThrows(AssertThrows.java:35) - at app//org.junit.jupiter.api.Assertions.assertThrows(Assertions.java:3128) - at app//org.mockbukkit.docsdemo.DemoPluginTest.test(DemoPluginTest.java:32) - at java.base@21.0.4/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) - at java.base@21.0.4/java.lang.reflect.Method.invoke(Method.java:580) - at app//org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:766) - at app//org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60) - at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain$ValidatingInvocation.proceed(InvocationInterceptorChain.java:131) - at app//org.junit.jupiter.engine.extension.TimeoutExtension.intercept(TimeoutExtension.java:156) - at app//org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestableMethod(TimeoutExtension.java:147) - at app//org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestMethod(TimeoutExtension.java:86) - at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker$ReflectiveInterceptorCall.lambda$ofVoidMethod$0(InterceptingExecutableInvoker.java:103) - at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.lambda$invoke$0(InterceptingExecutableInvoker.java:93) - at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain$InterceptedInvocation.proceed(InvocationInterceptorChain.java:106) - at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.proceed(InvocationInterceptorChain.java:64) - at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.chainAndInvoke(InvocationInterceptorChain.java:45) - at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.invoke(InvocationInterceptorChain.java:37) - at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.invoke(InterceptingExecutableInvoker.java:92) - at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.invoke(InterceptingExecutableInvoker.java:86) - at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeTestMethod$8(TestMethodTestDescriptor.java:217) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeTestMethod(TestMethodTestDescriptor.java:213) - at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:138) - at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:68) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:156) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) - at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) - at java.base@21.0.4/java.util.ArrayList.forEach(ArrayList.java:1596) - at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:41) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:160) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) - at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) - at java.base@21.0.4/java.util.ArrayList.forEach(ArrayList.java:1596) - at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:41) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:160) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) - at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) - at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) - at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) - at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:35) - at app//org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57) - at app//org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:54) - at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:107) - at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:88) - at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.lambda$execute$0(EngineExecutionOrchestrator.java:54) - at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.withInterceptedStreams(EngineExecutionOrchestrator.java:67) - at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:52) - at app//org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:114) - at app//org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:86) - at app//org.junit.platform.launcher.core.DefaultLauncherSession$DelegatingLauncher.execute(DefaultLauncherSession.java:86) - at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor$CollectAllTestClassesExecutor.processAllTestClasses(JUnitPlatformTestClassProcessor.java:124) - at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor$CollectAllTestClassesExecutor.access$000(JUnitPlatformTestClassProcessor.java:99) - at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor.stop(JUnitPlatformTestClassProcessor.java:94) - at org.gradle.api.internal.tasks.testing.SuiteTestClassProcessor.stop(SuiteTestClassProcessor.java:63) - at java.base@21.0.4/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) - at java.base@21.0.4/java.lang.reflect.Method.invoke(Method.java:580) - at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:36) - at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:24) - at org.gradle.internal.dispatch.ContextClassLoaderDispatch.dispatch(ContextClassLoaderDispatch.java:33) - at org.gradle.internal.dispatch.ProxyDispatchAdapter$DispatchingInvocationHandler.invoke(ProxyDispatchAdapter.java:92) - at jdk.proxy2/jdk.proxy2.$Proxy6.stop(Unknown Source) - at org.gradle.api.internal.tasks.testing.worker.TestWorker$3.run(TestWorker.java:200) - at org.gradle.api.internal.tasks.testing.worker.TestWorker.executeAndMaintainThreadName(TestWorker.java:132) - at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:103) - at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:63) - at org.gradle.process.internal.worker.child.ActionExecutionWorker.execute(ActionExecutionWorker.java:56) - at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:121) - at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:71) - at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.run(GradleWorkerMain.java:69) - at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74) + at app//org.mockbukkit.mockbukkit.WorldMock.createExplosion(WorldMock.java:1928) + at app//org.mockbukkit.docsdemo.DemoPluginTest.lambda$test$0(DemoPluginTest.java:32) + at app//org.junit.jupiter.api.AssertThrows.assertThrows(AssertThrows.java:53) + at app//org.junit.jupiter.api.AssertThrows.assertThrows(AssertThrows.java:35) + at app//org.junit.jupiter.api.Assertions.assertThrows(Assertions.java:3128) + at app//org.mockbukkit.docsdemo.DemoPluginTest.test(DemoPluginTest.java:32) + at java.base@21.0.4/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) + at java.base@21.0.4/java.lang.reflect.Method.invoke(Method.java:580) + at app//org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:766) + at app//org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60) + at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain$ValidatingInvocation.proceed(InvocationInterceptorChain.java:131) + at app//org.junit.jupiter.engine.extension.TimeoutExtension.intercept(TimeoutExtension.java:156) + at app//org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestableMethod(TimeoutExtension.java:147) + at app//org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestMethod(TimeoutExtension.java:86) + at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker$ReflectiveInterceptorCall.lambda$ofVoidMethod$0(InterceptingExecutableInvoker.java:103) + at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.lambda$invoke$0(InterceptingExecutableInvoker.java:93) + at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain$InterceptedInvocation.proceed(InvocationInterceptorChain.java:106) + at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.proceed(InvocationInterceptorChain.java:64) + at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.chainAndInvoke(InvocationInterceptorChain.java:45) + at app//org.junit.jupiter.engine.execution.InvocationInterceptorChain.invoke(InvocationInterceptorChain.java:37) + at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.invoke(InterceptingExecutableInvoker.java:92) + at app//org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.invoke(InterceptingExecutableInvoker.java:86) + at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeTestMethod$8(TestMethodTestDescriptor.java:217) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeTestMethod(TestMethodTestDescriptor.java:213) + at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:138) + at app//org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:68) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:156) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) + at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) + at java.base@21.0.4/java.util.ArrayList.forEach(ArrayList.java:1596) + at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:41) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:160) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) + at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) + at java.base@21.0.4/java.util.ArrayList.forEach(ArrayList.java:1596) + at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:41) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$6(NodeTestTask.java:160) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:146) + at app//org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$9(NodeTestTask.java:144) + at app//org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:143) + at app//org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:100) + at app//org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:35) + at app//org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57) + at app//org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:54) + at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:107) + at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:88) + at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.lambda$execute$0(EngineExecutionOrchestrator.java:54) + at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.withInterceptedStreams(EngineExecutionOrchestrator.java:67) + at app//org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:52) + at app//org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:114) + at app//org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:86) + at app//org.junit.platform.launcher.core.DefaultLauncherSession$DelegatingLauncher.execute(DefaultLauncherSession.java:86) + at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor$CollectAllTestClassesExecutor.processAllTestClasses(JUnitPlatformTestClassProcessor.java:124) + at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor$CollectAllTestClassesExecutor.access$000(JUnitPlatformTestClassProcessor.java:99) + at org.gradle.api.internal.tasks.testing.junitplatform.JUnitPlatformTestClassProcessor.stop(JUnitPlatformTestClassProcessor.java:94) + at org.gradle.api.internal.tasks.testing.SuiteTestClassProcessor.stop(SuiteTestClassProcessor.java:63) + at java.base@21.0.4/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) + at java.base@21.0.4/java.lang.reflect.Method.invoke(Method.java:580) + at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:36) + at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:24) + at org.gradle.internal.dispatch.ContextClassLoaderDispatch.dispatch(ContextClassLoaderDispatch.java:33) + at org.gradle.internal.dispatch.ProxyDispatchAdapter$DispatchingInvocationHandler.invoke(ProxyDispatchAdapter.java:92) + at jdk.proxy2/jdk.proxy2.$Proxy6.stop(Unknown Source) + at org.gradle.api.internal.tasks.testing.worker.TestWorker$3.run(TestWorker.java:200) + at org.gradle.api.internal.tasks.testing.worker.TestWorker.executeAndMaintainThreadName(TestWorker.java:132) + at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:103) + at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:63) + at org.gradle.process.internal.worker.child.ActionExecutionWorker.execute(ActionExecutionWorker.java:56) + at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:121) + at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:71) + at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.run(GradleWorkerMain.java:69) + at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74) ``` ::: diff --git a/docs/en/user_guide/introduction/getting_started.md b/docs/en/user_guide/introduction/getting_started.md index a27f572..62ab4df 100644 --- a/docs/en/user_guide/introduction/getting_started.md +++ b/docs/en/user_guide/introduction/getting_started.md @@ -11,26 +11,29 @@ next: In order to use MockBukkit, you first have to integrate it into your build tool. You will also need to know which version of MockBukkit to use. MockBukkit version numbering can be a little bit confusing. -The most important thing to remember is that each version of MockBukkit is named after -the version of Bukkit it implements, followed by the version number of MockBukkit itself. +The most important thing to remember is that each version of MockBukkit is named +after the version of Bukkit it implements, followed by the version number of +MockBukkit itself. -For instance: `MockBukkit-v1.21 ` is the `` -release of MockBukkit, targeting plugins build for Minecraft 1.21. -The latest stable version can always be found on +For instance: `MockBukkit-v1.21 ` is the +``release of MockBukkit, targeting plugins build for +Minecraft 1.21. The latest stable version can always be found on [Maven Central](https://search.maven.org/search?q=MockBukkit). ## Installing MockBukkit -If you are new to Maven or Gradle, visit either the [Maven Install Guide](https://maven.apache.org/install.html) or +If you are new to Maven or Gradle, visit either +the [Maven Install Guide](https://maven.apache.org/install.html) or the [Gradle installation guide](https://docs.gradle.org/current/userguide/installation.html) to set up your build tool -MockBukkit is available on Maven Central, so you can use the following dependency -in your build tool of choice: +MockBukkit is available on Maven Central, so you can use the following +dependency in your build tool of choice: ::: code-group ```xml [Maven] + org.mockbukkit.mockbukkit @@ -57,8 +60,9 @@ dependencies { ## Running MockBukkit -MockBukkit is a test framework, so you will need to run your tests using a test runner. -Mockbukkit recommends using the [JUnit](https://junit.org/junit5/) test runner. +MockBukkit is a test framework, so you will need to run your tests using a test +runner.Mockbukkit recommends using the +[JUnit](https://junit.org/junit5/) test runner. You can run your tests using the following command: diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md index 28a3ed6..dae2051 100644 --- a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md +++ b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md @@ -5,30 +5,40 @@ next: text: "Migrate to Mockbukkit 4 using OpenRewrite" link: "/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.html" --- + # Migrate to Mockbukkit 4 ::: tip We have OpenRewrite Recipes for this migration. You can more information -on the page for the [OpenRewrite Migration for v4](migrate_mockbukkit_4.0_openrewrite.md) +on the page for +the [OpenRewrite Migration for v4](migrate_mockbukkit_4.0_openrewrite.md) ::: -The 4.0 release includes a large refactor, where the root package and many classnames have changed. +The 4.0 release includes a large refactor, where the root package and many +classnames have changed. All features that had previously been marked for removal has now been removed. ## Renaming packages -Package names were renamed from `be.seeseemelk.mockbukkit` to `org.mockbukkit.mockbukkit`. -If you prefer to do the migration manually, we suggest you to execute a _find and replace_. +Package names were renamed from `be.seeseemelk.mockbukkit` to +`org.mockbukkit.mockbukkit`. +If you prefer to do the migration manually, we suggest you to execute a _find +and replace_. ## Renaming classes Some class names have been renamed for easier interpretation. -The table below creates a mapping between the class names from version 3 and the version 4. +The table below creates a mapping between the class names from version 3 and the +version 4. | v3 | v4 | -| --------------------------------------------------------- | --------------------------------------------------------------- | +|-----------------------------------------------------------|-----------------------------------------------------------------| | be.seeseemelk.mockbukkit.ban.MockIpBanEntry | org.mockbukkit.mockbukkit.ban.IpbanEntryMock | | be.seeseemelk.mockbukkit.ban.MockIpBanEList | org.mockbukkit.mockbukkit.ban.IpbanListMock | | be.seeseemelk.mockbukkit.block.data.AmethystClusterMock | org.mockbukkit.mockbukkit.block.data.AmethystClusterDataMock | diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md index acf8300..ce232df 100644 --- a/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md +++ b/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.md @@ -9,9 +9,12 @@ prev: # Migrate to Mockbukkit 4 using OpenRewrite -Migration to version 4 was carefully automated by the MockBukkit team using OpenRewrite scripts to facilitate the migration process. To run the scripts, follow the steps for your package manager. +Migration to version 4 was carefully automated by the MockBukkit team using +OpenRewrite scripts to facilitate the migration process. To run the scripts, +follow the steps for your package manager. -If you are using Maven, you can do the migration by executing the following command: +If you are using Maven, you can do the migration by executing the following +command: ::: code-group @@ -23,11 +26,13 @@ mvn org.openrewrite.maven:rewrite-maven-plugin:run \ ::: -Otherwise, you will need to add OpenRewrite plugin to your project with the correct configuration: +Otherwise, you will need to add OpenRewrite plugin to your project with the +correct configuration: ::: code-group ```xml [Maven] + org.openrewrite.maven From 68bcf54bb15e8470fc3074abd2b78fa0e5b7c1e6 Mon Sep 17 00:00:00 2001 From: thelooter Date: Tue, 5 Nov 2024 21:08:56 +0100 Subject: [PATCH 7/8] fix(lint): fix remaining issues --- .github/workflows/build.yaml | 2 ++ .markdownlint.jsonc | 9 --------- .markdownlint.yaml | 6 ++++++ README.md | 2 ++ docs/en/user_guide/migration/migrate_mockbukkit_4.0.md | 3 ++- package.json | 2 +- 6 files changed, 13 insertions(+), 11 deletions(-) delete mode 100644 .markdownlint.jsonc create mode 100644 .markdownlint.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 42cf010..13530ca 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -9,6 +9,8 @@ on: branches: - main +permissions: read-all + jobs: build: runs-on: ubuntu-22.04 diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc deleted file mode 100644 index 11acbf4..0000000 --- a/.markdownlint.jsonc +++ /dev/null @@ -1,9 +0,0 @@ -{ - "default": true, - "MD013": { - "code_block_line_length": 120 - }, - "MD025": { - "front_matter_title": "" - } -} diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..fe9d088 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,6 @@ +--- +default: true +MD013: + code_block_line_length: 120 +MD025: + front_matter_title: "" diff --git a/README.md b/README.md index 3d3eebc..a87900a 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,9 @@ You can then access the site at . ## Contributing Contributions are welcome! Please read the + + [contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md) before submitting a pull request. diff --git a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md index dae2051..7eae6ab 100644 --- a/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md +++ b/docs/en/user_guide/migration/migrate_mockbukkit_4.0.md @@ -5,6 +5,7 @@ next: text: "Migrate to Mockbukkit 4 using OpenRewrite" link: "/docs/en/user_guide/migration/migrate_mockbukkit_4.0_openrewrite.html" --- +