test: add BaseTool tests

Author: QuantGeekDev

.gitignore

@@ -5,3 +5,5 @@ README
 .DS_Store
 dist
 node_modules
+*.log
+coverage

jest.config.js

@@ -0,0 +1,25 @@
+/** @type {import('jest').Config} */
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+        tsconfig: {
+          module: 'Node16',
+          moduleResolution: 'Node16',
+        },
+      },
+    ],
+  },
+  testMatch: ['**/tests/**/*.test.ts'],
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  coverageDirectory: 'coverage',
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.d.ts', '!src/cli/**', '!src/index.ts'],
+};

package.json

@@ -25,8 +25,11 @@
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "format": "prettier --write \"src/**/*.ts\"",
-    "prepare": "npm run build"
-    "dev:pub": "rm -rf dist && npm run build && yalc publish --push"
+    "prepare": "npm run build",
+    "dev:pub": "rm -rf dist && npm run build && yalc publish --push",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+    "test:watch": "NODE_OPTIONS='--experimental-vm-modules' jest --watch",
+    "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage"
   },
   "engines": {
     "node": ">=18.19.0"

tests/README.md

@@ -0,0 +1,84 @@
+# MCP Framework Tests
+
+This directory contains unit tests for the MCP Framework.
+
+## Structure
+
+Tests are organized to mirror the source code structure:
+
+```
+tests/
+├── tools/
+│   └── BaseTool.test.ts
+├── resources/
+├── prompts/
+└── ...
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage
+npm run test:coverage
+
+# Run specific test file
+npm test tests/tools/BaseTool.test.ts
+```
+
+## Writing Tests
+
+1. **Naming Convention**: Test files should be named `[ComponentName].test.ts`
+2. **Location**: Place test files in a directory structure that mirrors `src/`
+3. **Imports**: Use `.js` extensions for local imports (ESM compatibility)
+4. **Test Structure**: Use `describe` blocks to group related tests
+
+### Example Test Structure
+
+```typescript
+import { describe, it, expect, beforeEach } from '@jest/globals';
+import { MyClass } from '../../src/path/to/MyClass.js';
+
+describe('MyClass', () => {
+  let instance: MyClass;
+
+  beforeEach(() => {
+    instance = new MyClass();
+  });
+
+  describe('methodName', () => {
+    it('should do something specific', () => {
+      // Test implementation
+    });
+  });
+});
+```
+
+## Testing Abstract Classes
+
+When testing abstract classes like `BaseTool`, create a concrete implementation:
+
+```typescript
+class TestTool extends MCPTool<TestInput> {
+  // Implement abstract properties and methods
+}
+```
+
+## Jest Configuration
+
+The Jest configuration (`jest.config.js`) is set up for:
+- TypeScript with ES modules
+- Node.js environment
+- Coverage reporting
+- Proper path resolution for `.js` imports
+
+## Coverage
+
+Coverage reports are generated in the `coverage/` directory and include:
+- All TypeScript files in `src/`
+- Exclusions: CLI tools, type definitions, and index files