ScootKit
diff --git a/‎.eslintrc.js‎
Lines changed: 14 additions & 4 deletions b/‎.eslintrc.js‎
Lines changed: 14 additions & 4 deletions
diff --git a/‎.github/CONTRIBUTING.md‎
Lines changed: 13 additions & 0 deletions b/‎.github/CONTRIBUTING.md‎
Lines changed: 13 additions & 0 deletions
diff --git a/‎.github/SUPPORT.md‎
Lines changed: 7 additions & 0 deletions b/‎.github/SUPPORT.md‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎.github/workflows/build-docs.yml‎
Lines changed: 21 additions & 0 deletions b/‎.github/workflows/build-docs.yml‎
Lines changed: 21 additions & 0 deletions
diff --git a/‎CHANGELOG.md‎
Lines changed: 28 additions & 0 deletions b/‎CHANGELOG.md‎
Lines changed: 28 additions & 0 deletions
diff --git a/‎CODE_OF_CONDUCT.md‎
Lines changed: 128 additions & 0 deletions b/‎CODE_OF_CONDUCT.md‎
Lines changed: 128 additions & 0 deletions
@@ -7,7 +7,7 @@ module.exports = {
     'parserOptions': {
         'ecmaVersion': 12
     },
-    'ignorePatterns': ['.eslintrc.js'],
+    'ignorePatterns': ['.eslintrc.js', 'docs/', 'gen-doc/'],
     'rules': {
         'no-unused-vars': 'error',
         'accessor-pairs': 'error',
@@ -51,7 +51,7 @@ module.exports = {
             'error',
             'last'
         ],
-        'complexity': 'error',
+        'complexity': ['error', 50],
         'computed-property-spacing': [
             'error',
             'never'
@@ -67,6 +67,15 @@ module.exports = {
             'error',
             'property'
         ],
+        'require-jsdoc': ['error', {
+            'require': {
+                'FunctionDeclaration': true,
+                'MethodDefinition': false,
+                'ClassDeclaration': true,
+                'ArrowFunctionExpression': false,
+                'FunctionExpression': false
+            }
+        }],
         'dot-notation': 'off',
         'eol-last': 'off',
         'eqeqeq': 'error',
@@ -114,7 +123,7 @@ module.exports = {
         'max-classes-per-file': 'error',
         'max-depth': 'off',
         'max-len': 'off',
-        'max-lines': 'error',
+        'max-lines': ['error', {max: 500, skipComments: true}],
         'max-lines-per-function': 'off',
         'max-nested-callbacks': 'error',
         'max-params': 'off',
@@ -148,6 +157,7 @@ module.exports = {
         'no-extra-bind': 'error',
         'no-extra-label': 'error',
         'no-extra-parens': 'off',
+        'no-extra-semi': 'error',
         'no-floating-decimal': 'error',
         'no-implicit-globals': 'off',
         'no-implied-eval': 'error',
@@ -305,4 +315,4 @@ module.exports = {
             'error'
         ]
     }
-};
+};
@@ -0,0 +1,13 @@
+# Contributing to this repository
+## Getting started
+Before you begin:
+* This bot is powered by Node.js. Please make sure you have node.js 16 or newer installed.
+* Please review our [Code of Conduct](CODE_OF_CONDUCT.md) and our [Terms of service](https://sc-net.work/tos)
+* We highly suggest joining our [discord](https://sc-net.work/dc) to discuss up-coming changes with the rest of our community. You can also apply for the open-source-developer-role [here](https://sc-net.work/open-source-dev-application).
+
+## Setting up
+1. Fork and clone this repository and make sure you are on the current **main** branch as that's were development happens. If you are developing a new module, please use the **stable** branch.
+2. Run `npm ci`
+3. You can code now ^^
+4. Run `npm test` to run ESLint and to ensure any JSDoc changes are valid
+5. [Submit a pullrequest](https://github.com/SCNetwork/CustomDcBot/compare). 
@@ -0,0 +1,7 @@
+# Seeking support?
+
+We only use this issue tracker for bug reports and feature request. We are not able to provide general support or answer questions in the form of GitHub issues.
+
+For general questions or problems with this bot, please use [discussions](https://github.com/SCNetwork/CustomDCBot/discussions).
+
+Any issues that don't directly involve a bug or a feature request will likely be closed and redirected.
@@ -0,0 +1,21 @@
+name: Build gen-doc
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: npm install
+      - name: Build gen-doc
+        run: npx jsdoc -c jsdoc.conf.json
+      - name: Commit & Push
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          message: generated documentation
+          branch: dev
@@ -0,0 +1,28 @@
+# Changelog
+
+This changelog contains mostly API-Changes and changes for developers.
+
+## v2.0.0
+
+* Added new configuration-option `logLevel`
+* Added logger (`client.logger`) to allow for more detailed logs (instance
+  of [log4js.Logger](https://github.com/log4js-node/log4js-node))
+* Added `--pm2-setup`-command-argument to indicate an [pm2](https://pm2.keymetrics.io)-setup
+* Switched to discord.js version 1.13 which includes breaking changes
+* Reworked some configuration-loading and switched to `jsonfile` as a dependencies
+* Configuration of every module is now stored in a global client object: `client.configuration[moduleName]`. Please use
+  this instead of using `require` as this method allows users to reload configuration.
+* Commands are now slash commands. Old commands are not recommended being used, but can be by changing `commands-dir`
+  to `message-commands-dir`. Remember, that in future we may remove this feature.
+* It's no longer required to add `module` as a config-parameter for every command
+* Added `sendMultipleSiteButtonMessage` to `/src/functions/helpers.js` to create fancy multiple-site-embed-messages
+* `embedType()` now returns [MessageOptions](https://discord.js.org/#/docs/main/stable/typedef/MessageOptions)
+* `footer` can now be set for each embed individually
+* `.eslintrc.js` added - please use this configuration if you create a pullrequest
+* Added `client.logChannel` ([TextChannel](https://discord.js.org/#/docs/main/stable/class/TextChannel)) which should be
+  used as a default for log-channels and in which some relevant information gets sent. ⚠️ In some cases this value
+  is `null` so always catch or check the value before any calls on this property.
+* Forgot the prefix of your bot? You can now use @-mentions instead of your prefix
+* `mesageCommand.config.args` now only (!) accepts an integer which represents how many arguments are at least needed
+* Slash-Commands are now available and should be used as much as possible
+* Errors in the executing of a command will nun result in a message to the user
@@ -0,0 +1,128 @@
+# 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, 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 e-mail 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
+opensource@sc-network.net.
+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.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.