chore: add tsc typecheck

.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI workflows
+on: [push, pull_request]
+
+jobs:
+    build:
+        name: Check TypeScript
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: oven-sh/setup-bun@v1
+
+            - name: Install dependencies
+              run: bun install
+
+            - name: Run TypeScript Compiler
+              run: bun run typecheck

README.md

@@ -3,7 +3,7 @@
 <p>Generate SVG badges for your Guilded server</p>
 <p>
     <a href="https://www.guilded.gg/i/2MJ57MQk"><img src="https://shields.yoki-labs.xyz/shields/i/2MJ57MQk?style=flat" alt="Guilded Server"></a>
-    <img src="https://github.com/yoki-labs/guilded-shields/actions/workflows/ci.yml/badge.svg" alt="Lint and build">
+    <img src="https://github.com/yoki-labs/guilded-shields/actions/workflows/ci.yml/badge.svg" alt="Build TypeScript">
     <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a><br>
 </p>
 </div>
@@ -27,22 +27,13 @@ What your invite type should be is dependent on what kind of invite link you hav
 
 ## 📝 Installation
 
-### Docker-Compose
+### Bun
 
 ```
 git clone https://github.com/yoki-labs/guilded-shields.git
 cd guilded-shields
-docker-compose up -d --build
-```
-
-### Node
-
-```
-git clone https://github.com/yoki-labs/guilded-shields.git
-cd guilded-shields
-npm install
-npm run build
-node dist/index.js
+bun install
+bun run src/index.ts
 ```
 
 ## ✋ Contributing

package.json

@@ -1,18 +1,21 @@
 {
-    "name": "guilded-shields",
-    "version": "1.0.0",
-    "description": "SVG shields for providing metadata about Guilded Servers.",
-    "scripts": {
-        "format": "prettier --write **/*.{ts,json}"
-    },
-    "author": "Zaid \"Nico\"",
-    "license": "MIT",
-    "devDependencies": {
-        "prettier": "^3.1.1"
-    },
-    "dependencies": {
-        "badge-maker": "^3.3.1",
-        "elysia": "^0.7.30",
-        "elysia-rate-limit": "^2.0.1"
-    }
+  "name": "guilded-shields",
+  "version": "1.0.0",
+  "description": "SVG shields for providing metadata about Guilded Servers.",
+  "scripts": {
+    "typecheck": "tsc",
+    "format": "prettier --write **/*.{ts,json}"
+  },
+  "author": "Zaid \"Nico\"",
+  "license": "MIT",
+  "devDependencies": {
+    "bun-types": "^1.0.16",
+    "prettier": "^3.1.1",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "badge-maker": "^3.3.1",
+    "elysia": "^0.7.30",
+    "elysia-rate-limit": "^2.0.1"
+  }
 }

tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "allowSyntheticDefaultImports": true,
+        "alwaysStrict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "noEmit": true,
+        "lib": ["esnext"],
+        "types": ["bun-types"],
+        "module": "CommonJS",
+        "moduleResolution": "Node",
+        "strict": true,
+        "target": "ES2020"
+    },
+    "include": ["src/**/*.ts"]
+}