fix: resolve engineering practice violations (Rules 6, 7, 8) by murdore · Pull Request #1044 · juspay/neurolink

murdore · 2026-05-28T17:01:17Z

Summary

Fixes all engineering practice violations identified during audit against CLAUDE.md critical rules. Rebased onto latest release branch.

Issues Resolved

Closes [CRITICAL] formatProviderError throws instead of returning (Rule 6 violation) #1014 — [CRITICAL] Rule 6: formatProviderError must return, never throw
- Changed throw → return in src/lib/providers/litellm.ts
Closes [MEDIUM] Files with "Types" suffix violate naming convention (Rule 8) #1015 — [MEDIUM] Rule 8: No "Types" suffix in type filenames
- fileTypes.ts → fileExtensions.ts
- mimeTypes.ts → mimeConstants.ts
- Updated barrel imports in config/index.ts
Closes [LOW] 80 interface declarations should be converted to types (Rule 7) #1016 — [LOW] Rule 7: Zero interface, always use type
- Converted 78 interface declarations to type aliases across 40 files
- Used intersection types (&) instead of extends clauses

Verification

✅ Zero remaining interface declarations
✅ All changes non-breaking: type aliases structurally equivalent to interface
✅ Filename renames preserve same exports; barrel imports updated
✅ throw → return fix corrects a bug per Rule 6
✅ Rebased onto latest release — no merge conflicts

Files Changed: 42

Category	Files	Changes
Rule 6 fix	1	`src/lib/providers/litellm.ts`
Rule 8 fixes	3	2 renamed + 1 import update
Rule 7 fixes	40	`interface` → `type` conversions

Supersedes #1043 (closed due to branch rebase)

Summary by CodeRabbit

Refactor

Standardized TypeScript type declarations across the codebase by converting interface declarations to type aliases for improved consistency.

Bug Fixes

Fixed error handling to return error responses instead of throwing.

Closes juspay#1014 - Rule 6: formatProviderError must return, never throw - Changed throw to return in src/lib/providers/litellm.ts:556 Closes juspay#1015 - Rule 8: No 'Types' suffix in type filenames - Renamed fileTypes.ts -> fileExtensions.ts - Renamed mimeTypes.ts -> mimeConstants.ts - Updated barrel imports in config/index.ts Closes juspay#1016 - Rule 7: Zero interface, always use type - Converted 78 interface declarations to type aliases across: - docs-site/ (17 in 8 files) - scripts/ (34 in 16 files) - tools/ (11 in 4 files) - neurolink-demo/ (10 in 5 files) - landing/src/ (6 in 4 files) - test/ + vite.config.ts (3 in 2 files) - Used intersection types (&) instead of extends clauses All changes are non-breaking: type aliases are structurally equivalent to interfaces, filename renames preserve exports, and the throw->return fix corrects a bug per Rule 6.

vercel · 2026-05-28T17:01:21Z

Someone is attempting to deploy a commit to the Sachin Sharma's projects Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2026-05-28T17:01:42Z

📝 Walkthrough

Walkthrough

This PR modernizes the TypeScript type system across auxiliary code to achieve CLAUDE.md Rule 7 compliance, fixes a critical error-handling violation in LiteLLM embeddings (Rule 6), and updates module re-exports following file renames (Rule 8). The bulk of the work converts ~80 interface declarations to type aliases with no functional changes.

Changes

Type System Modernization and Rule Compliance

