Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sapphire Version 1 Completed #2

Open
wants to merge 68 commits into
base: production
Choose a base branch
from
Open

Sapphire Version 1 Completed #2

wants to merge 68 commits into from

Conversation

demitchell14
Copy link
Member

@demitchell14 demitchell14 commented Sep 11, 2021 •
edited
Loading

Features as of cb0aa3e (Commits on Sep 10, 2021)

  1. At startup, the bot connects the database, creates tables if necessary, migrates if necessary.
  2. It will load all punishments that are possible to give out into a cache.
  3. It will start an internal synchronization loop that will check all latest/active punishments, if a punishment should be disabled, it will unban/unmute the person.
  4. It has 2 commands that are usable by ping-protected users.
    a. extend [time in minutes] which will create a timeframe that users will be able to ping. One catch currently is that if the user speaks after running the command, the time will reset to the default time that people have to ping the user.
    b. clear which will immediately stop allowing pings.
  5. It has 4 punishment related commands that are usable by users with one of the moderatorRoles
    a. punishments help shows commands that you can use
    b. punishments list shows all punishments that have been created. Each user or role has its own embed with a list of punishments
    c. punishments create which allows you to create a punishment. Entering the shown command will show you the full command context
    d. punishments remove which allows you to remove a punishment. Entering the shown command will show you the full command context
  6. If a ping-protected user is pinged while not around, they will receive a punishment.
    a. Punishments are created by staff, with increasing levels of punishment.
    b. The punishment the user receives is based on how many punishments they've received prior and how many punishments have been created. This means if there are 5 punishments created, and the user has been punished once, they will receive the second priority punishment.
    c. moderatorRoles, notifyChannels, excludedChannels are not effected,
    d. In order to use the mute punishment, a muteRole must be configured.
    e. If the user that performed a ping has lenientRoles, they will receive a different set of punishments. If no lenient punishments are created, they will still get the standard punishments.
  7. If a ping-protected user speaks in a chat other than notifyChannels and excludedChannels a few things happen.
    a. A message is sent out to notifyChannels that pings notifyRoles telling them that the user is around. It also gives a link to their first post.
    b. The bot stores the timestamp of the message along with notifyTimeout time in minutes in the database. This is the time that ping-protected user will no longer be able to be pinged.

As of now, I still need to do clean up.. but I feel like we could probably do some testing.

added comments, did a little bit of cleanup, and added command documentation MD

demitchell14 and others added 30 commits July 23, 2021 22:24
@demitchell14
added initial pass on punishments table
e5abfe7 
includes a userid, punishment end date, created date, and an optional expiration date

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
allowed endsAt to be null and userId to be a string
c2a08c3 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added PunishmentController to handle sending discord messages and upd…
0fe64fd 
…ating the punishment database table

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added lenientRoles
e62c0e3 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added active flag, getAllActive() function, getAllLatest() function
a68c54e 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
initial synchronization pass
c623719 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added guild ID to config
e99d3c1 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
punishments now take place immediately instead of relying solely on s…
44da7c3 
…ynchronization

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
switched from Commando to Sapphire framework
400bacf 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
implemented new logger
b5e94e8 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
updated logger
dc07b7b 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
Merge branch 'punshments' into sapphire
dc382b7 
# Conflicts:
#	src/Bot.ts
#	src/config/bot.ts
#	src/controllers/PingController.ts
#	src/database/database.ts
@demitchell14
bugfix
fe07321 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
lintfixes
8c8716f 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
upgraded to @sapphire/framework@next to utilize Discord 13
37ec200 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
first pass on changing how punishments work.
c5350fa 
punishments will use a punishment table now that includes type (ban, mute, kick), length of punishment, and target type (role or user currently are the options)

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added dryrun and muteRole configuration
e81d3c2 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added a clean script and attached it to the build process
0e9736a 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed standard punishments as they are redundant since we will be u…
e28638b 
…sing the user type

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
renamed punishments to punishment history
a04679d 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added start of punishments table which will contain all types of puni…
df2d5bd 
…shments that the bot can give out

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
updated how errors are implemented
6ab0f46 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
updated how errors are implemented
825b0f8 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
refactored types and added a second unique index
40fdb0b 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
Start of command passed punishment management
7f1b005 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed the block config
2e13518 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
changed db
749795d 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
made minutes optional
a45a04e 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
changed init and changed message
7bce85f 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
now fetches punishments from database and added isMonitoredUser funct…
bd7e953 
…ion to check if the message author is a monitored user

Signed-off-by: Devin Mitchell <[email protected]>
demitchell14 and others added 27 commits September 10, 2021 19:42
@demitchell14
refactored isMonitoredUser(message) to isMonitoredMember(author) for …
b7e7799 
…more generic use

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
punishment commands can only be executed by authorize users (moderators)
8bd813d 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed unused listener
a8e1c64 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added parseUserOrRole function to parse a user or role into a discord…
fa585c0 
… mention

fixed minutesToReadable

Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed null type from results
0b28fbe 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added index to parse
56ecc41 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed types and added getPunishmment function
0853be8 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
import update
b336f03 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added help, for, and list commands
83ab9c3 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
removed intent
b80b44d 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added ability to remove a punishment
7c72506 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
refactored getRoleOrUser out
90d3ff8 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added remove command
cb0aa3e 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
punishments only sync when changed
18d9a30 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added order by
6ba6d66 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
bugfix
c7e2060 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
prettier
3a309e4 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
eslint fixes
1b32d5b 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added kick functionality
79fe0a1 
Signed-off-by: Devin Mitchell <[email protected]>
@demitchell14
added documentation
3f064c2 
Signed-off-by: Devin <[email protected]>
@demitchell14
refactored to MessageCreate as Message is deprecated
3471c59 
Signed-off-by: Devin <[email protected]>
@demitchell14
prettier lint fix
515b584 
Signed-off-by: Devin <[email protected]>
@demitchell14
reimplemented notification removal
1106d06 
Signed-off-by: Devin <[email protected]>
@demitchell14
updated docs
7f4470e 
Signed-off-by: Devin <[email protected]>
@demitchell14
added esling workflow
74fb47c 
Signed-off-by: Devin <[email protected]>
@demitchell14
removed dummy ping command
ae7d222 
Signed-off-by: Devin <[email protected]>
@demitchell14
Update commands.md
2a3019c
@demitchell14 demitchell14 marked this pull request as ready for review October 1, 2021 05:06
@demitchell14
lintfix
3235714 
Signed-off-by: Devin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AltF02 AltF02 Awaiting requested review from AltF02

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@demitchell14