compiler-discord/README.md
2019-05-14 20:24:16 -04:00

99 lines
2 KiB
Markdown

# Comp_iler
Sandboxed code execution discord bot.
## Usage
### Code Blocks
````
>```lang
code
```
>options```lang
code
```
````
### Inline Code
```
>`lang code`
>options`lang code`
```
### Examples
````
>```cpp
#include <iostream>
int main()
{
std::cout << "Hello World!" << std::endl;
}
```
>harmony```js
class Foo {
bar = 1;
}
console.log(new Foo().bar);
```
>`py print('hello world')`
>e`hs (+) <$> Just 1 <*> Just 2`
````
## Supported Languages and Options
One of the following language codes is set in `lang`.
Options are optionally set in `options`, which is a semicolon-delimited list of `flag` or `flag=value`.
- `bash` Bash (Bash 5.0.2)
- `c` C (GCC 8.2.0)
- `clj` Clojure (Clojure 1.10)
- `cpp` C++ (G++ 8.2.0)
- `cs` C# (Mono 5.18.0)
- `e` evaluates a single expression instead of a module
- `elixir` Elixir (Elixir 1.8.1)
- `fs` F# (FSharp 4.5)
- `go` Go (Go 1.12)
- `hs` Haskell (GHC 8.4.3)
- `e` evaluates a single expression instead of a module
- `java` Java (OpenJDK 13)
- `js` JavaScript (Node 11.11.0)
- `harmony` enables harmony features (`--harmony` on node)
- `e` prints the result of evaluating the code
- `julia` Julia (Julia 1.1.0)
- `e` prints the result of evaluating the code
- `lisp` Racket (Racket 7.2)
- `lua` Lua (Lua 5.3)
- `ocaml` OCaml (OCaml 4.0.6)
- `pas` Pascal (FPC 3.0.4)
- `php` PHP (PHP 7.3.3)
- `pl` Perl (Perl 5.28.1)
- `prolog` Prolog (SWI-Prolog 8.1.2)
- `py` Python (CPython 3.7.2, CPython 2.7.16)
- `2` runs Python 2 instead of Python 3
- `rb` Ruby (Ruby 2.6.2)
- `rs` Rust (Rust 1.33.0)
## How it Works
Read the source code, specifically `src/struct/LanguageHandler.js`.
In summary, for every language there is a docker image which spins up a docker container.
The container is used for all evaluations of code, restarting if something goes wrong.
The container is locked down, so there is no networking, limited memory and CPU usage, and a time limit.
## Setup
0. Install Docker
0. Install Node
0. Run `npm i`
0. Fill out `config.json`
0. Run `node .`