ctome
/
hullcss-discord-bot
mirror of https://github.com/CrimsonTome/hullcss-discord-bot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: Run format

imgbot
KieranRobson 2022-12-05 22:44:54 +00:00
parent 587d4cad63
commit 2ca899d9d8
17 changed files with 212 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
.cspell.json
View File

@ -1,63 +1,63 @@
{
"language": "en",
"ignorePaths": [
".firebase/**",
".github/**",
".yarn/**",
"dist/**",
"node_modules/**"
],
"dictionaries": [
"bash",
"companies",
"cpp",
"cpp",
"cryptocurrencies",
"css",
"docker",
"en_GB",
"en_US",
"entities",
"filetypes",
"fonts",
"fullstack",
"html",
"misc",
"node",
"npm",
"npm",
"rust",
"softwareTerms",
"softwareTerms",
"typescript"
],
"words": [
"ACWPing",
"addemoji",
"courserep",
"deletemessage",
"execchannel",
"freeside",
"gorb",
"gorbcelebration",
"gorbchristmas",
"gorbcs",
"gorblarge",
"gorbstorm",
"guildmember",
"Hullcss",
"Kieran",
"kieranr",
"lampadaferens",
"nukepaid",
"organising",
"Ouroboros",
"paidmember",
"robsoc",
"studentname",
"studentnumber",
"Tldr",
"usefullinks",
"welcomechannel"
]
"language": "en",
"ignorePaths": [
".firebase/**",
".github/**",
".yarn/**",
"dist/**",
"node_modules/**"
],
"dictionaries": [
"bash",
"companies",
"cpp",
"cpp",
"cryptocurrencies",
"css",
"docker",
"en_GB",
"en_US",
"entities",
"filetypes",
"fonts",
"fullstack",
"html",
"misc",
"node",
"npm",
"npm",
"rust",
"softwareTerms",
"softwareTerms",
"typescript"
],
"words": [
"ACWPing",
"addemoji",
"courserep",
"deletemessage",
"execchannel",
"freeside",
"gorb",
"gorbcelebration",
"gorbchristmas",
"gorbcs",
"gorblarge",
"gorbstorm",
"guildmember",
"Hullcss",
"Kieran",
"kieranr",
"lampadaferens",
"nukepaid",
"organising",
"Ouroboros",
"paidmember",
"robsoc",
"studentname",
"studentnumber",
"Tldr",
"usefullinks",
"welcomechannel"
]
}

48
.eslintrc.json
View File

@ -1,25 +1,25 @@
{
"env": {
"node": true,
"commonjs": true,
"es2021": true
},
"extends": ["eslint:recommended", "plugin:prettier/recommended"],
"parserOptions": {
"ecmaVersion": "latest"
},
"rules": {
"prettier/prettier": "error",
"no-unused-vars": "warn",
"no-console": "off",
"func-names": "off",
"no-process-exit": "off",
"object-shorthand": "off",
"class-methods-use-this": "off",
"eqeqeq": "off",
"node/no-unsupported-features/es-syntax": "off",
"consistent-return": "off",
"no-plusplus": "off",
"no-underscore-dangle": "off"
}
}
"env": {
"node": true,
"commonjs": true,
"es2021": true
},
"extends": ["eslint:recommended", "plugin:prettier/recommended"],
"parserOptions": {
"ecmaVersion": "latest"
},
"rules": {
"prettier/prettier": "error",
"no-unused-vars": "warn",
"no-console": "off",
"func-names": "off",
"no-process-exit": "off",
"object-shorthand": "off",
"class-methods-use-this": "off",
"eqeqeq": "off",
"node/no-unsupported-features/es-syntax": "off",
"consistent-return": "off",
"no-plusplus": "off",
"no-underscore-dangle": "off"
}
}

20
.github/CODE_OF_CONDUCT.md vendored
View File

@ -19,23 +19,23 @@ HullCSS is a society under [HUSU](hulluniunion.com/), where possible we will abi
Examples of behavior that contributes to a positive environment for our
community include:
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- 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
- Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* Submitting malicious or poor quality pull requests.
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment (joking is ok)
* Publishing others' private information, such as a physical or email
- Submitting malicious or poor quality pull requests.
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment (joking is ok)
- 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
## Contacting
Kieran Robson is available to talk to on Discord @ Kieran#Kieran#0891 and the exec team are able to contact at our [Discord server](https://discord.gg/skEu7mutK6)

68
.github/CONTRIBUTING.md vendored
View File

