remove coverage 'env' note

.env.sample

@@ -4,13 +4,11 @@ CLIENT_TOKEN = BOT_TOKEN
 # Default model for new users
 MODEL = DEFAULT_MODEL
 
-# ip/port address of the LLM server (ollama, llmman, ...), I use 172.18.0.3 for docker, 127.0.0.1 for local
+# ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
-# ollama listens on 11434, llmman (https://github.com/llmmanorg/llmman) on 17434
+OLLAMA_IP = IP_ADDRESS
-# OLLAMA_IP / OLLAMA_PORT are still accepted as deprecated aliases
+OLLAMA_PORT = PORT
-LLM_ENDPOINT = IP_ADDRESS
-LLM_PORT = PORT
 
-# ip address for discord bot container, I use 172.18.0.2, use different IP than llm_endpoint
+# ip address for discord bot container, I use 172.18.0.2, use different IP than ollama_ip
 DISCORD_IP = IP_ADDRESS
 
 # subnet address, ex. 172.18.0.0 as we use /16.

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
-          node-version: lts/krypton
+          node-version: lts/jod
           cache: npm
 
       - name: Install Project Dependencies
@@ -33,8 +33,8 @@ jobs:
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
           echo MODEL = ${{ secrets.MODEL }} >> .env
 
         # set -e ensures if nohup fails, this section fails
@@ -45,7 +45,7 @@ jobs:
 
   Discord-Ollama-Container-Build: # test docker build and run
     runs-on: ubuntu-latest
-    timeout-minutes: 3
+    timeout-minutes: 2
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -53,15 +53,15 @@ jobs:
       - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
-          node-version: lts/krypton
+          node-version: lts/jod
           cache: npm
 
       - name: Create Environment Variables
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
           echo MODEL = ${{ secrets.MODEL }} >> .env
 
       - name: Setup Docker Network and Images

.github/workflows/coverage.yml

@@ -0,0 +1,46 @@
+name: Coverage
+run-name: Code Coverage
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  Discord-Node-Coverage:
+    runs-on: ubuntu-latest
+    # environment: coverage
+    timeout-minutes: 2
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+          cache: npm
+
+      - name: Install Project Dependencies
+        run: npm install
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+
+      - name: Run tests with coverage
+        run: npm run coverage
+
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage/lcov.info
+          fail_ci_if_error: true

.github/workflows/deploy.yml

@@ -18,8 +18,8 @@ jobs:
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.CLIENT }} >> .env
-          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
           echo MODEL = ${{ secrets.MODEL }} >> .env
           echo DISCORD_IP = ${{ secrets.DISCORD_IP }} >> .env
           echo SUBNET_ADDRESS = ${{ secrets.SUBNET_ADDRESS }} >> .env

.github/workflows/test-fork.yml

@@ -1,47 +0,0 @@
-name: Tests (Fork PRs)
-run-name: Unit Tests
-
-on:
-  pull_request:
-    branches:
-      - master
-    paths:
-      - '*'
-      - 'package*.json'
-      - 'src/**'
-      - 'tests/**'
-      - '!docs/**'
-      - '!imgs/**'
-      - '!.github/**'
-      - '.github/workflows/**'
-      - '!.gitignore'
-      - '!LICENSE'
-      - '!README'
-
-jobs:
-  Discord-Node-Test-Fork:
-    if: ${{ github.event.pull_request.head.repo.fork == true }}
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/jod'
-          cache: npm
-
-      - name: Install Project Dependencies
-        run: |
-          npm install
-
-      - name: Create Dummy Env
-        run: |
-          echo CLIENT_TOKEN=test-token >> .env
-          echo LLM_ENDPOINT=127.0.0.1 >> .env
-          echo LLM_PORT=11434 >> .env
-          echo MODEL=dummy-model >> .env
-
-      - name: Test Application
-        run: |
-          npm run tests

.github/workflows/test.yml

@@ -20,7 +20,6 @@ on:
 
 jobs:
   Discord-Node-Test:
-    if: ${{ github.event.pull_request.head.repo.fork == false }}
     runs-on: ubuntu-latest
     timeout-minutes: 2
     
@@ -42,8 +41,8 @@ jobs:
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
           echo MODEL = ${{ secrets.MODEL }} >> .env
 
       - name: Test Application

.gitignore

@@ -37,6 +37,16 @@ pids
 *.seed
 *.pid.lock
 
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 

CODEOWNERS

@@ -12,7 +12,7 @@
 # Technical/Business Code Ownership
 /src/ @kevinthedang @JT2M0L3Y
 /tests/ @JT2M0L3Y
