fix packaging types and add lint/format quality gates

Author: dev-dami

.github/workflows/ci.yml

@@ -27,6 +27,12 @@ jobs:
       - name: Install dependencies
         run: bun install --frozen-lockfile
 
+      - name: Lint
+        run: bun run lint
+
+      - name: Format check
+        run: bun run format:check
+
       - name: Build
         run: bun run build
 

.github/workflows/release.yml

@@ -32,6 +32,12 @@ jobs:
       - name: Install dependencies
         run: bun install --frozen-lockfile
 
+      - name: Lint
+        run: bun run lint
+
+      - name: Format check
+        run: bun run format:check
+
       - name: Build
         run: bun run build
 

.gitignore

@@ -162,3 +162,4 @@ tests/yaml_complex_test.js
 examples/express-integration.js
 examples/express-integration.ts
 Qirrel.md
+.tmp/

CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [QIRRELCONTEXT IMPLEMENTATION 0.2.0]
 
 ### Added
-- QirrelContext as the canonical context 
+- QirrelContext as the canonical context
 - Namespaced fields: meta (requestId, timestamp, source, trace), memory (shortTerm, longTerm, cache), and llm (model, temperature, safety)
 - JSON serializability support for context persistence and transport
 - Backward compatibility safeguards for existing integrations

package.json

@@ -6,6 +6,9 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "bun run typecheck",
+    "format:check": "node scripts/check-format.mjs",
     "dev": "tsc --watch",
     "test": "jest",
     "test:watch": "jest --watch",
@@ -14,7 +17,7 @@
     "bench:frameworks": "bun run bench/framework-comparison.bench.ts",
     "bench:report": "bun run bench/report.bench.ts",
     "mcp:start": "bun run src/bin/qirrel-mcp.ts",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "bun run lint && bun run format:check && bun run build"
   },
   "bin": {
     "qirrel-mcp": "./dist/bin/qirrel-mcp.js"
@@ -40,18 +43,17 @@
   },
   "homepage": "https://github.com/dev-dami/qirrel#readme",
   "dependencies": {
-    "@types/node": "^24.10.9",
     "compromise": "^14.14.5",
     "emoji-regex": "^10.6.0",
     "js-yaml": "^4.1.1",
     "libphonenumber-js": "^1.12.31",
     "lru-cache": "^11.2.4",
     "tokenizers": "^0.13.3",
-    "typescript": "^5.9.3",
     "uuid": "^13.0.0",
     "validator": "^13.15.23"
   },
   "devDependencies": {
+    "@types/node": "^24.10.9",
     "@types/emoji-regex": "^9.2.2",
     "@types/jest": "^30.0.0",
     "@types/js-yaml": "^4.0.9",
@@ -62,6 +64,7 @@
     "langchain": "^1.0.2",
     "tinybench": "^2.9.0",
     "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
     "zod": "^4.1.5"
   },
   "files": [

scripts/check-format.mjs

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+
+import { readdirSync, readFileSync } from "node:fs";
+import { join, relative } from "node:path";
+
+const ROOT = process.cwd();
+const EXCLUDED_DIRS = new Set([
+  ".git",
+  "node_modules",
+  "dist",
+  "coverage",
+  ".tmp",
+]);
+const EXCLUDED_FILES = new Set(["bun.lock", "package-lock.json"]);
+const CHECKED_EXTENSIONS = new Set([
+  ".ts",
+  ".tsx",
+  ".js",
+  ".cjs",
+  ".mjs",
+  ".json",
+  ".md",
+  ".yml",
+  ".yaml",
+]);
+
+function walk(dir, out) {
+  for (const entry of readdirSync(dir, { withFileTypes: true })) {
+    const fullPath = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      if (!EXCLUDED_DIRS.has(entry.name)) walk(fullPath, out);
+      continue;
+    }
+    if (!entry.isFile()) continue;
+    if (EXCLUDED_FILES.has(entry.name)) continue;
+    const ext = entry.name.includes(".")
+      ? `.${entry.name.split(".").pop().toLowerCase()}`
+      : "";
+    if (CHECKED_EXTENSIONS.has(ext)) out.push(fullPath);
+  }
+}
+
+const files = [];
+walk(ROOT, files);
+
+const failures = [];
+for (const filePath of files) {
+  const relativePath = relative(ROOT, filePath);
+  const content = readFileSync(filePath, "utf8");
+  const lines = content.split("\n");
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+    if (line.includes("\r")) {
+      failures.push(`${relativePath}:${i + 1} contains CRLF characters`);
+    }
+    if (/\t/.test(line)) {
+      failures.push(`${relativePath}:${i + 1} contains tab indentation`);
+    }
+    if (/[ \t]+$/.test(line)) {
+      failures.push(`${relativePath}:${i + 1} has trailing whitespace`);
+    }
+  }
+}
+
+if (failures.length > 0) {
+  console.error("format:check failed");
+  for (const failure of failures) console.error(`- ${failure}`);
+  process.exit(1);
+}
+
+console.log("format:check passed");

