CONTRIBUTING.md
CONTRIBUTING.md
Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to the Troglodyte project.
Edit source files in src/. Common areas:
| File | Purpose |
|---|---|
src/dictionaries/phrases.ts | Add/edit phrase replacements |
src/dictionaries/synonyms.ts | Add/edit word abbreviations |
src/dictionaries/en-filler.ts | English word blacklists |
src/dictionaries/de-filler.ts | German word blacklists |
src/troglodyte.ts | Compression pipeline logic |
F12) for compression statsphrases.ts)Rules:
'' to remove entirelysynonyms.ts)Rules:
source β src β)en-filler.ts, de-filler.ts)Rules:
Search before adding:
If changes don't reflect:
Expected (Balanced):
Expected (Balanced):
Expected: Path stays as C:\Source Code\... (not corrupted)
When reporting bugs, include:
F12 in LM Studio)If you see Cannot find name 'console' after upgrading TypeScript:
| File | Purpose |
|---|---|
README.md | User-facing documentation |
PROJECT_SUMMARY.md | Technical overview and architecture |
API_REFERENCE.md | TypeScript API documentation |
CHANGELOG.md | Version history |
memory.md | Developer notes, quick reference |
'and': '&&' breaks natural languageBy contributing, you agree that your contributions will be licensed under the MIT license.
Last Updated: June 24, 2026 β v1.3.1 Release
Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to the Troglodyte project.
Edit source files in src/. Common areas:
| File | Purpose |
|---|---|
src/dictionaries/phrases.ts | Add/edit phrase replacements |
src/dictionaries/synonyms.ts | Add/edit word abbreviations |
src/dictionaries/en-filler.ts | English word blacklists |
src/dictionaries/de-filler.ts | German word blacklists |
src/troglodyte.ts | Compression pipeline logic |
F12) for compression statsphrases.ts)Rules:
'' to remove entirelysynonyms.ts)Rules:
source β src β)en-filler.ts, de-filler.ts)Rules:
Search before adding:
If changes don't reflect:
Expected (Balanced):
Expected (Balanced):
Expected: Path stays as C:\Source Code\... (not corrupted)
When reporting bugs, include:
F12 in LM Studio)If you see Cannot find name 'console' after upgrading TypeScript:
| File | Purpose |
|---|---|
README.md | User-facing documentation |
PROJECT_SUMMARY.md | Technical overview and architecture |
API_REFERENCE.md | TypeScript API documentation |
CHANGELOG.md | Version history |
memory.md | Developer notes, quick reference |
'and': '&&' breaks natural languageBy contributing, you agree that your contributions will be licensed under the MIT license.
Last Updated: June 24, 2026 β v1.3.1 Release
# Clone or navigate to the repository
cd "C:\Source Code\LM Studio Plugins\troglodyte"
# Install dependencies
npm install
# Build the project
npm run build
# Run in development mode
npm run dev
lms dev --install
troglodyte/
βββ src/
β βββ index.ts # Entry point (register with LM Studio)
β βββ promptPreprocessor.ts # Pipeline orchestrator
β βββ troglodyte.ts # Compression engine (main logic)
β βββ config.ts # UI configuration schematics
β βββ dictionaries/
β βββ index.ts # Multi-language dictionary exports
β βββ en-filler.ts # English word blacklists
β βββ de-filler.ts # German word blacklists
β βββ phrases.ts # Multi-word phrase replacements
β βββ synonyms.ts # Single-word abbreviations
βββ dist/ # Compiled output (generated)
βββ package.json # Dependencies and scripts
βββ tsconfig.json # TypeScript configuration (incremental & isolatedModules enabled)
βββ README.md # User documentation
npm run build
lms dev --install
export const phrases: Record<string, string> = {
// Format: 'original phrase': 'replacement'
// Remove entirely
'Hello there': '',
// Replace with shorter form
'In order to': 'To',
'Due to the fact that': 'Because',
// Condense multi-word phrase (v1.3.0: use 'sequential' instead of 'steps')
'step by step': 'sequential',
};
export const synonyms: Record<string, string> = {
// Format: 'original word': 'abbreviation'
'application': 'app',
'implementation': 'impl',
'configuration': 'config',
};
// Three tiers of compression aggressiveness
export const EN_GENTLE = [
'please', 'thanks', 'thank', 'appreciate',
];
export const EN_BALANCED = [
...EN_GENTLE,
// Articles, pronouns, prepositions
'a', 'an', 'the', 'i', 'me', 'my', 'of', 'in', 'to',
];
export const EN_AGGRESSIVE = [
...EN_BALANCED,
// Object pronouns, relative pronouns
'he', 'him', 'his', 'she', 'her', 'it', 'they', 'them',
];
export const phrases: Record<string, string> = {
'entry': 'value',
}; // β Don't forget this!
grep -n "partial_phrase" src/dictionaries/phrases.ts
'l'', 'un', 'une' // β INVALID!
"l'", "un", "une" // β
Valid (use double quotes)
Remove-Item -Recurse -Force dist, node_modules\.cache
npm run build
Hello there! I was wondering if you could possibly help me out?
I would really appreciate it if you could explain how to install
Node.js on Windows step by step. Thank you so much for your time
and assistance!
possibly help me out? explain how install Node.js Windows sequential.
Hallo! Ich wΓΌrde mich sehr freuen, wenn du mir bei dieser Aufgabe
helfen kΓΆnntest, bitte und danke!
wΓΌrde freuen, wenn bei dieser Aufgabe helfen kΓΆnntest
check C:\Source Code\ServiceMonitor for issues.
// tsconfig.json - ensure this is present:
{
"compilerOptions": {
"types": ["node"]
}
}
# Clone or navigate to the repository
cd "C:\Source Code\LM Studio Plugins\troglodyte"
# Install dependencies
npm install
# Build the project
npm run build
# Run in development mode
npm run dev
lms dev --install
troglodyte/
βββ src/
β βββ index.ts # Entry point (register with LM Studio)
β βββ promptPreprocessor.ts # Pipeline orchestrator
β βββ troglodyte.ts # Compression engine (main logic)
β βββ config.ts # UI configuration schematics
β βββ dictionaries/
β βββ index.ts # Multi-language dictionary exports
β βββ en-filler.ts # English word blacklists
β βββ de-filler.ts # German word blacklists
β βββ phrases.ts # Multi-word phrase replacements
β βββ synonyms.ts # Single-word abbreviations
βββ dist/ # Compiled output (generated)
βββ package.json # Dependencies and scripts
βββ tsconfig.json # TypeScript configuration (incremental & isolatedModules enabled)
βββ README.md # User documentation
npm run build
lms dev --install
export const phrases: Record<string, string> = {
// Format: 'original phrase': 'replacement'
// Remove entirely
'Hello there': '',
// Replace with shorter form
'In order to': 'To',
'Due to the fact that': 'Because',
// Condense multi-word phrase (v1.3.0: use 'sequential' instead of 'steps')
'step by step': 'sequential',
};
export const synonyms: Record<string, string> = {
// Format: 'original word': 'abbreviation'
'application': 'app',
'implementation': 'impl',
'configuration': 'config',
};
// Three tiers of compression aggressiveness
export const EN_GENTLE = [
'please', 'thanks', 'thank', 'appreciate',
];
export const EN_BALANCED = [
...EN_GENTLE,
// Articles, pronouns, prepositions
'a', 'an', 'the', 'i', 'me', 'my', 'of', 'in', 'to',
];
export const EN_AGGRESSIVE = [
...EN_BALANCED,
// Object pronouns, relative pronouns
'he', 'him', 'his', 'she', 'her', 'it', 'they', 'them',
];
export const phrases: Record<string, string> = {
'entry': 'value',
}; // β Don't forget this!
grep -n "partial_phrase" src/dictionaries/phrases.ts
'l'', 'un', 'une' // β INVALID!
"l'", "un", "une" // β
Valid (use double quotes)
Remove-Item -Recurse -Force dist, node_modules\.cache
npm run build
Hello there! I was wondering if you could possibly help me out?
I would really appreciate it if you could explain how to install
Node.js on Windows step by step. Thank you so much for your time
and assistance!
possibly help me out? explain how install Node.js Windows sequential.
Hallo! Ich wΓΌrde mich sehr freuen, wenn du mir bei dieser Aufgabe
helfen kΓΆnntest, bitte und danke!
wΓΌrde freuen, wenn bei dieser Aufgabe helfen kΓΆnntest
check C:\Source Code\ServiceMonitor for issues.
// tsconfig.json - ensure this is present:
{
"compilerOptions": {
"types": ["node"]
}
}