-/.github/ @kevinthedang @JT2M0L3Y
+/.github/ @kevinthedang
 
 # Docker Ownership
 Dockerfile @kevinthedang

Dockerfile

@@ -1,5 +1,5 @@
-# use node LTS image for version 24
+# use node LTS image for version 22
-FROM node:krypton-alpine
+FROM node:jod-alpine
 
 # set working directory inside container
 WORKDIR /app

README.md

@@ -5,18 +5,41 @@
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Builds" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
+    <!-- <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a> -->
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
+    <a href="https://codecov.io/gh/kevinthedang/discord-ollama"><img src="https://img.shields.io/codecov/c/github/kevinthedang/discord-ollama?logo=codecov" alt="coverage" /></a>
 </div>
 
-## About
+## About/Goals
-Discord Ollama is a Discord bot that lets users interact with locally hosted
+Ollama is an AI model management tool that allows users to install and use custom large language models locally.  
-Ollama language models directly from Discord.
+The project aims to:
+* [x] Create a Discord bot that will utilize Ollama and chat to chat with users! 
+  * [x] User and Server Preferences
+  * [x] Message Persistance
+  * [x] Containerization with Docker
+  * [x] Slash Commands Compatible
+    * [x] Summary Command
+    * [ ] Model Info Command
+    * [ ] List Models Command
+    * [x] Pull Model Command
+    * [x] Switch Model Command
+    * [x] Delete Model Command
+    * [x] Create Thread Command
+    * [x] Create Private Thread Command
+    * [x] Message Stream Command
+    * [x] Change Message History Size Command
+    * [x] Clear Channel History Command (User Only)
+    * [x] Administrator Role Compatible
+  * [x] Generated Token Length Handling for >2000
+    * [x] Token Length Handling of any message size
+  * [x] Multi-User Chat Generation - This was built in from Ollama `v0.2.1+`
+  * [ ] Ollama Tool Support Implementation
+  * [ ] Enhanced Channel Context Awareness
+  * [ ] Improved User Replied Triggers
 
