Skip to content

Improve config comments & ordering - #6108

Merged
mdcfe merged 21 commits into
EssentialsX:2.xfrom
JasonHorkles:2.x
May 18, 2025
Merged

Improve config comments & ordering#6108
mdcfe merged 21 commits into
EssentialsX:2.xfrom
JasonHorkles:2.x

Conversation

@JasonHorkles

@JasonHorklesJasonHorkles commented Mar 24, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

This PR significantly overhauls the comments of the EssentialsX configuration files, ensuring consistency, clarity, and overall improved grammar (validated by Grammarly and LLMs). There are still a few things that must be completed before this is ready to be merged, but no further significant changes are expected. A couple of options have been moved entirely to make more logical sense, but this will not affect any compatibility.

Remaining tasks:

  • Ensure permission consistency when surrounded by apostrophes
  • Make quotation and apostrophes consistent (values, permissions, and config references surrounded by apostrophes. Names/examples surrounded by quotes)
  • Make 'permissions plugin' be consistent (vs 'permission plugin')
  • Ensure consistent indentation
  • Lowercase mob names (if any remain)
  • Replace 'users' with 'players'
  • Ensure consistent 'above' and 'below' formatting (either make all or none of them surrounded by parentheses)
  • Pull new changes and repeat above steps
  • Separate commit: Add 'default' comment to every option (decided this is unnecessary and instead added a link to the default config)
  • Implement requested changes

@JasonHorkles
Move add-prefix-suffix above the playerlist settings
7863616
This makes a bit more logical sense in the ordering
@JasonHorkles
Sort SocialSpy commands alphabetically
b50a7c6
@JasonHorkles
enabledSigns ordering
42e0520
This adds slightly more logical ordering to the sign list, keeping them in related groups while sorting them alphabetically. Full alphabetical feels a bit messy, but could still be a valid option.
@JasonHorkles
Initial pass
2caf453
@JasonHorkles
Pass 2
a9e74c8
Includes permissions/files/keys surrounded by apostrophes, 'user' references replaced with 'player' (where appropriate), and additional grammatical fixes.
@JasonHorkles
Pass 3
44cb89e
Almost there! Includes consistency with apostrophes and quotation marks, fixes some capitalization, and changes references of 'permission plugin' to 'permissions plugin' (naming verified by LuckPerms)
@JasonHorkles
Ensure consistent indentation
760dfc9
@JasonHorkles
Pass 4
1ee959d
@JasonHorkles
Merge branch 'EssentialsX:2.x' into 2.x
69b56cf
@JasonHorkles
Update pulled changes
fbc185c
@JasonHorkles
Split to new line
30db0db
@JasonHorkles
Add missing #
5efed87
@JasonHorkles
Move displayname disclaimer
1bfe8ac
@JasonHorkles
Remove "default" messages and add note to top
210cc45
@JasonHorkles
JasonHorkles marked this pull request as ready for review March 27, 2025 00:21
CopilotAI reviewed Mar 27, 2025
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the configuration file comments for EssentialsX, enhancing clarity, consistency, and punctuation across several resource files.

  • Enhanced phrasing and punctuation in kit configuration.
  • Standardized comment styles in custom item, worth, and teleport configurations.
  • Updated URLs and command syntax for clarity.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

FileDescription
Essentials/src/main/resources/kits.ymlImproved comment phrasing and ordering
Essentials/src/main/resources/custom_items.ymlUpdated comment clarity on alias limitations
Essentials/src/main/resources/worth.ymlRefined wording of worth configuration comments
Essentials/src/main/resources/tpr.ymlClarified command syntax in the teleport config

