Typescript review #34
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| dist | ||
|
|
||
| *.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "plugins": [], | ||
| "arrowParens": "avoid", | ||
| "bracketSameLine": true, | ||
| "bracketSpacing": true, | ||
| "singleQuote": false, | ||
| "trailingComma": "es5", | ||
| "tabWidth": 2, | ||
| "useTabs": false, | ||
| "semi": true, | ||
| "printWidth": 100 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ FROM node:20 | |
|
|
||
| COPY . . | ||
| RUN npm i --omit=dev --no-package-lock | ||
| RUN npm run build | ||
| USER node | ||
|
|
||
| CMD ["npm","start"] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,20 +1,33 @@ | ||||||
| <div align="center"> | ||||||
| <h1>Discord AI Bot</h1> | ||||||
| <h2>Repository is now in maintenance mode - rewriting project to Typescript</h2> | ||||||
|
There was a problem hiding this comment. suggestion (typo): Use the conventional capitalization "TypeScript" instead of "Typescript". This keeps the heading consistent with the official project name and common usage.
Suggested change
|
||||||
| <h3 align="center">Discord bot to interact with <a href="https://github.com/jmorganca/ollama">Ollama</a> and <a href="https://github.com/AUTOMATIC1111/stable-diffusion-webui">AUTOMATIC1111 Stable Diffusion</a> as a chatbot</h3> | ||||||
| <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/238samixd/discord-ai-bot?style=social"> | ||||||
| </div> | ||||||
|
|
||||||
| The project started thanks to [mekb](https://github.com/mekb-turtle). | ||||||
|
|
||||||
| ## Roadmap | ||||||
|
|
||||||
| - Handle pdf attachments | ||||||
| - Implement multiple servers support (copying commands?) | ||||||
| - Check (and fix if necessary) `Dockerfile` and `docker-compose` setup | ||||||
| - Review installation and usage instructions | ||||||
| - Create docs with examples for the bot | ||||||
| - Add slow mode option to prevent spam and GPU overload | ||||||
| - Write unit tests | ||||||
|
There was a problem hiding this comment. Line 16 mentions "Write unit tests" in the roadmap, but unit tests have already been written in this PR (tests/utils/). This roadmap item should be updated to reflect the current state.
Suggested change
|
||||||
| - Create a RAG to extract information from _PDFs_ and/or docs | ||||||
| - Implement [OpenWebUI](https://github.com/open-webui/open-webui) interactions (web search, youtube loader) | ||||||
| - ? Implement [fabric](https://github.com/danielmiessler/fabric) integration (patterns, youtube video extraction if needed) | ||||||
|
Comment on lines
+18
to
+19
There was a problem hiding this comment. suggestion (typo): Capitalize "YouTube" as a proper noun in roadmap bullets. Specifically, update “youtube loader” and “youtube video extraction” to “YouTube loader” and “YouTube video extraction.” Suggested implementation: |
||||||
| - Fix streaming issues `/chat ... stream: True` (handle race - `async-mutex`) | ||||||
|
|
||||||
| ### Set-up instructions (TO BE REVIEWED) | ||||||
|
|
||||||
| 1. Install [Node.js](https://nodejs.org) (if you have a package manager, use that instead to install this) | ||||||
| - Make sure to install at least v18 of Node.js (v20+ recommended) | ||||||
| 2. Install [Ollama](https://github.com/ollama/ollama) | ||||||
| 3. Pull (download) a model, `ollama pull MODEL` e.g `ollama pull llama3.1` - [Model list](https://ollama.com/search) | ||||||
| 4. Start Ollama by running `ollama serve` if not already running | ||||||
| 5. [Create a Discord bot](https://discord.com/developers/applications) | ||||||
| - Under Application » Bot | ||||||
| - Enable Message Content Intent | ||||||
|
|
@@ -36,10 +49,10 @@ The project started thanks to [mekb](https://github.com/mekb-turtle). | |||||
| 8. Install the required dependencies with `npm i` | ||||||
| 9. Start the bot with `npm start` | ||||||
| 10. You can interact with the bot by @mentioning it with your message | ||||||
| 11. Install [Stable Diffusion](https://github.com/AUTOMATIC1111/stable-diffusion-webui) | ||||||
| 12. Run the script `./webui.sh --api --listen` | ||||||
|
|
||||||
| ### Set-up instructions with Docker (TO BE CHECKED) | ||||||
|
|
||||||
| 1. Install [Docker](https://docs.docker.com/get-docker/) | ||||||
| - Should be atleast compatible with version 3 of compose (docker engine 1.13.0+) | ||||||
|
There was a problem hiding this comment. issue (typo): Fix the typo "atleast" → "at least". |
||||||
|
|
||||||
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import js from "@eslint/js"; | ||
| import globals from "globals"; | ||
| import tseslint from "typescript-eslint"; | ||
|
|
||
| export default tseslint.config( | ||
| { ignores: ["dist"] }, | ||
| { | ||
| extends: [js.configs.recommended, ...tseslint.configs.recommended], | ||
| files: ["**/*.ts"], | ||
| languageOptions: { | ||
| ecmaVersion: 2020, | ||
| globals: globals.browser, | ||
| }, | ||
| plugins: {}, | ||
| rules: { | ||
| "@typescript-eslint/no-unused-vars": "error", | ||
| }, | ||
| } | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,48 @@ | ||
| { | ||
| "name": "discord-bot-template", | ||
| "version": "1.0.0", | ||
| "description": "A basic Discord bot template using TypeScript and discord.js", | ||
| "main": "dist/index.js", | ||
| "scripts": { | ||
| "start": "node dist/index.js", | ||
| "build": "tsc", | ||
| "dev": "ts-node src/index.ts", | ||
| "test": "npm run test:lint && npm run test:prettier && npm run test:jest", | ||
| "test:jest": "jest", | ||
| "test:lint": "eslint src", | ||
| "test:prettier": "prettier --check src", | ||
| "lint": "eslint src --fix", | ||
| "prettier": "prettier --write src" | ||
| }, | ||
| "keywords": [ | ||
| "discord", | ||
| "bot", | ||
| "typescript", | ||
| "discord.js" | ||
| ], | ||
| "author": "238SAMIxD", | ||
| "license": "ISC", | ||
| "dependencies": { | ||
| "axios": "^1.7.9", | ||
| "discord.js": "^14.14.1", | ||
| "dotenv": "^16.4.5", | ||
| "meklog": "^1.0.2" | ||
| }, | ||
| "devDependencies": { | ||
| "@eslint/js": "^9.20.0", | ||
| "@jest/globals": "^29.7.0", | ||
| "@types/eslint__js": "^8.42.3", | ||
| "@types/jest": "^29.5.14", | ||
| "@types/node": "^20.11.24", | ||
| "eslint": "^9.20.1", | ||
| "eslint-config-prettier": "^10.0.1", | ||
| "eslint-plugin-prettier": "^5.2.3", | ||
| "globals": "^15.15.0", | ||
| "jest": "^29.7.0", | ||
| "prettier": "^3.5.0", | ||
| "ts-jest": "^29.2.5", | ||
| "ts-node": "^10.9.2", | ||
| "typescript": "^5.4.2", | ||
| "typescript-eslint": "^8.24.0" | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo in environment docs comment.
Line 4 says “sever” instead of “server”.
🤖 Prompt for AI Agents