-
Notifications
You must be signed in to change notification settings - Fork 0
[pull] main from regenrek:main #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Updated paths in the README files to reflect the new structure of the codefetch packages. - Enhanced the documentation for the `codefetch-sdk` with a unified API overview and quick start examples. - Corrected package references in the `cli` and `mcp` README files to point to the correct repository. - Removed outdated migration helpers and tests to streamline the codebase. These changes improve the clarity and accuracy of the documentation, ensuring users have the correct information for package usage.
…ality - Added `msw` as a dependency to improve testing capabilities with mock service workers. - Implemented a mock server in `packages/cli/test/mocks/server.ts` to handle HTTP requests during tests. - Updated test setup to start and stop the MSW server, ensuring proper request handling. - Removed outdated migration helpers from the SDK to streamline the codebase. These changes enhance the testing framework and provide a more robust environment for simulating HTTP interactions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Detailed code review comments
| - Project tree visualization | ||
| - Template variable support | ||
| - 🎯 **Unified `fetch()` API** - Single method for all sources (local, GitHub, web) | ||
| - 🚀 **Zero-config defaults** - Works out of the box with sensible defaults |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider mentioning upfront if this is a breaking change from previous API to help users prepare for migration
| main = "src/index.js" | ||
| compatibility_date = "2024-01-01" | ||
| # No nodejs_compat needed! | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add explanation of why nodejs_compat is no longer needed to help users understand the improvement
| @@ -1,324 +0,0 @@ | |||
| /** | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing migration file without replacement leaves users without upgrade path. Consider keeping with deprecation notice or document migration steps elsewhere.
| http.get("https://codeload.github.com/:owner/:repo/tar.gz/:ref", () => { | ||
| // This is a placeholder for a more sophisticated mock if needed | ||
| return new HttpResponse(null, { status: 200 }); | ||
| }), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mock returns empty response with 200 status. Consider adding minimal test data to better simulate real responses
| # Changelog | ||
|
|
||
| ## 2.0.0 | ||
| ## Current Version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replacing version number with 'Current Version' reduces version tracking clarity. Consider keeping explicit version numbers.
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/codefetch-ai/codefetch | ||
| git clone https://github.com/regenrek/codefetch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Repository URL change indicates ownership transfer. Ensure all documentation and dependencies are updated accordingly.
| } from "./cache-enhanced.js"; | ||
|
|
||
| // Migration helpers (Worker-safe) | ||
| export { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing migration helpers could break backward compatibility for existing users. Consider maintaining these exports with a deprecation notice if this is a breaking change.
| ## Contributing | ||
|
|
||
| See the [main repository](https://github.com/codefetch-ai/codefetch) for contribution guidelines. | ||
| See the [main repository](https://github.com/regenrek/codefetch) for contribution guidelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Repository URL change may indicate project ownership transfer. Verify this is intentional and update all related documentation consistently.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.3)
Can you help keep this open source service alive? 💖 Please sponsor : )
Summary by Sourcery
Revamp the SDK and Worker documentation to showcase the new unified fetch() API, streamline installation and usage examples, update package names and CHANGELOG, remove deprecated migration helpers, and enhance the CLI tests with MSW mocks
New Features:
Enhancements:
Tests: