feat: add comprehensive repository badges and improvements (#37)

* fix: migrate to ESLint v9 flat config format

- Replace .eslintrc.js with eslint.config.js (ESLint v9 requirement)
- Add 'type': 'module' to package.json for ES module support
- Update Jest config to use ES module syntax
- Fix rollup configuration for new @rollup/plugin-typescript version
- Add proper globals configuration for Node.js and browser APIs
- Install globals package for ESLint configuration
- All tests and linting now working with new versions

Resolves ESLint v9 migration issues from Renovate updates

* chore: trigger CI to test ESLint v9 configuration

- Add comment to TypeScript README to trigger CI
- Test if ESLint v9 configuration works in CI environment

* fix: convert prepare.js to ES module syntax

- Convert CommonJS require() to ES module import syntax
- Add __dirname and __filename polyfills for ES modules
- Fixes TypeScript client CI failure due to ES module configuration

* refactor: extract shared TypeScript rules in ESLint config

- Extract duplicated TypeScript rules into sharedTypeScriptRules constant
- Replace inline rule objects in both base and test configs with shared constant
- Maintains all original rules and configurations unchanged
- Improves maintainability by eliminating code duplication
- Follows DRY principle for better code organization

* refactor: convert dev.js to ES module syntax

- Replace CommonJS require() calls with ES module import statements
- Add __dirname and __filename polyfills using fileURLToPath and path.dirname
- Import fileURLToPath from 'url' module for ES module compatibility
- Maintains all original functionality while using modern ES module syntax
- Consistent with prepare.js ES module conversion

* feat: integrate ESLint with Prettier to avoid conflicting rules

- Add eslint-config-prettier to devDependencies in package.json
- Import eslint-config-prettier in ESLint configuration
- Include prettier config in ESLint config array after js.configs.recommended
- Disables Prettier-related ESLint rules to prevent conflicts
- Ensures consistent code formatting between ESLint and Prettier
- Maintains all existing ESLint rules while preventing style conflicts

* refactor: extract shared globals in ESLint config

- Extract duplicated global declarations into sharedGlobals constant
- Include ...globals.node, ...globals.browser and readonly browser APIs
- Replace base config globals with sharedGlobals reference
- Replace test config globals with sharedGlobals + test-specific additions
- Eliminates code duplication while maintaining all original functionality
- Improves maintainability by centralizing global declarations

* fix: update package-lock.json for eslint-config-prettier

- Update package-lock.json to include eslint-config-prettier dependency
- Resolves CI failure where npm ci couldn't install due to lock file mismatch
- Ensures package.json and package-lock.json are in sync
- Fixes TypeScript Client CI/CD workflow dependency installation

* refactor: remove redundant global declarations from ESLint config

- Remove explicit fetch, setTimeout, clearTimeout declarations from sharedGlobals
- These globals are already included in globals.browser
- Eliminates duplication and improves maintainability

---------

Co-authored-by: Ben De Cock <[email protected]>

Author: VirtualAgentics

clients/typescript/.eslintignore

@@ -3,6 +3,8 @@
 A robust TypeScript client library for the ContextForge Memory API with
 comprehensive error handling, retry logic, and full type safety.
 
+<!-- Updated to trigger CI -->
+
 ## Features
 
 - **Full Type Safety**: Complete TypeScript definitions for all API types

clients/typescript/.eslintrc.js

@@ -0,0 +1,86 @@
+import js from '@eslint/js';
+import typescript from '@typescript-eslint/eslint-plugin';
+import typescriptParser from '@typescript-eslint/parser';
+import globals from 'globals';
+import prettier from 'eslint-config-prettier';
+
+// Shared TypeScript rules used by both base and test configurations
+const sharedTypeScriptRules = {
+  ...typescript.configs.recommended.rules,
+  '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+  '@typescript-eslint/explicit-function-return-type': ['error', {
+    allowExpressions: true,
+    allowTypedFunctionExpressions: true
+  }],
+  // Enforce explicit return types for exported/public APIs
+  '@typescript-eslint/explicit-module-boundary-types': 'error',
+  '@typescript-eslint/no-explicit-any': 'error',
+  '@typescript-eslint/no-inferrable-types': 'off',
+  '@typescript-eslint/strict-boolean-expressions': ['error', {
+    allowNullableObject: true
+  }],
+  'prefer-const': 'error',
+  'no-var': 'error',
+  'no-unused-vars': 'off', // Turn off base rule as it can conflict with @typescript-eslint/no-unused-vars
+};
+
+// Shared globals used by both base and test configurations
+const sharedGlobals = {
+  ...globals.node,
+  ...globals.browser,
+  URL: 'readonly',
+  Response: 'readonly',
+  RequestInit: 'readonly',
+  AbortController: 'readonly',
+};
+
+export default [
+  js.configs.recommended,
+  prettier,
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: 'module',
+        project: './tsconfig.json',
+      },
+      globals: sharedGlobals,
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+    },
+    rules: sharedTypeScriptRules,
+  },
+  {
+    files: ['tests/**/*.ts', '**/*.test.ts', '**/*.spec.ts'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: 'module',
+        project: './tsconfig.test.json',
+      },
+      globals: {
+        ...sharedGlobals,
+        ...globals.jest,
+        global: 'readonly',
+        Headers: 'readonly',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+    },
+    rules: sharedTypeScriptRules,
+  },
+  {
+    ignores: [
+      'dist/**',
+      'node_modules/**',
+      'coverage/**',
+      '*.js',
+      '*.mjs',
+    ],
+  },
+];

clients/typescript/README.md

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   preset: 'ts-jest/presets/default-esm',
   globals: {
     'ts-jest': {

clients/typescript/eslint.config.js

@@ -1,6 +1,7 @@
 {
   "name": "@contextforge/memory-client",
   "version": "0.1.0",
+  "type": "module",
   "description": "TypeScript client for ContextForge Memory API with v0 and v1 support",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -60,7 +61,6 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "peerDependencies": {},
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-terser": "^0.4.4",
@@ -69,6 +69,8 @@
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "globals": "^16.4.0",
     "husky": "^9.0.0",
     "jest": "^30.0.0",
     "prettier": "^3.1.0",

clients/typescript/jest.config.js

@@ -41,7 +41,7 @@ export default defineConfig([
         tsconfig: './tsconfig.json',
         declaration: true,
         declarationMap: true,
-        outDir: 'dist/types'
+        declarationDir: 'dist/types'
       }),
       terser()
     ],

clients/typescript/package-lock.json

@@ -16,9 +16,13 @@
  *   node scripts/dev.js pre-publish  - Run pre-publish checks/tasks
  */
 
-const { execSync } = require('child_process');
-const fs = require('fs');
-const path = require('path');
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 // Validate we're in the package root
 const packageJsonPath = path.join(__dirname, '..', 'package.json');

clients/typescript/package.json

@@ -5,12 +5,16 @@
  * Runs before npm install to ensure proper setup
  */
 
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 console.log('Preparing TypeScript client...');
 
 // Ensure dist directory exists
-const fs = require('fs');
-const path = require('path');
-
 const distDir = path.join(__dirname, '..', 'dist');
 if (!fs.existsSync(distDir)) {
   fs.mkdirSync(distDir, { recursive: true });