@JasonHorkles
JasonHorkles marked this pull request as draft March 31, 2025 18:33
@JasonHorkles
JasonHorkles marked this pull request as ready for review March 31, 2025 18:41
@mdcfemdcfe modified the milestones: 2.21.2, 2.21.1Apr 19, 2025
mdcfe
mdcfe requested changes May 3, 2025
View reviewed changes
Comment threadEssentials/src/main/resources/worth.yml
Comment threadEssentials/src/main/resources/config.yml
Comment threadEssentials/src/main/resources/config.yml Outdated
Comment threadEssentials/src/main/resources/config.yml Outdated
Comment threadEssentials/src/main/resources/config.yml Outdated
Comment threadEssentials/src/main/resources/config.yml Outdated
Comment threadEssentials/src/main/resources/config.yml Outdated
Comment threadEssentials/src/main/resources/config.yml
Comment threadEssentials/src/main/resources/config.yml
Comment threadEssentials/src/main/resources/config.yml
JasonHorklesand others added 3 commits May 4, 2025 23:35
@JasonHorkles@mdcfe
Apply suggestions from code review
eacfef1
Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>
@JasonHorkles
Apply suggestions
d01a6bf
@JasonHorkles@mdcfe
Update Essentials/src/main/resources/config.yml
4b96884
Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>
mdcfe
mdcfe requested changes May 10, 2025
View reviewed changes
Comment threadEssentials/src/main/resources/config.yml
JasonHorklesand others added 2 commits May 10, 2025 07:46
@JasonHorkles@mdcfe
Update Essentials/src/main/resources/config.yml
c9ace52
Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>
@mdcfe
Merge branch '2.x' into 2.x
739c966
@mdcfemdcfe added the type: enhancement Features and feature requests. label May 18, 2025
@mdcfe
mdcfe enabled auto-merge (squash) May 18, 2025 08:26
@mdcfe
mdcfe merged commit d137031 into EssentialsX:2.xMay 18, 2025
Euphillya added a commit to Euphillya/Essentials-Folia that referenced this pull request Jun 27, 2025
@Euphillya
Update Upstream EssentialsX:
1070216
EssentialsX@40540eb Expose IUser#getLastActivityTime to API (EssentialsX#6101)
EssentialsX@50b696b Adds social spy message type for in EssentialsDiscord (EssentialsX#5620)
EssentialsX@dabe687 Add SignTransactionEvent for buy and sell signs (EssentialsX#6071)
EssentialsX@0cb387f Fix NPE when unlinking offline players (EssentialsX#6111)
EssentialsX@f09541c Update to Minecraft 1.21.5 (EssentialsX#6109)
EssentialsX@c7ff994 Fire GlobalChatEvent even when local chat is disabled (EssentialsX#6113)
EssentialsX@06c886c Fix /baltop on 1.15.2 and below (EssentialsX#6115)
EssentialsX@2bb4438 Fix further trade sign validation mismatches (EssentialsX#6116)
EssentialsX@8455212 Fix /spawnmob on < 1.21.5 (EssentialsX#6121)
EssentialsX@be3e641 New Crowdin updates (EssentialsX#6089)
EssentialsX@3f5b122 Use legacy text for TranslatableException#getMessage (EssentialsX#6134)
EssentialsX@fe43017 Fix heer typo in messages_en.properties (EssentialsX#6135)
EssentialsX@a58db23 Update English source strings with fixes from Crowdin (EssentialsX#6140)
EssentialsX@d137031 Improve config comments & ordering (EssentialsX#6108)
EssentialsX@3b0c229 New Crowdin updates (EssentialsX#6131)
EssentialsX@3fe1495 Fix unexpected behavior with essentials.home.bed & essentials.sethome.bed permissions (EssentialsX#5991)
EssentialsX@aebe851 Fix double messages when deleting a non-existent home (EssentialsX#6150)
EssentialsX@3a5c7c4 Revert changes to /home and /sethome that break bed interactions (EssentialsX#6151)
EssentialsX@3d28d82 Release 2.21.1
EssentialsX@e836747 Prepare for 2.21.2 dev builds (EssentialsX#6128)
EssentialsX@d42347f Fix sending message during /editsign paste if SignChangeEvent is cancelled (EssentialsX#6136)
EssentialsX@997f600 Update adventure dependencies (EssentialsX#6163)
EssentialsX@4057326 Update to Minecraft 1.21.6
EssentialsX@2796399 Add 1.21.6 Mobs
EssentialsX@31ea903 Move tests to MockBukkit
EssentialsX@ff1b8b8 Add 1.21.6 Aliases
@JRoyJRoy mentioned this pull request Jun 28, 2025
Closed
This was referenced Jun 29, 2025
Open
Open
Open
Open
rewsdjad1 pushed a commit to rewsdjad1/EssentialsXPlus that referenced this pull request Aug 13, 2026
@JasonHorkles
Improve config comments & ordering (EssentialsX#6108)
f4b2e87
Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>
This PR significantly overhauls the comments of the EssentialsX configuration files, ensuring consistency, clarity, and overall improved grammar (validated by Grammarly and LLMs). There are still a few things that must be completed before this is ready to be merged, but no further significant changes are expected. A couple of options have been moved entirely to make more logical sense, but this will not affect any compatibility.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@mdcfemdcfemdcfe approved these changes

Assignees

No one assigned

Labels

type: enhancementFeatures and feature requests.

Projects

None yet

Milestone

2.21.1

Development

Successfully merging this pull request may close these issues.

3 participants

@JasonHorkles@mdcfe