-The bot supports model management, streamed responses, conversation history,
+Further, Ollama provides the functionality to utilize custom models or provide context for the top-layer of any model available through the Ollama model library.
-private threads, and configurable server controls. Because Ollama runs locally,
+* [Customize a model](https://github.com/ollama/ollama#customize-a-model)
-you retain control over the models and data used by the bot.
+* [Modelfile Docs](https://github.com/ollama/ollama/blob/main/docs/modelfile.md)
-
-See the [setup guides](./docs/setup-local.md) to get started.
 
 ## Documentation
 These are guides to the features and capabilities of this app.
@@ -27,7 +50,6 @@ These are guides to the features and capabilities of this app.
 * Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
 * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
     * For example, `CLIENT_TOKEN = [Bot Token]`
-    * The LLM server is configured with `LLM_ENDPOINT` / `LLM_PORT` (`OLLAMA_IP` / `OLLAMA_PORT` still work as deprecated aliases).
 * Please refer to the docs for bot setup.
     * [Creating a Discord App](./docs/setup-discord-app.md)
     * [Local Machine Setup](./docs/setup-local.md)
@@ -41,7 +63,6 @@ These are guides to the features and capabilities of this app.
     * This project requires the use of npm version `10.9.0` or above.
 * [Ollama](https://ollama.com/)
     * [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
-    * [llmman](https://github.com/llmmanorg/llmman) also serves the Ollama API (on port `17434`) and can be used in its place, see [Local Machine Setup](./docs/setup-local.md#using-with-llmman-alternative-to-ollama).
 * [Discord.js Docs](https://discord.js.org/docs/packages/discord.js/main)
 * [Setting up Docker (Ubuntu 20.04)](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)
     * [Setting up Nvidia Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)

docker-compose.yml

@@ -7,11 +7,11 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.9.2
+    image: kevinthedang/discord-ollama:0.9.1
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
-      LLM_ENDPOINT: ${LLM_ENDPOINT:-${OLLAMA_IP}}     # OLLAMA_IP is a deprecated alias
+      OLLAMA_IP: ${OLLAMA_IP}
-      LLM_PORT: ${LLM_PORT:-${OLLAMA_PORT}}           # OLLAMA_PORT is a deprecated alias
+      OLLAMA_PORT: ${OLLAMA_PORT}
       MODEL: ${MODEL}
     networks:
       ollama-net:
@@ -26,14 +26,14 @@ services:
     restart: always
     networks:
       ollama-net:
-        ipv4_address: ${LLM_ENDPOINT:-${OLLAMA_IP}}
+        ipv4_address: ${OLLAMA_IP}
     runtime: nvidia             # use Nvidia Container Toolkit for GPU support
     devices:
       - /dev/nvidia0
     volumes:
       - ollama:/root/.ollama
     ports: 
-      - ${LLM_PORT:-${OLLAMA_PORT}}:${LLM_PORT:-${OLLAMA_PORT}}
+      - ${OLLAMA_PORT}:${OLLAMA_PORT}
 
 # create a network that supports giving addresses withing a specific subnet
 networks:

docs/setup-docker.md

@@ -43,10 +43,10 @@ sudo systemctl restart docker
 * [GitHub repository](https://github.com/NVIDIA/nvidia-container-toolkit?tab=readme-ov-file) for Nvidia Container Toolkit
 
 ## To Run (with Docker and Docker Compose)
-* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `LLM_ENDPOINT`, `LLM_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
+* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `OLLAMA_IP`, `OLLAMA_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
     * `SUBNET_ADDRESS = 172.18.0.0`
-    * `LLM_ENDPOINT = 172.18.0.2`
+    * `OLLAMA_IP = 172.18.0.2`
-    * `LLM_PORT = 11434`
+    * `OLLAMA_PORT = 11434`
     * `DISCORD_IP = 172.18.0.3`
     * Don't understand any of this? watch a Networking video to understand subnetting.
     * You also need all environment variables shown in [`.env.sample`](../.env.sample)

docs/setup-local.md

@@ -14,18 +14,11 @@
 > [!NOTE]  
 > You can now pull models directly from the Discord client using `/pull-model <model-name>` or `/switch-model <model-name>`. They must exist from your local model library or from the [Ollama Model Library](https://ollama.com/library)
 
-## Using with llmman (alternative to Ollama)
-* [llmman](https://github.com/llmmanorg/llmman) is a local model runner that serves the Ollama API on port `17434`. The bot talks to it exactly as it would to Ollama, only the port differs.
-* Install it with `curl -fsSL https://raw.githubusercontent.com/llmmanorg/llmman/main/install.sh | sh` (Linux/macOS) or `irm https://raw.githubusercontent.com/llmmanorg/llmman/main/install.ps1 | iex` (Windows).
-* Start the server with `llmman serve` and pull a model with `llmman pull [model name]`, for example `llmman pull gemma4` or `llmman pull hf.co/unsloth/Qwen3.5-0.8B-GGUF`.
-* Point the bot at it by setting `LLM_ENDPOINT = 127.0.0.1` and `LLM_PORT = 17434` in your `.env`, then set `MODEL` to a model you pulled. `/pull-model`, `/switch-model` and `/delete-model` work the same way.
-
 ## To Run Locally (without Docker)
 * Run `npm install` to install the npm packages.
-* Ensure that your [.env](../.env.sample) file's `LLM_ENDPOINT` is `127.0.0.1` to work properly.
+* Ensure that your [.env](../.env.sample) file's `OLLAMA_IP` is `127.0.0.1` to work properly.
-    * You only need your `CLIENT_TOKEN`, `LLM_ENDPOINT`, `LLM_PORT`.
+    * You only need your `CLIENT_TOKEN`, `OLLAMA_IP`, `OLLAMA_PORT`.
-    * The LLM server ip and port should just use it's defaults by nature. If not, utilize `LLM_ENDPOINT = 127.0.0.1` and `LLM_PORT = 11434`.
+    * The ollama ip and port should just use it's defaults by nature. If not, utilize `OLLAMA_IP = 127.0.0.1` and `OLLAMA_PORT = 11434`.
-    * The older `OLLAMA_IP` / `OLLAMA_PORT` names are still accepted as deprecated aliases.
 * Now, you can run the bot by running `npm run client` which will build and run the decompiled typescript and run the setup for ollama.
     * **IMPORTANT**: This must be ran in the wsl/Linux instance to work properly! Using Command Prompt/Powershell/Git Bash/etc. will not work on Windows (at least in my experience).
     * Refer to the [resources](../README.md#resources) on what node version to use.

package.json

@@ -1,11 +1,12 @@
 {
   "name": "discord-ollama",
-  "version": "0.9.2",
+  "version": "0.9.1",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "scripts": {
     "tests": "vitest run",
+    "coverage": "vitest run --coverage",
     "watch": "tsx watch src",
     "build": "tsc",
     "prod": "node .",
@@ -31,6 +32,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.13.14",
+    "@vitest/coverage-v8": "^3.0.9",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.3",
     "typescript": "^5.8.2",
@@ -39,6 +41,6 @@
   "type": "module",
   "engines": {
     "npm": ">=10.9.0",
-    "node": ">=24.0.0"
+    "node": ">=22.12.0"
   }
 }

src/keys.ts

@@ -2,8 +2,8 @@ import { getEnvVar } from './utils/index.js'
 
 export const Keys = {
     clientToken: getEnvVar('CLIENT_TOKEN'),
-    ipAddress: getEnvVar('LLM_ENDPOINT', process.env.OLLAMA_IP ?? '127.0.0.1'), // OLLAMA_IP is a deprecated alias
+    ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
-    portAddress: getEnvVar('LLM_PORT', process.env.OLLAMA_PORT ?? '11434'), // OLLAMA_PORT is a deprecated alias
+    portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
     defaultModel: getEnvVar('MODEL', 'llama3.2')
 } as const // readonly keys
 

src/utils/env.ts

@@ -26,7 +26,7 @@ export function getEnvVar(name: string, fallback?: string): string {
             This is probably an invalid token unless Discord updated their token policy. Please provide a valid token.`)
 
     // validate IPv4 address found in environment variables
-    if ((name.endsWith("_IP") || name.endsWith("_ADDRESS") || name.endsWith("_ENDPOINT")) && !ipValidate.test(value))
+    if ((name.endsWith("_IP") || name.endsWith("_ADDRESS")) && !ipValidate.test(value))
         throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
 
     // return env variable

tests/events.test.ts

@@ -26,6 +26,6 @@ describe('Events Existence', () => {
     // test specific events in the object
     it('references specific events', () => {
         const eventsString = events.map(e => e.key.toString()).join(', ')
-        expect(eventsString).toBe('clientReady, messageCreate, interactionCreate, threadDelete')
+        expect(eventsString).toBe('ready, messageCreate, interactionCreate, threadDelete')
     })
 })

tests/getEnvVar.test.ts

@@ -47,28 +47,4 @@ describe('Environment Setup', () => {
     it('throws an error if key is not found', () => {
         expect(() => getEnvVar('NON_EXISTENT_KEY')).toThrowError()
     })
-
-    // test that *_ENDPOINT keys are validated as IPv4 addresses like *_IP keys
-    it('validates *_ENDPOINT keys as IPv4', () => {
-        expect(getEnvVar('UNSET_TEST_ENDPOINT', '127.0.0.1')).toBe('127.0.0.1')
-        expect(() => getEnvVar('UNSET_TEST_ENDPOINT', 'not-an-ip')).toThrowError()
-    })
-
-    // test the deprecated alias lookup used in src/keys.ts
-    it('falls back to the deprecated OLLAMA_IP / OLLAMA_PORT aliases', () => {
-        const saved = { LLM_ENDPOINT: process.env.LLM_ENDPOINT, LLM_PORT: process.env.LLM_PORT }
-        delete process.env.LLM_ENDPOINT
-        delete process.env.LLM_PORT
-        process.env.OLLAMA_IP = '10.0.0.5'
-        process.env.OLLAMA_PORT = '17434'
-        try {
-            expect(getEnvVar('LLM_ENDPOINT', process.env.OLLAMA_IP ?? '127.0.0.1')).toBe('10.0.0.5')
-            expect(getEnvVar('LLM_PORT', process.env.OLLAMA_PORT ?? '11434')).toBe('17434')
-        } finally {
-            delete process.env.OLLAMA_IP
-            delete process.env.OLLAMA_PORT
-            if (saved.LLM_ENDPOINT !== undefined) process.env.LLM_ENDPOINT = saved.LLM_ENDPOINT
-            if (saved.LLM_PORT !== undefined) process.env.LLM_PORT = saved.LLM_PORT
-        }
-    })
 })

tsconfig.json

@@ -18,8 +18,9 @@
     // Decompile .ts to .js into a folder named build
     "outDir": "build",
     "rootDir": "src",
+    "baseUrl": ".",
     "paths": {
-      "*": ["./node_modules/"]
+      "*": ["node_modules/"]
     }
   },
   // environment for env vars

vitest.config.ts

@@ -1,9 +1,14 @@
-import { defineConfig } from 'vitest/config'
+import { defineConfig, configDefaults } from 'vitest/config'
 
 // config for vitest
 export default defineConfig({
     test: {
         globals: true, // <-- reduces test file imports
-        reporters: ['verbose'] // <-- verbose output
+        reporters: ['verbose'], // <-- verbose output
+        coverage: {
+            include: ['src/**/*.ts'],
+            reporter: 'lcov',
+            reportsDirectory: './coverage'
+        }
     }
 })