Layer / File(s)	Summary
LiteLLM embeddings error handling fix `src/lib/providers/litellm.ts`	Line 984: changes embeddings error path to `return` instead of `throw` the formatted error, aligning with Rule 6 error-handling contract.
Config module re-export path updates `src/lib/processors/config/index.ts`	Updates re-export source modules from `./mimeTypes.js` and `./fileTypes.js` to `./mimeConstants.js` and `./fileExtensions.js`, maintaining same exported identifiers.
Docs-site interface-to-type conversions `docs-site/scripts/build-llms-txt.ts`, `docs-site/scripts/create-version.ts`, `docs-site/scripts/gitChangeDetector.ts`, `docs-site/scripts/sync-docs.ts`, `docs-site/scripts/validate-frontmatter.ts`, `docs-site/src/hooks/useAlgoliaSearch.ts`, `docs-site/src/hooks/useLocalSearch.ts`, `docs-site/src/theme/hooks/useNewDocs.ts`	Converts 17 interface declarations (PriorityRule, DocFile, PackageJson, GitChangeInfo, SearchResult, etc.) to type aliases with identical field structure.
Landing page interface-to-type conversions `landing/src/lib/actions/reveal.ts`, `landing/src/lib/lsystem.ts`, `landing/src/lib/stores/canvasState.ts`, `landing/src/routes/api/og/templates.ts`	Converts 6 exported interface declarations (LBranch, LSystemOptions, NeuronPath, SectionCanvasConfig, RevealOptions, OGParams) to type aliases.
Neurolink demo interface-to-type conversions `neurolink-demo/create-comprehensive-demo-videos.ts`, `neurolink-demo/mcp-examples.ts`, `neurolink-demo/mcp-helpers.ts`, `neurolink-demo/mcp-workflow.ts`, `neurolink-demo/server.ts`	Converts 10 interface declarations (DemoAction, CommandResult, MCPServerConfig, SessionMessage, etc.) to type aliases preserving MCP workflow and session management shapes.
Scripts interface-to-type conversions `scripts/benchmarkThreeProviders.ts`, `scripts/comprehensiveTest.ts`, `scripts/coreFunctionalityTest.ts`, `scripts/correctedFunctionalityTest.ts`, `scripts/correctedSdkTest.ts`, `scripts/createCliOverviewVideo.ts`, `scripts/criticalTest.ts`, `scripts/env-validation.ts`, `scripts/examples/demo-without-keys.ts`, `scripts/modelServer.ts`, `scripts/phase6ValidationCleanup.ts`, `scripts/quality-metrics.ts`, `scripts/quickVerification.ts`, `scripts/sdkComprehensiveTest.ts`, `scripts/security-check.ts`, `scripts/testing/executeAllTestsParallel.ts`	Converts 34 interface declarations for benchmarking, testing, validation, and metrics data structures to type aliases.
Tools interface-to-type conversions `tools/automation/projectOrganizer.ts`, `tools/content/videoCleanup.ts`, `tools/testing/adaptiveTestRunner.ts`, `tools/testing/performanceMonitor.ts`	Converts 11 interface declarations for project organization, video analysis, test configuration, and performance benchmarking to type aliases.
Vite config type modernization `vite.config.ts`	Converts VitestConfig from interface with extends form to type alias using Omit intersection pattern.

🎯 2 (Simple) | ⏱️ ~12 minutes

released

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: resolving engineering practice violations for Rules 6, 7, and 8, which matches the PR's core objective.
Linked Issues check	✅ Passed	The PR successfully addresses all three linked issues: Rule 6 (throw→return fix in litellm.ts), Rule 8 (file renames in config folder with updated imports), and Rule 7 (78 interface-to-type conversions across 40 files).
Out of Scope Changes check	✅ Passed	All changes are in-scope: the PR exclusively addresses the three linked engineering practice violations and includes no unrelated modifications.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/lib/processors/config/index.ts

Parsing error: Unable to parse the specified 'tsconfig' file. Ensure it's correct and has valid syntax.

error TS5012: Cannot read file '/.svelte-kit/tsconfig.json': ENOENT: no such file or directory, open '/.svelte-kit/tsconfig.json'.

src/lib/providers/litellm.ts

Parsing error: Unable to parse the specified 'tsconfig' file. Ensure it's correct and has valid syntax.

error TS5012: Cannot read file '/.svelte-kit/tsconfig.json': ENOENT: no such file or directory, open '/.svelte-kit/tsconfig.json'.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Mechanical refactor to fix engineering practice violations: converts interface declarations to type aliases across the codebase, renames type-related filenames, and changes a throw to return in the LiteLLM provider's error formatting path.

Changes:

Converted 78 interface declarations to type aliases across 40 files.
Renamed fileTypes.ts → fileExtensions.ts and mimeTypes.ts → mimeConstants.ts, updating the barrel re-exports in config/index.ts.
Changed throw this.formatProviderError(...) to return this.formatProviderError(...) in src/lib/providers/litellm.ts.

Reviewed changes

