feat: vscode transmitter extensions upport (#57)

.gitignore

@@ -29,6 +29,7 @@ webview/pages/plugins.ts
 .env
 test/
 tmp/
+src/scratchpad/*.ts
 
 src/plugins/sandbox-*
 

docs/changelog.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## Version 30
+
+### Code Changes
+
+-   Added a `vscode transmitter` for debug mode server and client.
+    -   Allows for code to be executed from VSCode using the Rebar Transmitter
+
+### Docs Changes
+
+-   Added vscode transmitter extension page
+
+---
+
 ## Version 29
 
 ### Code Changes

docs/vscode-transmitter.md

@@ -0,0 +1,13 @@
+# VSCode Transmitter Extension
+
+Rebar has built in support for the `Rebar Transmitter` extension.
+
+This allows you to open a scratchpad under `src/scratchpad` and write code.
+
+Once the code is written you can `SELECT THE CODE WITH YOUR CURSOR` and then right-click to execute it while the server is running.
+
+![](./static/transmitter-example.png)
+
+## Download
+
+[https://marketplace.visualstudio.com/items?itemName=stuyk.rebar-transmitter](https://marketplace.visualstudio.com/items?itemName=stuyk.rebar-transmitter)

package.json

@@ -1,7 +1,7 @@
 {
     "author": "stuyk",
     "type": "module",
-    "version": "29",
+    "version": "30",
     "scripts": {
         "dev": "nodemon -x pnpm start",
         "dev:linux": "nodemon -x pnpm start:linux",
@@ -67,7 +67,8 @@
             "*.mjs",
             "ignore*.ts",
             "autogen*.ts",
-            "webview/src/main.ts"
+            "webview/src/main.ts",
+            "src/scratchpad"
         ]
     }
 }

src/main/client/startup.ts

@@ -8,6 +8,7 @@ import './player/controls.js';
 import './rmlui/index.js';
 import './screen/index.js';
 import './system/index.js';
+import './system/vscodeTransmitter.js';
 import './virtualEntities/index.js';
 import { useWebview } from './webview/index.js';
 

src/main/client/system/vscodeTransmitter.ts

@@ -0,0 +1,13 @@
+import alt from 'alt-client';
+import native from 'natives';
+import { Events } from '../../shared/events/index.js';
+
+const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
+
+function handleCode(code: string) {
+    new AsyncFunction('alt', 'native', 'natives', 'game', code)(alt, native, native, native);
+}
+
+if (alt.debug) {
+    alt.onServer(Events.systems.transmitter.execute, handleCode);
+}

src/main/server/startup.ts

@@ -4,6 +4,7 @@ import '../translate/index.js';
 import { useTranslate } from '@Shared/translate.js';
 import { useConfig } from './config/index.js';
 import { useDatabase } from './database/index.js';
+import './systems/vscodeTransmitter.js';
 
 const config = useConfig();
 const database = useDatabase();

src/main/server/systems/vscodeTransmitter.ts

@@ -0,0 +1,58 @@
+import * as alt from 'alt-server';
+import { useRebar } from '@Server/index.js';
+import http from 'http';
+import { Events } from '../../shared/events/index.js';
+
+const Rebar = useRebar();
+const PORT = 9269;
+const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
+
+if (alt.debug) {
+    const server = http.createServer((req, res) => {
+        if (req.method !== 'POST') {
+            res.writeHead(405, { 'Content-Type': 'text/plain' });
+            res.end('Must be a POST request \n');
+            return;
+        }
+
+        let body = '';
+        req.on('data', (chunk) => {
+            body += chunk.toString();
+        });
+
+        req.on('end', async () => {
+            if (req.url === '/server') {
+                await new AsyncFunction('alt', 'console', 'Rebar', body)(
+                    { ...alt },
+                    {
+                        ...console,
+                    },
+                    { ...Rebar },
+                );
+                res.writeHead(200, { 'Content-Type': 'text/plain' });
+                res.end('Code Executed on Server \n');
+                return;
+            }
+
+            if (alt.Player.all.length <= 0) {
+                res.writeHead(200, { 'Content-Type': 'text/plain' });
+                res.end('No players on server to execute code against \n');
+                return;
+            }
+
+            for (let player of alt.Player.all) {
+                if (!player || !player.valid) {
+                    return;
+                }
+
+                player.emit(Events.systems.transmitter.execute, body);
+            }
+
+            res.writeHead(200, { 'Content-Type': 'text/plain' });
+            res.end('Code Executed on Client \n');
+            return;
+        });
+    });
+
+    server.listen(PORT);
+}

src/main/shared/events/index.ts

@@ -108,6 +108,9 @@ export const Events = {
         serverConfig: {
             set: 'systems:server:config:set',
         },
+        transmitter: {
+            execute: 'systems:transmitter:execute',
+        },
     },
     view: {
         onServer: 'webview:on:server',

src/scratchpad/README.md

@@ -0,0 +1,13 @@
+# Scratchpad
+
+Files in here will not be transpiled.
+
+You can create as many as you want and they'll safely be ignored.
+
+Pair your scratchpad with the Rebar Transmitter VSCode extension.
+
+## Transmitter Usage
+
+When selecting code, make sure not to select imports.
+
+Selecting imports will prevent your code from executing.

src/scratchpad/clientExample.pad

@@ -0,0 +1,4 @@
+import * as alt from 'alt-client';
+import * as native from 'natives';
+
+// Execute anything below this line

src/scratchpad/serverExample.pad

@@ -0,0 +1,5 @@
+import * as alt from 'alt-server';
+import { useRebar } from '../main/server/index.js';
+
+const Rebar = useRebar();
+// Execute anything below this line

tsconfig.json

@@ -31,7 +31,14 @@
         "declaration": true,
         "emitDeclarationOnly": false
     },
-    "include": ["src/**/*.ts", "src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
+    "include": [
+        "src/**/*.ts",
+        "src/**/*.ts",
+        "src/**/*.d.ts",
+        "src/**/*.tsx",
+        "src/**/*.vue",
+        "src/scratchpad/example.pad"
+    ],
     "exclude": [
         "resources",
         "scripts",