fix: migrate to ESLint v9 flat config format #36
Conversation
- 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
📝 WalkthroughWalkthroughReplaces legacy ESLint config/ignore with a new flat ESLint config, migrates the TypeScript client to ES modules (package.json "type": "module", Jest export, scripts), updates Rollup TypeScript option to Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Convert scripts/prepare.js from CommonJS to ES module syntax - Convert scripts/dev.js from CommonJS to ES module syntax - Add __dirname polyfill using fileURLToPath and dirname - Fixes CI failure caused by 'type': 'module' in package.json - All scripts now work with ES module configuration Resolves TypeScript Client CI failures from ESLint v9 migration
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
clients/typescript/rollup.config.js (1)
11-12: Correct the fix scope and update package.json exports to match.The core issue is real: with
"type": "module", the CJS output must use.cjsextension. However, the review comment has two problems:
Lines 34-36 are incorrect: Those lines are the ESM build config (
format: 'esm'), not a CJS output. The.jsextension there is correct for ESM.package.json updates are missing: Updating only
rollup.config.jsto outputdist/index.cjswill break the CommonJS entry point becausepackage.jsonstill maps exports todist/index.js:
- Change
"main": "dist/index.js"→"main": "dist/index.cjs"- Change
"require": "./dist/index.js"→"require": "./dist/index.cjs"Apply the diff to lines 11-12 of
rollup.config.jsand update the corresponding entries inpackage.json.clients/typescript/tests/setup.ts (1)
1-17: Add missingafterEachimport for ESM compatibility.In ESM, Jest globals must be explicitly imported from
@jest/globals. TheafterEachfunction on line 15 is not imported and will cause aReferenceErrorat runtime in ESM mode.Apply this diff:
-import { jest } from '@jest/globals'; +import { jest, afterEach } from '@jest/globals';
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
clients/typescript/package-lock.jsonis excluded by!**/package-lock.jsonand included byclients/**
📒 Files selected for processing (9)
clients/typescript/.eslintignore(0 hunks)clients/typescript/.eslintrc.js(0 hunks)clients/typescript/eslint.config.js(1 hunks)clients/typescript/jest.config.js(1 hunks)clients/typescript/package.json(2 hunks)clients/typescript/rollup.config.js(1 hunks)clients/typescript/src/index.ts(9 hunks)clients/typescript/tests/contextforgeClient.test.ts(14 hunks)clients/typescript/tests/setup.ts(1 hunks)
💤 Files with no reviewable changes (2)
- clients/typescript/.eslintignore
- clients/typescript/.eslintrc.js
🧰 Additional context used
📓 Path-based instructions (10)
clients/typescript/**
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Update TypeScript client types and examples to match API changes
TypeScript client should use Husky with fast pre-commit checks and smoke-test pre-push workflow
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.tsclients/typescript/rollup.config.jsclients/typescript/package.jsonclients/typescript/jest.config.jsclients/typescript/eslint.config.js
⚙️ CodeRabbit configuration file
clients/typescript/**: Ensure strict typing, accurate DTOs from OpenAPI, consistent error shapes, and robust timeout/retry semantics.
Prefer fetch/axios configurations with sane defaults; avoid throwing ambiguous any-typed errors.
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.tsclients/typescript/rollup.config.jsclients/typescript/package.jsonclients/typescript/jest.config.jsclients/typescript/eslint.config.js
**/*
📄 CodeRabbit inference engine (.cursor/rules/security.mdc)
Avoid committing content matching common secret patterns (e.g., sk-..., AKIA..., ghp_..., password='...')
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.tsclients/typescript/rollup.config.jsclients/typescript/package.jsonclients/typescript/jest.config.jsclients/typescript/eslint.config.js
clients/typescript/**/*.ts
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
clients/typescript/**/*.ts: Use strict typing with interfaces for request/response objects (e.g., MemoryItem, StoreRequest, StoreResponse) and avoid weakly typed functions
Generate DTOs from the OpenAPI spec (e.g., using openapi-typescript) instead of writing manual DTOs to prevent drift
Avoid any; prefer specific types or unknown with type guards for processing API data
Implement a consistent ApiError shape and a base ContextForgeError class for API errors
Use typed exception subclasses (AuthenticationError, ValidationError, RateLimitError) and branch on them explicitly
Map technical error codes to user-friendly messages via a central ERROR_MESSAGES map and a helper (getUserFriendlyMessage)
Implement retry logic with configurable RetryConfig (maxRetries, baseDelay, maxDelay, jitter) and exponential backoff
Only retry on transient conditions (network errors, rate limits, server errors) via a shouldRetry predicate
HTTP client should use fetch with sane defaults: baseUrl, headers, JSON body, timeout via AbortController, and throw on non-OK responses
Use keep-alive/connection pooling where supported (e.g., Connection: keep-alive) to reuse connections
Support request/response interceptors to transform requests and responses centrally
Use zod for runtime validation of requests and responses; throw ValidationError on invalid data
Validate inputs: namespaces (non-empty, <=100, /^[a-zA-Z0-9_-]+$/), text (non-empty, <=65536), items array (1..100)
Code quality: No any types used in the codebase
Code quality: All functions declare explicit return types
Code quality: Timeouts are configured for HTTP requests (e.g., via AbortController)
Code quality: Public types are exported properly (e.g., DTOs, client interfaces)
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.ts
clients/typescript/**/*.{test,spec}.ts
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
clients/typescript/**/*.{test,spec}.ts: Write tests using Jest/Vitest conventions; mock fetch; assert request shape and response handling
Provide integration-style tests covering full workflows (store, search) using mocks as needed
Code quality: Retry logic is covered by tests (e.g., verifies attempts, delays, shouldRetry behavior)
Files:
clients/typescript/tests/contextforgeClient.test.ts
clients/**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
clients/**/*: Client libraries should follow sound API client design patterns
Client libraries must implement error handling and retry logic where appropriate
Ensure type safety and clear interfaces in client libraries
Provide documentation and examples for client libraries
Maintain cross-platform compatibility in client libraries
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.tsclients/typescript/rollup.config.jsclients/typescript/package.jsonclients/typescript/jest.config.jsclients/typescript/eslint.config.js
clients/typescript/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Enforce ESLint + Prettier standards in the TypeScript client
Files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.tsclients/typescript/src/index.tsclients/typescript/rollup.config.jsclients/typescript/jest.config.jsclients/typescript/eslint.config.js
clients/typescript/{**/*.test.ts,**/*.test.tsx,**/*.spec.ts,**/*.spec.tsx,**/*.test.js,**/*.test.jsx,**/*.spec.js,**/*.spec.jsx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use Jest tests with a smoke-test subset optimization for the TypeScript client
Files:
clients/typescript/tests/contextforgeClient.test.ts
clients/typescript/rollup.config.js
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
Use Rollup to build ESM, CJS, and minified UMD bundles with @rollup/plugin-typescript (declarations off in bundling) and terser for minification
Files:
clients/typescript/rollup.config.js
clients/typescript/**/package.json
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Bump TypeScript client version in package.json for breaking changes
Files:
clients/typescript/package.json
clients/typescript/package.json
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
package.json should expose proper entry points (main/module/types/exports) and include build/test/lint scripts (rollup, tsc, vitest, eslint)
Files:
clients/typescript/package.json
🧠 Learnings (6)
📓 Common learnings
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-23T13:33:13.407Z
Learning: Applies to clients/typescript/**/*.{ts,tsx,js,jsx} : Enforce ESLint + Prettier standards in the TypeScript client
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/**/*.ts : Implement a consistent ApiError shape and a base ContextForgeError class for API errors
Applied to files:
clients/typescript/tests/contextforgeClient.test.ts
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/**/*.{test,spec}.ts : Write tests using Jest/Vitest conventions; mock fetch; assert request shape and response handling
Applied to files:
clients/typescript/tests/contextforgeClient.test.tsclients/typescript/tests/setup.ts
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/rollup.config.js : Use Rollup to build ESM, CJS, and minified UMD bundles with rollup/plugin-typescript (declarations off in bundling) and terser for minification
Applied to files:
clients/typescript/rollup.config.js
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/tsconfig.json : tsconfig.json should enable strict type-checking and production-friendly options (e.g., strict, noImplicitAny, noUnusedLocals, declaration, sourceMap, outDir, rootDir, resolveJsonModule) and exclude tests from build
Applied to files:
clients/typescript/rollup.config.js
📚 Learning: 2025-10-23T13:33:13.407Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-23T13:33:13.407Z
Learning: Applies to clients/typescript/**/*.{ts,tsx,js,jsx} : Enforce ESLint + Prettier standards in the TypeScript client
Applied to files:
clients/typescript/eslint.config.js
🔇 Additional comments (14)
clients/typescript/src/index.ts (8)
260-262: Retry backoff sleep looks good.Cross‑platform, non‑blocking delay; no changes needed.
315-321: Good: strict array validations for store.Non‑empty and <=100 constraints match client guidelines.
As per coding guidelines.
340-351: Good: input validation for search.Checks for non‑empty strings and bounded top_k.
As per coding guidelines.
362-368: Good: input validation for embed.Non‑empty texts and <=100 enforced.
As per coding guidelines.
441-452: Good: v1Search validations mirror v0.Consistent constraints and messages.
As per coding guidelines.
471-476: Good: v1Embed validations.Aligned with v0 constraints.
As per coding guidelines.
497-501: Good: v1Checkpoint session_id validation.Prevents empty IDs.
536-545: Good: v1Restore validations.Non‑empty strings and bounded top_k.
As per coding guidelines.
clients/typescript/package.json (2)
71-73: Dev dep addition OK.globals is needed for ESLint flat config envs; version range is fine.
1-87: No lockfile found; cannot verify PR summary claim.The repository has no lock file (package-lock.json, yarn.lock, or pnpm-lock.yaml), so actual installed versions cannot be pinned or verified. The declared
"eslint": "^9.0.0"in package.json is permissive and would accept v9.38.0, but without access to the PR summary referenced in the original comment, the claim that it "states v9.38.0" cannot be verified from the codebase alone.The optional suggestion to bump to
"^9.38.0"for determinism is reasonable if v9.38.0 is the target version, but this requires manual confirmation of the PR summary content.clients/typescript/jest.config.js (1)
1-31: Jest ESM config LGTM.default export + ts-jest ESM preset and extensionsToTreatAsEsm are correct for ESM projects.
clients/typescript/rollup.config.js (1)
44-45: Good: declarationDir for typings.Emitting declarations under dist/types aligns with package.json "types".
clients/typescript/eslint.config.js (1)
56-59: No issues found. The tsconfig.test.json file exists, is valid JSON, and is properly configured for ESLint type-aware rules in the test environment.clients/typescript/tests/contextforgeClient.test.ts (1)
1-10: ESM imports properly configured for Jest.Import statements follow ESM conventions with explicit Jest globals imported from
@jest/globals. Mock setup withjest.MockedFunction<typeof fetch>is correctly typed and compatible with ESM Jest.
clients/typescript/eslint.config.js
Outdated
| rules: { | ||
| ...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 |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Leverage typed recommended configs for stricter safety.
Consider extending the type‑checked presets to get consistent, modern defaults.
- rules: {
- ...typescript.configs.recommended.rules,
+ rules: {
+ // Optionally merge in typed presets for stronger checks:
+ // ...typescript.configs['recommended-type-checked']?.rules,
+ // ...typescript.configs['strict-type-checked']?.rules,Also applies to: 78-85
🌐 Web query:
What are the current flat-config preset names for @typescript-eslint v8 to enable type-checked rules?
💡 Result:
The flat-config preset names that enable type-checked rules (v8) are:
- tseslint.configs.recommendedTypeChecked. [1]
- tseslint.configs.strictTypeChecked. [1]
- tseslint.configs.stylisticTypeChecked. [1]
(There is also a utility to disable type-checked rules: tseslint.configs.disableTypeChecked.) [2]
Sources:
[1] typescript-eslint — Linting with Type Information / Getting Started.
[2] typescript-eslint — Shared Configs.
Correct the type-checked preset names for @typescript-eslint v8 flat-config.
The suggested preset names use incorrect syntax. For v8 flat-config, the correct type-checked presets are tseslint.configs.recommendedTypeChecked, tseslint.configs.strictTypeChecked, and tseslint.configs.stylisticTypeChecked (using camelCase, not kebab-case).
rules: {
- // Optionally merge in typed presets for stronger checks:
- // ...typescript.configs['recommended-type-checked']?.rules,
- // ...typescript.configs['strict-type-checked']?.rules,
+ // Optionally merge in typed presets for stronger checks:
+ // ...tseslint.configs.recommendedTypeChecked?.rules,
+ // ...tseslint.configs.strictTypeChecked?.rules,Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In clients/typescript/eslint.config.js around lines 32 to 39, the preset name
used for @typescript-eslint v8 flat-config is incorrect; replace uses of the
old/incorrect preset (e.g., typescript.configs.recommended) with the correct
camelCase type-checked presets from the tseslint namespace — for example use
tseslint.configs.recommendedTypeChecked (or tseslint.configs.strictTypeChecked /
tseslint.configs.stylisticTypeChecked as appropriate) so the flat-config
correctly applies the type-checked rules.
| ignores: [ | ||
| 'dist/**', | ||
| 'node_modules/**', | ||
| 'coverage/**', | ||
| '*.js', | ||
| '*.mjs', | ||
| ], | ||
| }, |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Confirm intent to ignore all .js/.mjs files.
This will skip linting config files (eslint.config.js, jest.config.js, rollup.config.js). If you still want those linted, narrow ignores to dist/** only or explicitly include config files.
- '*.js',
- '*.mjs',
+ // Keep TS focused; optionally lint JS configs by removing these:
+ // '*.js',
+ // '*.mjs',📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ignores: [ | |
| 'dist/**', | |
| 'node_modules/**', | |
| 'coverage/**', | |
| '*.js', | |
| '*.mjs', | |
| ], | |
| }, | |
| ignores: [ | |
| 'dist/**', | |
| 'node_modules/**', | |
| 'coverage/**', | |
| // Keep TS focused; optionally lint JS configs by removing these: | |
| // '*.js', | |
| // '*.mjs', | |
| ], | |
| }, |
| { | ||
| "name": "@contextforge/memory-client", | ||
| "version": "0.1.0", | ||
| "type": "module", |
There was a problem hiding this comment.
Blocking: "type":"module" + CJS output as .js will break require() consumers.
With "type":"module", .js files are ESM. Your CJS build at dist/index.js will be treated as ESM and cannot be required. Emit .cjs and update exports/main.
"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",
+ "main": "dist/index.cjs",
"module": "dist/index.esm.js",
"types": "dist/types/index.d.ts",
"sideEffects": false,
"exports": {
".": {
"import": "./dist/index.esm.js",
- "require": "./dist/index.js",
+ "require": "./dist/index.cjs",
"types": "./dist/types/index.d.ts"
},
"./package.json": "./package.json"
},And in rollup.config.js (see comment there) rename the CJS artifact to dist/index.cjs.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "type": "module", | |
| "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.cjs", | |
| "module": "dist/index.esm.js", | |
| "types": "dist/types/index.d.ts", | |
| "sideEffects": false, | |
| "exports": { | |
| ".": { | |
| "import": "./dist/index.esm.js", | |
| "require": "./dist/index.cjs", | |
| "types": "./dist/types/index.d.ts" | |
| }, | |
| "./package.json": "./package.json" | |
| }, |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
clients/typescript/scripts/dev.js(1 hunks)clients/typescript/scripts/prepare.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
clients/typescript/**
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Update TypeScript client types and examples to match API changes
TypeScript client should use Husky with fast pre-commit checks and smoke-test pre-push workflow
Files:
clients/typescript/scripts/dev.jsclients/typescript/scripts/prepare.js
⚙️ CodeRabbit configuration file
clients/typescript/**: Ensure strict typing, accurate DTOs from OpenAPI, consistent error shapes, and robust timeout/retry semantics.
Prefer fetch/axios configurations with sane defaults; avoid throwing ambiguous any-typed errors.
Files:
clients/typescript/scripts/dev.jsclients/typescript/scripts/prepare.js
**/*
📄 CodeRabbit inference engine (.cursor/rules/security.mdc)
Avoid committing content matching common secret patterns (e.g., sk-..., AKIA..., ghp_..., password='...')
Files:
clients/typescript/scripts/dev.jsclients/typescript/scripts/prepare.js
clients/**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
clients/**/*: Client libraries should follow sound API client design patterns
Client libraries must implement error handling and retry logic where appropriate
Ensure type safety and clear interfaces in client libraries
Provide documentation and examples for client libraries
Maintain cross-platform compatibility in client libraries
Files:
clients/typescript/scripts/dev.jsclients/typescript/scripts/prepare.js
clients/typescript/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Enforce ESLint + Prettier standards in the TypeScript client
Files:
clients/typescript/scripts/dev.jsclients/typescript/scripts/prepare.js
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-23T13:33:13.407Z
Learning: Applies to clients/typescript/**/*.{ts,tsx,js,jsx} : Enforce ESLint + Prettier standards in the TypeScript client
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/rollup.config.js : Use Rollup to build ESM, CJS, and minified UMD bundles with rollup/plugin-typescript (declarations off in bundling) and terser for minification
🧬 Code graph analysis (1)
clients/typescript/scripts/prepare.js (1)
clients/typescript/scripts/dev.js (2)
__filename(25-25)__dirname(26-26)
- Improve ESLint configuration with tsconfigRootDir and cleaner rules - Add proper exports field and sideEffects to package.json - Simplify script imports by using path.dirname() instead of separate import - Enhance API key sanitization with better type checking - Remove redundant ESLint options handled by parser - Focus TypeScript linting by commenting out JS file ignores - Fix package.json duplicate keys and add secret allowlist pragma Applied 7 CodeRabbit suggestions across 5 files: - clients/typescript/eslint.config.js: ESLint config improvements - clients/typescript/package.json: Module resolution enhancements - clients/typescript/scripts/dev.js: Import optimization - clients/typescript/scripts/prepare.js: Import optimization - clients/typescript/src/index.ts: Better API key handling
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
clients/typescript/eslint.config.js(1 hunks)clients/typescript/package.json(2 hunks)clients/typescript/scripts/dev.js(1 hunks)clients/typescript/scripts/prepare.js(1 hunks)clients/typescript/src/index.ts(9 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
clients/typescript/**
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Update TypeScript client types and examples to match API changes
TypeScript client should use Husky with fast pre-commit checks and smoke-test pre-push workflow
Files:
clients/typescript/scripts/dev.jsclients/typescript/src/index.tsclients/typescript/eslint.config.jsclients/typescript/package.jsonclients/typescript/scripts/prepare.js
⚙️ CodeRabbit configuration file
clients/typescript/**: Ensure strict typing, accurate DTOs from OpenAPI, consistent error shapes, and robust timeout/retry semantics.
Prefer fetch/axios configurations with sane defaults; avoid throwing ambiguous any-typed errors.
Files:
clients/typescript/scripts/dev.jsclients/typescript/src/index.tsclients/typescript/eslint.config.jsclients/typescript/package.jsonclients/typescript/scripts/prepare.js
**/*
📄 CodeRabbit inference engine (.cursor/rules/security.mdc)
Avoid committing content matching common secret patterns (e.g., sk-..., AKIA..., ghp_..., password='...')
Files:
clients/typescript/scripts/dev.jsclients/typescript/src/index.tsclients/typescript/eslint.config.jsclients/typescript/package.jsonclients/typescript/scripts/prepare.js
clients/**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
clients/**/*: Client libraries should follow sound API client design patterns
Client libraries must implement error handling and retry logic where appropriate
Ensure type safety and clear interfaces in client libraries
Provide documentation and examples for client libraries
Maintain cross-platform compatibility in client libraries
Files:
clients/typescript/scripts/dev.jsclients/typescript/src/index.tsclients/typescript/eslint.config.jsclients/typescript/package.jsonclients/typescript/scripts/prepare.js
clients/typescript/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Enforce ESLint + Prettier standards in the TypeScript client
Files:
clients/typescript/scripts/dev.jsclients/typescript/src/index.tsclients/typescript/eslint.config.jsclients/typescript/scripts/prepare.js
clients/typescript/**/*.ts
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
clients/typescript/**/*.ts: Use strict typing with interfaces for request/response objects (e.g., MemoryItem, StoreRequest, StoreResponse) and avoid weakly typed functions
Generate DTOs from the OpenAPI spec (e.g., using openapi-typescript) instead of writing manual DTOs to prevent drift
Avoid any; prefer specific types or unknown with type guards for processing API data
Implement a consistent ApiError shape and a base ContextForgeError class for API errors
Use typed exception subclasses (AuthenticationError, ValidationError, RateLimitError) and branch on them explicitly
Map technical error codes to user-friendly messages via a central ERROR_MESSAGES map and a helper (getUserFriendlyMessage)
Implement retry logic with configurable RetryConfig (maxRetries, baseDelay, maxDelay, jitter) and exponential backoff
Only retry on transient conditions (network errors, rate limits, server errors) via a shouldRetry predicate
HTTP client should use fetch with sane defaults: baseUrl, headers, JSON body, timeout via AbortController, and throw on non-OK responses
Use keep-alive/connection pooling where supported (e.g., Connection: keep-alive) to reuse connections
Support request/response interceptors to transform requests and responses centrally
Use zod for runtime validation of requests and responses; throw ValidationError on invalid data
Validate inputs: namespaces (non-empty, <=100, /^[a-zA-Z0-9_-]+$/), text (non-empty, <=65536), items array (1..100)
Code quality: No any types used in the codebase
Code quality: All functions declare explicit return types
Code quality: Timeouts are configured for HTTP requests (e.g., via AbortController)
Code quality: Public types are exported properly (e.g., DTOs, client interfaces)
Files:
clients/typescript/src/index.ts
clients/typescript/**/package.json
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Bump TypeScript client version in package.json for breaking changes
Files:
clients/typescript/package.json
clients/typescript/package.json
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
package.json should expose proper entry points (main/module/types/exports) and include build/test/lint scripts (rollup, tsc, vitest, eslint)
Files:
clients/typescript/package.json
🧠 Learnings (9)
📓 Common learnings
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-23T13:33:13.407Z
Learning: Applies to clients/typescript/**/*.{ts,tsx,js,jsx} : Enforce ESLint + Prettier standards in the TypeScript client
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/rollup.config.js : Use Rollup to build ESM, CJS, and minified UMD bundles with rollup/plugin-typescript (declarations off in bundling) and terser for minification
📚 Learning: 2025-10-23T13:33:13.407Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-23T13:33:13.407Z
Learning: Applies to clients/typescript/**/*.{ts,tsx,js,jsx} : Enforce ESLint + Prettier standards in the TypeScript client
Applied to files:
clients/typescript/eslint.config.js
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/tsconfig.json : tsconfig.json should enable strict type-checking and production-friendly options (e.g., strict, noImplicitAny, noUnusedLocals, declaration, sourceMap, outDir, rootDir, resolveJsonModule) and exclude tests from build
Applied to files:
clients/typescript/eslint.config.js
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/package.json : package.json should expose proper entry points (main/module/types/exports) and include build/test/lint scripts (rollup, tsc, vitest, eslint)
Applied to files:
clients/typescript/package.json
📚 Learning: 2025-10-23T13:26:37.198Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-10-23T13:26:37.198Z
Learning: Applies to clients/typescript/**/package.json : Bump TypeScript client version in package.json for breaking changes
Applied to files:
clients/typescript/package.json
📚 Learning: 2025-10-23T13:26:37.198Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-10-23T13:26:37.198Z
Learning: Applies to clients/typescript/** : Update TypeScript client types and examples to match API changes
Applied to files:
clients/typescript/package.json
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/**/*.ts : Code quality: Public types are exported properly (e.g., DTOs, client interfaces)
Applied to files:
clients/typescript/package.json
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Code quality: Build artifacts are correct (dist contains expected ESM/CJS/UMD and types)
Applied to files:
clients/typescript/package.json
📚 Learning: 2025-10-23T13:31:29.892Z
Learnt from: CR
PR: VirtualAgentics/ConextForge_memory#0
File: .cursor/rules/typescript.mdc:0-0
Timestamp: 2025-10-23T13:31:29.892Z
Learning: Applies to clients/typescript/rollup.config.js : Use Rollup to build ESM, CJS, and minified UMD bundles with rollup/plugin-typescript (declarations off in bundling) and terser for minification
Applied to files:
clients/typescript/package.json
🧬 Code graph analysis (1)
clients/typescript/scripts/prepare.js (1)
clients/typescript/scripts/dev.js (2)
__filename(24-24)__dirname(25-25)
🪛 Biome (2.1.2)
clients/typescript/eslint.config.js
[error] 16-16: expected , but instead found :
Remove :
(parse)
[error] 48-48: Expected a property, a shorthand property, a getter, a setter, or a method but instead found '{'.
Expected a property, a shorthand property, a getter, a setter, or a method here.
(parse)
[error] 14-14: This property is later overwritten by an object member with the same name.
Overwritten with this property.
If an object property with the same name is defined multiple times (except when combining a getter with a setter), only the last definition makes it into the object and previous definitions are ignored.
Unsafe fix: Remove this property.
(lint/suspicious/noDuplicateObjectKeys)
🔇 Additional comments (2)
clients/typescript/src/index.ts (2)
120-122: LGTM! apiKey sanitization correctly addresses the past review.The type guard now properly checks
typeof apiKey === 'string'before callingtrim(), preventing runtime exceptions when consumers pass null, undefined, or non-string values. The pragma comment appropriately prevents false-positive secret detection.
262-262: LGTM! Formatting changes align with ESLint/Prettier standards.The setTimeout parameter formatting and error message quote normalization are style-only changes with no functional impact. These align with the TypeScript client's ESLint + Prettier standards.
Based on learnings
Also applies to: 317-317, 320-320, 342-342, 345-345, 348-348, 351-351, 365-365, 368-368, 443-443, 446-446, 449-449, 452-452, 473-473, 476-476, 500-500, 539-539, 542-542, 545-545
| parserOptions: { | ||
| project: './tsconfig.json', | ||
| tsconfigRootDir: import.meta.dirname, | ||
| ... | ||
| project: './tsconfig.test.json', | ||
| tsconfigRootDir: import.meta.dirname, |
There was a problem hiding this comment.
Critical: Malformed parserOptions with duplicate keys.
The parserOptions object contains duplicate project and tsconfigRootDir properties. Static analysis confirms line 14's tsconfigRootDir is overwritten by line 17. This configuration will only use the last values ('./tsconfig.test.json' and its tsconfigRootDir), breaking linting for non-test files.
The first config object (for general TS files) should reference './tsconfig.json', while the second config object (for test files at lines 48-92) should reference './tsconfig.test.json'. Remove the duplicate properties from lines 16-17 in the first config's parserOptions:
languageOptions: {
parser: typescriptParser,
parserOptions: {
project: './tsconfig.json',
tsconfigRootDir: import.meta.dirname,
- ...
- project: './tsconfig.test.json',
- tsconfigRootDir: import.meta.dirname,
+ ecmaVersion: 2020,
+ sourceType: 'module',
},
globals: {🧰 Tools
🪛 Biome (2.1.2)
[error] 16-16: expected , but instead found :
Remove :
(parse)
[error] 14-14: This property is later overwritten by an object member with the same name.
Overwritten with this property.
If an object property with the same name is defined multiple times (except when combining a getter with a setter), only the last definition makes it into the object and previous definitions are ignored.
Unsafe fix: Remove this property.
(lint/suspicious/noDuplicateObjectKeys)
🤖 Prompt for AI Agents
In clients/typescript/eslint.config.js around lines 12 to 17, the parserOptions
object has duplicate keys (project and tsconfigRootDir) that are being
overwritten by the test config values; remove the duplicate project and
tsconfigRootDir entries from the first parserOptions so it only references
'./tsconfig.json' and its tsconfigRootDir, and ensure the separate test
configuration (lines 48-92) retains './tsconfig.test.json' and its
tsconfigRootDir so linting for general and test files uses the correct tsconfig
files.
PR Closed - Superseded by PR 37
This PR has been closed because the ESLint v9 migration was already completed in PR 37 which was merged.
✅ Changes Already Implemented in PR 37:
eslint.config.js)"type": "module"in package.json)🧹 Remaining Cleanup:
The only remaining task is removing the legacy
.eslintrc.test.jsfile, which will be handled separately.Status: Superseded by PR 37 - ESLint v9 migration complete.