@ -1,52 +1,60 @@
# Contributing guidelines for the HullCSS Discord Bot
Thank you for contributing to the HullCSS Discord Bot repo, here are some guidelines to try follow when making changes. If you are unsure as to what to do after reading these please contact Kieran Robson on Discord @ Kieran#0891 in the [HullCSS Discord server](https://discord.gg/skEu7mutK6). Or contact the Webmaster found under the @Webmaster role
1. Each feature needs to have its own Pull Request (PR)
2. Any large changes must be discussed in an Issue first
3. If you have write permissions over the repo
- make sure you have GitHub 2FA
- make a new branch for your commits before merging into main, or still please use PRs (unless you are the primary maintainer)
- If possible also gpg sign your commits
4. Please see the [Security Policy](https://github.com/hullcss/CONTRIBUTING/blob/main/SECURITY.md) for detais of what to do if you find any issues that are security related
3. If you have write permissions over the repo
- make sure you have GitHub 2FA
- make a new branch for your commits before merging into main, or still please use PRs (unless you are the primary maintainer)
- If possible also gpg sign your commits
4. Please see the [Security Policy](https://github.com/hullcss/CONTRIBUTING/blob/main/SECURITY.md) for detais of what to do if you find any issues that are security related
# How to contribute
## Forking
* Press the fork icon in the top right hand corner.
* Name your fork of the repo
* Press save
- Press the fork icon in the top right hand corner.
- Name your fork of the repo
- Press save
Congratulations, you now have created a fork of the repo!
## Making changes
Changes can be made in many different ways in many different ways
### Editing in the browser
* Head to the repo
* Press the pencil icon in the file
* Make changes
* Scroll to the bottom and add a meaningful title and description
* Press commit changes
- Head to the repo
- Press the pencil icon in the file
- Make changes
- Scroll to the bottom and add a meaningful title and description
- Press commit changes
### Editing in Visual Studio Code
* Press the green button which says `code`
* Copy the HTML URL
* Head to VS Code and open a new window
* Choose `Clone Github Repository`
* Choose where youd like to store the local repo on your machine
* Open the file and make changes
* Press the fork icon on the left side bar
* Enter a message
* Click the tick
* Press sync changes
### Opening a pull request
* Head to your newly changed repo
* Press contribute on the banner above the code
* Press `Open Pull Request`
* Enter any other details into the input boxes
* Press `Create Pull Request`
- Press the green button which says `code`
- Copy the HTML URL
- Head to VS Code and open a new window
- Choose `Clone Github Repository`
- Choose where youd like to store the local repo on your machine
- Open the file and make changes
- Press the fork icon on the left side bar
- Enter a message
- Click the tick
- Press sync changes
### Opening a pull request
- Head to your newly changed repo
- Press contribute on the banner above the code
- Press `Open Pull Request`
- Enter any other details into the input boxes
- Press `Create Pull Request`
### What happens next?
Admins will look into your commit(s) and may suggest changes. If changes do need to be made, do not make a new pull request, instead just commit to your repo and the new changes will appear.
If no changes need to be made, then your commits will be merged!

5
.github/ISSUE_TEMPLATE/bug-report.md vendored
View File

@ -6,12 +6,13 @@ labels: ['bug']
---
### Bug Description
_A clear and concise description of what the problem is_
### Expected Result
_A clear and concise description of what the expected result is_
### Actual Result
_A clear and concise description of what the actual result is_

6
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@ -6,13 +6,17 @@ labels: ['enhancement']
---
### Is your feature request related to a problem?
_A clear and concise description of what the problem is, e.g. I'm always frustrated when [...]._
### What solution would you like?
_A clear and concise description of what you want to happen._
### What alternatives have you considered?
_A clear and concise description of any alternative solutions or features you've considered._
### Do you have any additional context?
_Add any other context or screenshots about the feature request here._
_Add any other context or screenshots about the feature request here._

26
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,23 +1,15 @@
* **Please check if the PR fulfills these requirements**
- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- **Please check if the PR fulfills these requirements**
* [ ] The commit message follows our guidelines
* [ ] Tests for the changes have been added (for bug fixes / features)
* [ ] Docs have been added / updated (for bug fixes / features)
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
- **What is the current behavior?** (You can also link to an open issue here)
- **What is the new behavior (if this is a feature change)?**
* **What is the current behavior?** (You can also link to an open issue here)
- **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
* **What is the new behavior (if this is a feature change)?**
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
* **Other information**:
- **Other information**:

6
.github/dependabot.yml vendored
View File

@ -9,7 +9,7 @@ updates:
directory: '/' # Location of package manifests
schedule:
interval: 'daily'
time: "07:00"
time: '07:00'
rebase-strategy: 'auto'
ignore:
- dependency-name: '*'
@ -19,11 +19,11 @@ updates:
directory: '/'
schedule:
interval: 'daily'
time: "07:00"
time: '07:00'
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
# Check for updates to GitHub Actions every week
interval: 'weekly'
time: "07:00"
time: '07:00'

2
.github/workflows/alex.yml vendored
View File

@ -20,4 +20,4 @@ jobs:
no_binary: false
profanity_sureness: 2
pr_only: false
glob_pattern: 'services/**'
glob_pattern: 'services/**'

2
.github/workflows/lint.yml vendored
View File

@ -12,4 +12,4 @@ jobs:
cache: yarn
- run: yarn
- run: yarn run lint-ci
- run: yarn run lint-ci

8
.github/workflows/publish.yml vendored
View File

@ -20,20 +20,20 @@ jobs:
steps:
- name: Check out the repo
uses: actions/checkout@v3
- name: Log in to Docker Hub
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
- name: Log in to the Container registry
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@57396166ad8aefe6098280995947635806a0e6ea
@ -41,7 +41,7 @@ jobs:
images: |
${{ secrets.DOCKERHUB_USERNAME }}/hullcss
ghcr.io/${{ github.repository }}
- name: Build and push Docker images
uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5
with:

2
.github/workflows/spell.yml vendored
View File

@ -8,4 +8,4 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: streetsidesoftware/cspell-action@v2.13.0
- uses: streetsidesoftware/cspell-action@v2.13.0

10
.prettierrc
View File

@ -1,6 +1,6 @@
{
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"useTabs": true
}
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"useTabs": true
}

30
README.md
View File

@ -2,7 +2,6 @@
<img src="https://user-images.githubusercontent.com/32241933/176943810-d3016868-d91b-49cc-9461-ae01b7ffa44d.png" width="150" height="150">
## HullCSS Discord Bot
This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server.
@ -16,23 +15,28 @@ This bot is a multipurpose discord bot for The Hull Computer Science Society Dis
---
This bot features multiple command types from:
* Admin
* Embeds
* Fun
* General
* Slash Commands
- Admin
- Embeds
- Fun
- General
- Slash Commands
Alongside commands, this bot also features:
* Auto threading in `#coursework-help` channel to keep it clean
* Auto embedding of events for information and archiving
* Select menu role system within `#roles`
* Rule agreement button embed with `#code-of-conduct`
- Auto threading in `#coursework-help` channel to keep it clean
- Auto embedding of events for information and archiving
- Select menu role system within `#roles`
- Rule agreement button embed with `#code-of-conduct`
---
## Installation
**This is a private bot used for a specific purpose within a specific discord server however if you do want to run the bot for testing purposes or deploy it to a new location. Follow the instructions below.**
### 🐋 Docker
Due to the [Publish.yml](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to DockerHub.
```docker
@ -48,6 +52,7 @@ kieranr27/hullcss:main
Using a tool like [Ouroboros](https://github.com/gmt2001/ouroboros), you can automatically update containers without the need for restarts.
### 👷 Manual
- Clone the repo
- Remove the `.template` from `.env.template`
- Replace `INSERT DISCORD TOKEN` with your Discord token.
@ -55,10 +60,13 @@ Using a tool like [Ouroboros](https://github.com/gmt2001/ouroboros), you can aut
- Run `node .` to run the bot
---
## Contributions
While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!
- Contribution guidelines are coming soon.
## License
hullcss-discord-bot is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested.
hullcss-discord-bot is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested.

2
docs/Privacy Policy.md
View File

@ -8,4 +8,4 @@ Usage Data: May include information such as your browser type, browser version,
## Contact Us
If you have any questions about our Privacy Policy, You can contact us via our [Official Discord Server](https://discord.gg/8kYtKWT2VA).
If you have any questions about our Privacy Policy, You can contact us via our [Official Discord Server](https://discord.gg/8kYtKWT2VA).

3
docs/TOS.md
View File

@ -6,7 +6,6 @@ When using this bot, you are required to:
- Follow the [HullCSS Code of Conduct](https://github.com/hullcss/conduct).
- Do not spam the bot.
## Contact Us
If you have any questions about the bot terms of services, You can contact us via our [Official Discord Server](https://discord.gg/8kYtKWT2VA).
If you have any questions about the bot terms of services, You can contact us via our [Official Discord Server](https://discord.gg/8kYtKWT2VA).

52
package.json
View File

@ -1,9 +1,9 @@
{
"name": "hullcss",
"version": "1.0.0",
"description": "",
"main": "src/index.js",
"scripts": {
"name": "hullcss",
"version": "1.0.0",
"description": "",
"main": "src/index.js",
"scripts": {
"spell": "cspell /**/",
"spell:code": "cspell src/**/",
"lint": "npx eslint src",
@ -14,25 +14,25 @@
"prettier:code:fix": "yarn run prettier -- --write",
"prettier:all:fix": "prettier . --write",
"format": "yarn run prettier:all:fix && yarn run lint:fix"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@discordjs/builders": "^1.4.0",
"discord-api-types": "^0.37.20",
"discord.js": "^13.12.0",
"dotenv": "^16.0.3",
"glob": "^7.2.3",
"json-to-frontmatter-markdown": "^1.0.0"
},
"devDependencies": {
"alex": "^11.0.0",
"cspell": "^6.16.0",
"eslint": "^8.29.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-prettier": "^4.2.1",
"prettier": "^2.8.0"
}
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@discordjs/builders": "^1.4.0",
"discord-api-types": "^0.37.20",
"discord.js": "^13.12.0",
"dotenv": "^16.0.3",
"glob": "^7.2.3",
"json-to-frontmatter-markdown": "^1.0.0"
},
"devDependencies": {
"alex": "^11.0.0",
"cspell": "^6.16.0",
"eslint": "^8.29.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-prettier": "^4.2.1",
"prettier": "^2.8.0"
}
}