Copilot reviewed 40 out of 42 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/lib/providers/litellm.ts	Replaces `throw` with `return` on `formatProviderError` call.
src/lib/processors/config/index.ts	Updates barrel imports for renamed mime/file modules.
vite.config.ts	Converts `VitestConfig` interface to `type` with intersection.
tools/testing/performanceMonitor.ts	Interface→type conversions for benchmark/result/results.
tools/testing/adaptiveTestRunner.ts	Interface→type conversions for runner config/results.
tools/content/videoCleanup.ts	Interface→type conversions for video info/analysis/results.
tools/automation/projectOrganizer.ts	Interface→type conversions for organizer types.
scripts/testing/executeAllTestsParallel.ts	Interface→type conversions for test case/result.
scripts/security-check.ts	Interface→type conversions for security issue/finding/results.
scripts/sdkComprehensiveTest.ts	Interface→type for SdkTestResult.
scripts/quickVerification.ts	Interface→type for VerifyEntry.
scripts/quality-metrics.ts	Interface→type conversions for all metrics types.
scripts/phase6ValidationCleanup.ts	Interface→type conversions for options/results.
scripts/modelServer.ts	Interface→type for ModelData/ModelConfig.
scripts/examples/demo-without-keys.ts	Interface→type conversions for mock types.
scripts/env-validation.ts	Interface→type conversions for issue/pattern/provider.
scripts/criticalTest.ts	Interface→type for TestResult.
scripts/createCliOverviewVideo.ts	Interface→type for CLICommand.
scripts/correctedSdkTest.ts	Interface→type for SdkTestResult.
scripts/correctedFunctionalityTest.ts	Interface→type for TestResult.
scripts/coreFunctionalityTest.ts	Interface→type for TestEntry.
scripts/comprehensiveTest.ts	Interface→type for LogEntry.
scripts/benchmarkThreeProviders.ts	Interface→type conversions for benchmark types.
neurolink-demo/server.ts	Interface→type for SessionMessage/Session.
neurolink-demo/mcp-workflow.ts	Interface→type for command/workflow results.
neurolink-demo/mcp-helpers.ts	Interface→type conversions for MCP types.
neurolink-demo/mcp-examples.ts	Interface→type for CommandResult.
neurolink-demo/create-comprehensive-demo-videos.ts	Interface→type for DemoAction.
landing/src/routes/api/og/templates.ts	Interface→type for OGParams.
landing/src/lib/stores/canvasState.ts	Interface→type for SectionCanvasConfig.
landing/src/lib/lsystem.ts	Interface→type conversions for LBranch/LSystemOptions/NeuronPath.
landing/src/lib/actions/reveal.ts	Interface→type for RevealOptions.
docs-site/src/theme/hooks/useNewDocs.ts	Interface→type for DocMetadata/NewDocsData.
docs-site/src/hooks/useLocalSearch.ts	Interface→type for SearchDocument/UseLocalSearchOptions.
docs-site/src/hooks/useAlgoliaSearch.ts	Interface→type for SearchResult/options/return.
docs-site/scripts/validate-frontmatter.ts	Interface→type conversions for validation types.
docs-site/scripts/sync-docs.ts	Interface→type for TransformResult/FileInfo.
docs-site/scripts/gitChangeDetector.ts	Interface→type for GitChangeInfo.
docs-site/scripts/create-version.ts	Interface→type for PackageJson.
docs-site/scripts/build-llms-txt.ts	Interface→type for PriorityRule/DocFile/ProviderInfo.

Comments suppressed due to low confidence (3)

src/lib/providers/litellm.ts:1

Changing throw to return here is likely incorrect and changes runtime behavior in a breaking way. formatProviderError returns an Error object (its name and surrounding throw this.formatProviderError(...) usages elsewhere imply this), so returning it from a function whose normal return type is the successful operation result will produce an Error instance as a value rather than propagating the failure. Downstream code that previously relied on the thrown exception will now silently receive an Error object as if it were a valid result, causing incorrect behavior or hard-to-diagnose runtime failures. If the rule requires that formatProviderError itself never throw, the fix should be applied inside formatProviderError (make it return an Error) while the call site keeps throw this.formatProviderError(...). Please revert this line to throw or refactor the call site to throw the returned error (e.g. throw this.formatProviderError(...)).
src/lib/processors/config/index.ts:1
Renaming mimeTypes.ts to mimeConstants.ts to avoid the Types suffix is reasonable, but mimeConstants is less descriptive than the original (the file exports MIME type groupings, not generic constants). Consider a more domain-accurate name such as mimeGroups.ts or mimeCategories.ts to preserve clarity while still complying with the no-Types-suffix rule. Optional.
tools/automation/projectOrganizer.ts:1
Categorization previously used interface with an index signature [key: string]: string[] alongside named properties. With interface, TypeScript validates each named property's type against the index signature at declaration time; converting to a type alias preserves the same structural shape but the index signature still requires every named property to be assignable to string[], which they are here, so this specific case is fine. However, note that for interfaces elsewhere that were extended (rather than just declared), intersection (&) is not always semantically equivalent — particularly with method overloads and declaration merging. Please audit any conversion where the original interface was being merged or extended externally; mechanical interface → type conversion can silently break such cases.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/lib/providers/litellm.ts (1)
984-989: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Fix LiteLLM embedMany error path: throw formatProviderError(...) instead of returning it

