Merge pull request #8 from sustained/commando-rewrite

Commando rewrite

Author: Elfayer

.env.example

@@ -0,0 +1,4 @@
+BOT_TOKEN=
+CLIENT_ID=
+OWNERS_IDS=
+COMMAND_PREFIX=!

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    es6: true,
+  },
+  extends: ['prettier', 'plugin:vue/essential', '@vue/prettier'],
+  rules: {
+    'prettier/prettier': 'error',
+    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'func-call-spacing': 'error',
+    'curly': 'error'
+  },
+  parserOptions: {
+    parser: 'babel-eslint',
+  },
+}

.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  semi: false,
+  tabs: false,
+  tabWidth: 2,
+  singleQuote: true,
+  trailingComma: 'es5',
+  bracketSpacing: true,
+}

README.md

@@ -1,38 +1,115 @@
 # **vue-land-bot**
 
-**UPDATE 02/09/2019:** Aimed to be rewritten using [Commando.js](https://discord.js.org/#/docs/commando/master/general/welcome) for easiness of maintainability.
+This is the official bot for the Vue Land Discord server.
 
-API Doc: https://discord.js.org
+It's written in JS and built on [Discord.js](https://github.com/discordjs/discord.js/) and [Commando](https://github.com/discordjs/Commando).
 
-Based on guide: https://discordjs.guide/
+## Table of Contents
 
-Not implemented:
-
-- [Setting a command as guild-only](https://discordjs.guide/commando/guild-only.html#setting-a-command-as-guild-only)
-- [Cooldowns](https://discordjs.guide/command-handling/adding-features.html#cooldowns)
-- [Command aliases](https://discordjs.guide/command-handling/adding-features.html#command-aliases)
+- [Set up the bot](#setup)
+  - [Necessary steps](#necessary-steps)
+    - [Install dependencies](#install-dependencies)
+    - [Create Discord app and bot](#create-discord-application-and-bot-user)
+    - [Create the `.env` file](#create-the-.env-file)
+    - [Add Discord token to `.env` file](#add-discord-token-to-.env-file)
+  - [Optional steps](#optional-steps)
+    - [Configure role and user IDs](#configure-role-and-user-ids)
+- [Run the bot](#running)
+- [FAQ](#faq)
+- [Contributors](#contributors)
 
 # Setup
 
-To make this code work, you'll need to setup your own bot with its own token.
-To do so, follow [this steps](https://discordjs.guide/preparations/setting-up-a-bot-application.html).
+## Necessary steps
+
+### Install dependencies
 
-# How to run?
+As always:
 
-```sh
-# Install dependencies
+```bash
 npm install
+```
+
+### Create Discord application and bot user
+
+Before you can run vue-land-bot, you'll need to setup a Discord Application and attach a bot user to it.
+
+Once you're done, copy the bot token to your clipboard.
+
+If you're not sure what to do you can [follow this guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html).
+
+### Create the `.env` file
+
+You'll need to copy `.env.example` to `.env`.
+
+On \*nix/bsd you can run this command:
+
+```bash
+cp .env.example .env
+```
+
+### Add Discord token to `.env` file
+
+Next you need to add the bot token to the `.env` file (as `DISCORD_TOKEN`).
+
+> **IMPORTANT:** You should treate the Discord bot token like a password - keep it safe! Especially if you plan on giving it permissions like `ADMINISTRATOR`!
+
+[Back to top](#vue-land-bot)
+
+## Optional steps
 
-# Start bot
+<!--
+### Create Github personal access token
+
+If you want the RFCs command group to work then you'll need to create a [Github personal access token](https://github.com/settings/tokens) and add it to the `.env` file (as `GITHUB_TOKEN`).
+
+You don't _need_ to give it any scopes.
+
+> **IMPORTANT:** You should treate the Github personal access token like a password - keep it safe! Especially if you add any scopes!
+-->
+
+### Configure role and user IDs
+
+While not necessary per se, it's recommended to check out `src/constants/development.js` and `src/constants/production.js`.
+
+The relevant file is included based on the `NODE_ENV` environmental variable.
+
+These files contain various [Snowflakes](https://discordapp.com/developers/docs/reference#snowflakes) (basically IDs) for users and roles.
+
+[Back to top](#vue-land-bot)
+
+# Running
+
+To run the bot simply run:
+
+```bash
 npm run serve
 ```
 
+[Back to top](#vue-land-bot)
+
 # FAQ
 
-### When I run `npm run serve`, I get: `UnhandledPromiseRejectionWarning: Error: Incorrect login details were provided`
+## When I run `npm run serve` I get an error
+
+### "The environmental variable BOT_TOKEN is required but was not present!"
+
+Please read the [necessary steps](#necessary-steps) section of the README.
+
+### Error: Incorrect login details were provided.
+
+Ensure you copy-pasted the token correctly. Perhaps you accidentally added a space, for instance?
+
+[Back to top](#vue-land-bot)
 
-Make sure you have a `./src/config.json` file with your token properly filled.
+# Contributors
 
-To get a default `config.json`, run `npm run init`.
+- Lead Developer / Maintainer
+  - [Elfayer](https://github.com/elfayer/), Hong Kong
+- Contributors
+  - [sustained](https://github.com/sustained/), United Kingdom
+- Ideas, Feedback & Testing
+  - [gusto](https://github.com/gustojs/), Poland
+  - [laquasicinque](https://github.com/laquasicinque) United Kingdom
 
-To setup your token, see the [Setup](#Setup) section.
+[Back to top](#vue-land-bot)

src/services/ban-words.txt data/ban-words.txt

@@ -0,0 +1,102 @@
+export default [
+  {
+    name: 'vue',
+    aliases: ['home', 'vuejs'],
+    value: 'https://vuejs.org/',
+  },
+  {
+    name: 'get-started',
+    aliases: ['start', 'intro', 'introduction'],
+    value: 'https://vuejs.org/v2/guide/',
+  },
+  {
+    name: 'installation',
+    value: 'https://vuejs.org/v2/guide/installation.html',
+  },
+  {
+    name: 'class',
+    aliases: ['classes'],
+    value:
+      'https://vuejs.org/v2/guide/class-and-style.html#Binding-HTML-Classes',
+  },
+  {
+    name: 'style',
+    aliases: ['styles'],
+    value:
+      'https://vuejs.org/v2/guide/class-and-style.html#Binding-Inline-Styles',
+  },
+  {
+    name: 'component',
+    aliases: ['components'],
+    value: 'https://vuejs.org/v2/guide/components.html',
+  },
+  {
+    name: 'slot',
+    aliases: ['slots'],
+    value: 'https://vuejs.org/v2/guide/components-slots.html',
+  },
+  {
+    name: 'prop',
+    aliases: ['props'],
+    value: 'https://vuejs.org/v2/guide/components-props.html',
+  },
+  {
+    name: 'event',
+    aliases: ['events'],
+    value: 'https://vuejs.org/v2/guide/components-custom-events.html',
+  },
+  {
+    name: 'registration',
+    value: 'https://vuejs.org/v2/guide/components-registration.html',
+  },
+  {
+    name: 'transition',
+    aliases: ['transitions'],
+    value: 'https://vuejs.org/v2/guide/transitions.html',
+  },
+  {
+    name: 'mixin',
+    aliases: ['mixins'],
+    value: 'https://vuejs.org/v2/guide/mixins.html',
+  },
+  {
+    name: 'directive',
+    aliases: ['directives', 'custom-directive', 'custom-directives'],
+    value: 'https://vuejs.org/v2/guide/custom-directive.html',
+  },
+  {
+    name: 'render',
+    aliases: ['render-function', 'render-functions'],
+    value: 'https://vuejs.org/v2/guide/render-function.html',
+  },
+  {
+    name: 'lifecycle',
+    aliases: ['cycle', 'lifecycles', 'lifecycle-hooks'],
+    value: 'https://vuejs.org/v2/api/#Options-Lifecycle-Hooks',
+  },
+  {
+    name: 'lifecycle-diagram',
+    aliases: ['cycle-diag', 'cycle-diagram', 'life-cycle-diagram'],
+    value: 'https://vuejs.org/v2/guide/instance.html#Lifecycle-Diagram',
+  },
+  {
+    name: 'cookbook',
+    aliases: ['cook'],
+    value: 'https://vuejs.org/v2/cookbook/',
+  },
+  {
+    name: 'style-guide',
+    aliases: ['guide'],
+    value: 'https://vuejs.org/v2/style-guide/',
+  },
+  {
+    name: 'example',
+    aliases: ['examples'],
+    value: 'https://vuejs.org/v2/examples/',
+  },
+  {
+    name: 'prop-event',
+    aliases: ['props-events'],
+    value: 'https://vuejs.org/images/props-events.png',
+  },
+]