Refactor to TypeScript (#19)

See description of #19

Author: JstnMcBrd

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+	"name": "discord-cleverbot",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "npm install",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"dbaeumer.vscode-eslint"
+			]
+		}
+	}
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.env.example

@@ -0,0 +1,2 @@
+# WARNING: keep this token secret, or your bot will be hacked!
+TOKEN="example-bot-token"

.eslintrc.json

@@ -1,4 +1,6 @@
 node_modules
-.outdated/
-accounts/*
-!accounts/ExampleUsername
+dist
+memory/*
+!memory/example-user-id
+.env
+todo

.gitignore

@@ -0,0 +1 @@
+18

.nvmrc

@@ -0,0 +1,6 @@
+{
+	"recommendations": [
+		"ms-vscode-remote.remote-containers",
+		"dbaeumer.vscode-eslint",
+	],
+}

.vscode/extensions.json

@@ -0,0 +1,17 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Launch Program",
+			"skipFiles": [
+				"<node_internals>/**"
+			],
+			"program": "./dist/main.js",
+		},
+	],
+}

.vscode/launch.json

@@ -0,0 +1,6 @@
+{
+	"eslint.experimental.useFlatConfig": true,
+	"files.associations": {
+		".env.example": "properties"
+	},
+}

.vscode/settings.json

@@ -1,37 +1,52 @@
-# Discord-Cleverbot
+# discord-cleverbot
+
+## cleverbot-free
+[![API Status](https://github.com/IntriguingTiles/cleverbot-free/workflows/API%20Status/badge.svg)](https://github.com/IntriguingTiles/cleverbot-free/actions/workflows/api.yml)
 
 ## About
 
-Discord-Cleverbot is a [Discord](https://discord.com/) bot developed in JavaScript that uses the node.js library of [cleverbot-free](https://www.npmjs.com/package/cleverbot-free) to give Cleverbot a presence on Discord. Through the bot, users are able to converse with the [Cleverbot chat bot](https://www.cleverbot.com/). The bot also hosts other features that help integrate it with the Discord chat environment.
+discord-cleverbot is a [Discord](https://discord.com/) bot that allows users to interact with the [Cleverbot chat bot](https://www.cleverbot.com/) on Discord. It is developed in [TypeScript](https://www.typescriptlang.org/) and relies on the [node.js](https://nodejs.org/) module of [cleverbot-free](https://www.npmjs.com/package/cleverbot-free).
 
-This project was started in December 2017 and developed periodically until September 2021. This included several ground-up rewrites to improve functionality, efficiency, and simplicity, resulting in a comparatively simple design today.
+It was originally started in December 2017 and has undergone several ground-up rewrites to improve functionality, efficiency, modernity, and simplicity.
 
 ## Licensing
 
 Without a specific license, this code is the direct intellectual property of the original developer. It may not be used, modified, or shared without explicit permission.
-Please see GitHub's [guide](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) on licensing.
+Please see [GitHub's guide on licensing](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).
 
 ## Getting started
 
 ### Creating a bot
 
-1. Create a new bot account in the [Discord developer portal](https://discord.com/developers/applications/)
-2. Copy the access token and application ID of your bot for later
+- Create a new bot account in the [Discord Developer Portal](https://discord.com/developers/applications/).
+- Copy the access token of your bot for later.
 
 ### Setting up the code
 
-3. Run `git pull https://github.com/JstnMcBrd/Discord-Cleverbot.git` to download the repo
-4. Go into the `/accounts` directory, duplicate the `ExampleUsername` folder, and rename it as the username of your bot
-5. Inside the new folder, edit `config.json` and replace `example-user-id` with the application ID and `example-token` with the access token
+- You will need an environment with [node.js v18](https://nodejs.org/en/download) installed (or use the Dev Container - see the [Development](#development) section below).
+- Run `git pull https://github.com/JstnMcBrd/discord-cleverbot.git` to clone the repo.
+- Create a new file called `.env` and add your access token, using [`.env.example`](./.env.example) as an example.
 
 ### Running the code
 
-6. In the top directory, run `npm install` to download all necessary packages
-7. Run `node deploy-commands.js [bot username]` to register slash commands with Discord
-8. Run `node index.js [bot username]` to start the bot
+- In the top directory, run `npm install` to download all necessary packages.
+- Run `npm run build` to build the project.
+- Run `npm run commands` to register slash commands with Discord.
+- Run `npm start` to start the bot.
 
 ### Interacting with the bot
 
-9. Use the URL in `/accounts/[bot username]/config.json` to add your bot to a server
-10. Use the `/whitelist` command in a channel to allow the bot to speak there
-11. Send messages in the whitelisted channel and watch the bot respond!
+- In the **OAuth2**>**URL Generator** tab in the Discord Developer Portal, generate an invite URL with the `applications.commands` scope.
+- Use the invite URL to add the bot to a server.
+- Use the `/whitelist` command in a channel to allow the bot to speak there.
+- Send messages in the whitelisted channel and watch the bot respond!
+
+## Development
+
+- [Visual Studio Code](https://code.visualstudio.com/) is the recommended IDE for development.
+- All settings are included as artifacts in the [`.vscode`](./.vscode) folder and will automatically apply.
+- You can use the built-in debugger and set breakpoints to troubleshoot the code.
+
+> If you want a standardized development environment, you can use the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) with the given [`devcontainer.json`](./.devcontainer/devcontainer.json) config to develop inside a [Docker](https://www.docker.com/) container with all dependencies and recommended extensions pre-installed.
+>
+> Simply install the extension and use the **Dev Containers: Open Folder in Container** command.