In src/lib/providers/litellm.ts callEmbeddings() (around lines 977-990), the !res.ok branch does return this.formatProviderError(new Error(...)). callEmbeddings() is typed to return Promise<number[][]>, while formatProviderError() returns an Error object—this breaks the return type contract and also prevents src/lib/server/routes/agentRoutes.ts from hitting its catch block (it only catches thrown errors).
Proposed fix
       if (!res.ok) {
         const bodyText = await res.text().catch(() => "");
         const parsed = bodyText
           ? (JSON.parse(bodyText) as {
               error?: { message?: string };
             })
           : undefined;
-        return this.formatProviderError(
+        throw this.formatProviderError(
           new Error(
             parsed?.error?.message ||
               `LiteLLM ${operation} failed with status ${res.status}`,
           ),
         );
       }
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/lib/providers/litellm.ts` around lines 984 - 989, In callEmbeddings(),
the error branch currently does "return this.formatProviderError(...)" which
returns an Error object and violates the Promise<number[][]> contract and
prevents upstream catch handlers; replace that return with "throw
this.formatProviderError(...)" so the formatted Error is thrown (not returned)
and will be caught by callers; refer to the callEmbeddings function and the
formatProviderError method when making this change.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@src/lib/providers/litellm.ts`:
- Around line 984-989: In callEmbeddings(), the error branch currently does
"return this.formatProviderError(...)" which returns an Error object and
violates the Promise<number[][]> contract and prevents upstream catch handlers;
replace that return with "throw this.formatProviderError(...)" so the formatted
Error is thrown (not returned) and will be caught by callers; refer to the
callEmbeddings function and the formatProviderError method when making this
change.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b12fd10f-6d43-4d68-8eb2-db4fa2a0f7b5

📥 Commits

Reviewing files that changed from the base of the PR and between 213ac6b and 228ec9b.

📒 Files selected for processing (42)

docs-site/scripts/build-llms-txt.ts
docs-site/scripts/create-version.ts
docs-site/scripts/gitChangeDetector.ts
docs-site/scripts/sync-docs.ts
docs-site/scripts/validate-frontmatter.ts
docs-site/src/hooks/useAlgoliaSearch.ts
docs-site/src/hooks/useLocalSearch.ts
docs-site/src/theme/hooks/useNewDocs.ts
landing/src/lib/actions/reveal.ts
landing/src/lib/lsystem.ts
landing/src/lib/stores/canvasState.ts
landing/src/routes/api/og/templates.ts
neurolink-demo/create-comprehensive-demo-videos.ts
neurolink-demo/mcp-examples.ts
neurolink-demo/mcp-helpers.ts
neurolink-demo/mcp-workflow.ts
neurolink-demo/server.ts
scripts/benchmarkThreeProviders.ts
scripts/comprehensiveTest.ts
scripts/coreFunctionalityTest.ts
scripts/correctedFunctionalityTest.ts
scripts/correctedSdkTest.ts
scripts/createCliOverviewVideo.ts
scripts/criticalTest.ts
scripts/env-validation.ts
scripts/examples/demo-without-keys.ts
scripts/modelServer.ts
scripts/phase6ValidationCleanup.ts
scripts/quality-metrics.ts
scripts/quickVerification.ts
scripts/sdkComprehensiveTest.ts
scripts/security-check.ts
scripts/testing/executeAllTestsParallel.ts
src/lib/processors/config/fileExtensions.ts
src/lib/processors/config/index.ts
src/lib/processors/config/mimeConstants.ts
src/lib/providers/litellm.ts
tools/automation/projectOrganizer.ts
tools/content/videoCleanup.ts
tools/testing/adaptiveTestRunner.ts
tools/testing/performanceMonitor.ts
vite.config.ts

Copilot AI review requested due to automatic review settings May 28, 2026 17:01

Copilot AI reviewed May 28, 2026

View reviewed changes

coderabbitai Bot reviewed May 28, 2026

View reviewed changes

Copilot started reviewing on behalf of murdore May 28, 2026 17:12 View session

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: resolve engineering practice violations (Rules 6, 7, 8)#1044

fix: resolve engineering practice violations (Rules 6, 7, 8)#1044
murdore wants to merge 1 commit into
juspay:releasefrom
murdore:fix/rules-6-7-8-clean

murdore commented May 28, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented May 28, 2026

Uh oh!

coderabbitai Bot commented May 28, 2026 •

edited

Loading

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

murdore commented May 28, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Issues Resolved

Verification

Files Changed: 42

Summary by CodeRabbit

Refactor

Bug Fixes

Uh oh!

vercel Bot commented May 28, 2026

Uh oh!

coderabbitai Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

murdore commented May 28, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 28, 2026 •

edited

Loading