fix: update documentation to reflect folder-per-provider layout and co-located specs#429
fix: update documentation to reflect folder-per-provider layout and co-located specs#429frontegg-david wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughThis PR documents a recommended file organization pattern for FrontMCP providers: when providers grow beyond a single class (by adding specs, helpers, or types), they should be organized into per-provider folders with ChangesProvider File Layout Pattern
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@libs/skills/catalog/frontmcp-development/references/create-provider.md`:
- Around line 212-220: Replace the confusing import examples so the "✅ Good"
case actually shows the correct subfolder-barrel import and remove the
duplicate/contradictory line: show "import { TaskStoreProvider } from
'../task-store';" as the single ✅ Good example, keep the two distinct ❌ Bad
examples as "import { TaskStoreProvider } from '..';" (top-level barrel) and
"import { TaskStoreProvider } from '../task-store/task-store.provider';"
(reaching into implementation), and ensure only those three lines (one good, two
bad) remain in the block referencing TaskStoreProvider.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ef31093f-f7f6-4754-b736-60e538b7ba62
📒 Files selected for processing (5)
docs/frontmcp/extensibility/providers.mdxlibs/skills/catalog/frontmcp-development/examples/create-provider/basic-database-provider.mdlibs/skills/catalog/frontmcp-development/examples/create-provider/config-and-api-providers.mdlibs/skills/catalog/frontmcp-development/references/create-provider.mdlibs/skills/catalog/skills-manifest.json
| ```typescript | ||
| // ✅ Good — imports through the subfolder barrel | ||
|
|
||
| // ❌ Bad — top-level barrel for sibling imports causes circular-init churn | ||
| import { TaskStoreProvider } from '..'; | ||
| import { TaskStoreProvider } from '../task-store'; | ||
| // ❌ Bad — reaches into another provider's implementation file | ||
| import { TaskStoreProvider } from '../task-store/task-store.provider'; | ||
| ``` |
There was a problem hiding this comment.
Fix the cross-provider import example block (missing “good” import and contradictory snippet).
The snippet labels a “✅ Good” case but doesn’t show it, and then presents conflicting imports in the same block. Keep one explicit good import and the bad variants separated.
Suggested doc fix
```typescript
// ✅ Good — imports through the subfolder barrel
+import { TaskStoreProvider } from '../task-store';
// ❌ Bad — top-level barrel for sibling imports causes circular-init churn
import { TaskStoreProvider } from '..';
-import { TaskStoreProvider } from '../task-store';
// ❌ Bad — reaches into another provider's implementation file
import { TaskStoreProvider } from '../task-store/task-store.provider';</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @libs/skills/catalog/frontmcp-development/references/create-provider.md
around lines 212 - 220, Replace the confusing import examples so the "✅ Good"
case actually shows the correct subfolder-barrel import and remove the
duplicate/contradictory line: show "import { TaskStoreProvider } from
'../task-store';" as the single ✅ Good example, keep the two distinct ❌ Bad
examples as "import { TaskStoreProvider } from '..';" (top-level barrel) and
"import { TaskStoreProvider } from '../task-store/task-store.provider';"
(reaching into implementation), and ensure only those three lines (one good, two
bad) remain in the block referencing TaskStoreProvider.
</details>
<!-- fingerprinting:phantom:triton:hawk -->
<!-- This is an auto-generated comment by CodeRabbit -->
Performance Test ResultsStatus: ✅ All tests passed Summary
Total: 101 tests across 21 projects 📊 View full report in workflow run Generated at: 2026-05-17T09:19:04.972Z |
1 participant
Summary by CodeRabbit