tests/events.test.ts

@@ -13,7 +13,7 @@ describe('Pipeline Events', () => {
     pipeline.on(PipelineEvent.RunStart, (payload) => {
       events.push({ event: PipelineEvent.RunStart, payload });
     });
-    
+
     pipeline.on(PipelineEvent.RunEnd, (payload) => {
       events.push({ event: PipelineEvent.RunEnd, payload });
     });
@@ -31,7 +31,7 @@ describe('Pipeline Events', () => {
     pipeline.on(PipelineEvent.ProcessorStart, (payload) => {
       events.push({ event: PipelineEvent.ProcessorStart, payload });
     });
-    
+
     pipeline.on(PipelineEvent.ProcessorEnd, (payload) => {
       events.push({ event: PipelineEvent.ProcessorEnd, payload });
     });
@@ -47,10 +47,10 @@ describe('Pipeline Events', () => {
   test('should allow removing event listeners', async () => {
     const handler = jest.fn();
     pipeline.on(PipelineEvent.RunStart, handler);
-    
+
     await pipeline.process("Hello world!");
     expect(handler).toHaveBeenCalledTimes(1);
-    
+
     pipeline.off(PipelineEvent.RunStart, handler);
     await pipeline.process("Hello again!");
     expect(handler).toHaveBeenCalledTimes(1); // Should not be called again
@@ -59,10 +59,10 @@ describe('Pipeline Events', () => {
   test('should handle multiple event listeners', async () => {
     const handler1 = jest.fn();
     const handler2 = jest.fn();
-    
+
     pipeline.on(PipelineEvent.RunStart, handler1);
     pipeline.on(PipelineEvent.RunStart, handler2);
-    
+
     await pipeline.process("Hello world!");
 
     expect(handler1).toHaveBeenCalledTimes(1);
@@ -90,11 +90,11 @@ describe('Pipeline Events', () => {
   test('should have correct event payload structure', async () => {
     let runStartPayload: any;
     let processorStartPayload: any;
-    
+
     pipeline.on(PipelineEvent.RunStart, (payload) => {
       runStartPayload = payload;
     });
-    
+
     pipeline.on(PipelineEvent.ProcessorStart, (payload) => {
       processorStartPayload = payload;
     });

tests/llms-base.test.ts

@@ -37,7 +37,7 @@ describe('BaseLLMAdapter', () => {
     it('should initialize with default values when not provided', () => {
       const minimalConfig: LLMConfig = { apiKey: 'test-key' };
       const minimalAdapter = new TestLLMAdapter(minimalConfig);
-      
+
       expect(minimalAdapter).toBeDefined();
     });
 
@@ -419,7 +419,7 @@ describe('BaseLLMAdapter', () => {
   describe('generateWithCache', () => {
     it('should cache responses', async () => {
       const adapterWithCache = new TestLLMAdapter(defaultConfig, true);
-      
+
       const result1 = await (adapterWithCache as any).generateWithCache('test prompt');
       const result2 = await (adapterWithCache as any).generateWithCache('test prompt');
 
@@ -428,7 +428,7 @@ describe('BaseLLMAdapter', () => {
 
     it('should work without cache', async () => {
       const adapterNoCache = new TestLLMAdapter(defaultConfig, false);
-      
+
       const result = await (adapterNoCache as any).generateWithCache('test prompt');
 
       expect(result).toBeDefined();
@@ -476,7 +476,7 @@ describe('BaseLLMAdapter', () => {
 
     it('should store response with custom TTL from options', async () => {
       const adapterWithCache = new TestLLMAdapter(defaultConfig, true);
-      
+
       await (adapterWithCache as any).generateWithCache('test', { timeout: 600000 });
 
       // Response should be cached

tests/llms-openai.test.ts

@@ -228,7 +228,7 @@ describe('OpenAILLMAdapter', () => {
 
     it('should log error to console when response has no content', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
-      
+
       (global.fetch as jest.Mock).mockResolvedValue({
         ok: true,
         json: async () => ({
@@ -295,7 +295,7 @@ describe('OpenAILLMAdapter', () => {
     it('should handle AbortError specifically', async () => {
       const abortError = new Error('Aborted');
       abortError.name = 'AbortError';
-      
+
       (global.fetch as jest.Mock).mockRejectedValue(abortError);
 
       await expect(adapter.generate('Test')).rejects.toThrow('Request timed out');
@@ -304,7 +304,7 @@ describe('OpenAILLMAdapter', () => {
     it('should sanitize error messages', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
       const testError = new Error('Sensitive error details');
-      
+
       (global.fetch as jest.Mock).mockRejectedValue(testError);
 
       await expect(adapter.generate('Test')).rejects.toThrow(
@@ -320,7 +320,7 @@ describe('OpenAILLMAdapter', () => {
 
     it('should handle non-Error exceptions', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
-      
+
       (global.fetch as jest.Mock).mockRejectedValue('String error');
 
       await expect(adapter.generate('Test')).rejects.toThrow(
@@ -337,7 +337,7 @@ describe('OpenAILLMAdapter', () => {
     it('should include error name in sanitized message for Error objects', async () => {
       jest.spyOn(console, 'error').mockImplementation();
       const testError = new TypeError('Type error occurred');
-      
+
       (global.fetch as jest.Mock).mockRejectedValue(testError);
 
       await expect(adapter.generate('Test')).rejects.toThrow('TypeError');
@@ -472,7 +472,7 @@ describe('OpenAILLMAdapter', () => {
   describe('error logging', () => {
     it('should use console.error instead of console.warn for missing content', async () => {
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
-      
+
       (global.fetch as jest.Mock).mockResolvedValue({
         ok: true,
         json: async () => ({

tests/speech.test.ts

@@ -63,7 +63,7 @@ describe('Speech Processing Functions', () => {
   describe('analyzeSpeechPatterns', () => {
     it('should detect filler words', () => {
       const result = analyzeSpeechPatterns('Well, um, I think like basically it works');
-      
+
       expect(result.fillerWords).toContain('Well,');
       expect(result.fillerWords).toContain('um,');
       expect(result.fillerWords).toContain('like');
@@ -78,22 +78,22 @@ describe('Speech Processing Functions', () => {
 
     it('should detect stutters', () => {
       const result = analyzeSpeechPatterns('I am n-nervous and s-stuttering');
-      
+
       expect(result.stutters).toContain('n-nervous');
       expect(result.stutters).toContain('s-stuttering');
     });
 
     it('should handle mixed speech patterns', () => {
       const result = analyzeSpeechPatterns('Well, I think I think this is um, n-nervous');
-      
+
       expect(result.fillerWords).toContain('um,');
       expect(result.stutters).toContain('n-nervous');
       expect(result.repetitions.length).toBeGreaterThanOrEqual(0); // May or may not detect repetitions depending on implementation
     });
 
     it('should return empty arrays for normal text', () => {
       const result = analyzeSpeechPatterns('This is normal text without speech patterns');
-      
+
       expect(result.fillerWords).toHaveLength(0);
       expect(result.repetitions).toHaveLength(0);
       expect(result.stutters).toHaveLength(0);