feat: migrate module to protomcp.org/nanorpc by amery · Pull Request #29 · protomcp/nanorpc

amery · 2025-07-26T23:46:23Z

User description

Summary

Implements the module migration plan from issue #25 to move the repository from github.com/amery/nanorpc to the protomcp organization with canonical vanity imports at protomcp.org/nanorpc.

Changes Made

Updated module declaration in all go.mod files to protomcp.org/nanorpc
Updated all import statements across Go source files (39 files total)
Updated documentation references in README.md, AGENT.md, and package docs
Updated codecov badges to point to protomcp organization
Added protomcp terms to cspell dictionary

Verification

All tests pass with new import paths
make tidy succeeds with no issues
Module dependencies properly resolved

Next Steps

After this PR is merged:

The old github.com/amery/nanorpc repository can be forked back with deprecation notice
Vanity import configuration at protomcp.org/nanorpc
Begin subscription system implementation per SUBSCRIPTION_DESIGN.md

Related to #25

PR Type

Other

Description

Migrate module from github.com/amery/nanorpc to protomcp.org/nanorpc
Update all import paths across 39 Go files
Update documentation and badge references
Fix VSCode cspell configuration with symlink

Diagram Walkthrough

flowchart LR
  A["github.com/amery/nanorpc"] -- "module migration" --> B["protomcp.org/nanorpc"]
  B --> C["Update imports"]
  B --> D["Update documentation"]
  B --> E["Update badges"]
  F[".vscode/settings.json"] -- "fix cspell config" --> G[".vscode/cspell.json symlink"]

File Walkthrough

	Relevant files

Summary by CodeRabbit

Documentation
- Updated all documentation, README files, and badges to reference the new module path and URLs using the "protomcp.org/nanorpc" domain.
- Updated example code snippets and installation instructions to use the new import paths.
Chores
- Changed Go module paths and dependency references throughout the project to "protomcp.org/nanorpc".
- Updated spell checker configurations to recognize "PROTOMCP" and "protomcp" as valid terms.
- Adjusted VS Code settings to reference the new spell checker configuration location.
Style
- No user-facing style changes.

The configFile option is invalid in VSCode cspell extension. Create symlink .vscode/cspell.json -> ../internal/build/cspell.json to properly configure spell checking. Signed-off-by: Alejandro Mery <amery@apptly.co>

coderabbitai · 2025-07-26T23:46:37Z

Walkthrough

This change migrates all Go module paths, import statements, documentation references, and configuration files from the github.com/amery/nanorpc namespace to protomcp.org/nanorpc. Associated documentation, badges, and spell checker configurations are updated accordingly. No functional or logic changes are introduced; only references and metadata are affected.

Changes

Files/Groups	Change Summary
`.vscode/cspell.json`, `.vscode/settings.json`, `internal/build/cspell.json`	Spell checker config: new config file added, config path setting removed, "PROTOMCP" words added.
`go.mod`, `pkg/generator/go.mod`, `pkg/nanopb/go.mod`, `pkg/nanorpc/go.mod`	Module paths updated from `github.com/amery/nanorpc` to `protomcp.org/nanorpc` and submodules.
`README.md`, `AGENT.md`, `pkg/nanorpc/README.md`, `pkg/nanorpc/client/README.md`, `pkg/nanorpc/server/README.md`	Documentation and badge URLs updated to new module and organization paths.
`pkg/nanorpc/doc.go`	Package docs: URLs updated to new import paths.
`pkg/nanorpc/client/.go`, `pkg/nanorpc/client/_test.go`	Import paths updated to `protomcp.org/nanorpc` for all nanorpc-related imports.
`pkg/nanorpc/common/fields_test.go`	Import path for testutils updated to new module path.
`pkg/nanorpc/server/.go`, `pkg/nanorpc/server/_test.go`	Import paths for nanorpc and common packages updated to new module path.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related issues

amery/nanorpc#25: This PR implements the migration plan for moving the repository to the protomcp organization by updating all import paths, module declarations, and documentation as described in the issue.

Poem

A hop and a jump, the code takes flight,
From Amery’s burrow to Protomcp’s light.
Imports all polished, docs shining anew,
Spell-checker knows what’s proper and true.
With badges and paths now perfectly right—
🐇 Cheers to migrations done swift and bright!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 19fd485 and 08793f6.

⛔ Files ignored due to path filters (1)

pkg/nanorpc/nanorpc.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (35)

AGENT.md (1 hunks)
README.md (1 hunks)
go.mod (1 hunks)
internal/build/cspell.json (1 hunks)
pkg/generator/go.mod (1 hunks)
pkg/nanopb/go.mod (1 hunks)
pkg/nanorpc/README.md (3 hunks)
pkg/nanorpc/client/README.md (2 hunks)
pkg/nanorpc/client/client.go (1 hunks)
pkg/nanorpc/client/config.go (1 hunks)
pkg/nanorpc/client/config_test.go (1 hunks)
pkg/nanorpc/client/logger.go (1 hunks)
pkg/nanorpc/client/logger_test.go (1 hunks)
pkg/nanorpc/client/request.go (1 hunks)
pkg/nanorpc/client/request_counter_test.go (1 hunks)
pkg/nanorpc/client/request_test.go (1 hunks)
pkg/nanorpc/client/session.go (1 hunks)
pkg/nanorpc/common/fields_test.go (1 hunks)
pkg/nanorpc/doc.go (1 hunks)
pkg/nanorpc/go.mod (3 hunks)
pkg/nanorpc/server/README.md (6 hunks)
pkg/nanorpc/server/example_handlers_test.go (1 hunks)
pkg/nanorpc/server/handler.go (1 hunks)
pkg/nanorpc/server/handler_request_test.go (1 hunks)
pkg/nanorpc/server/handler_test.go (1 hunks)
pkg/nanorpc/server/interfaces.go (1 hunks)
pkg/nanorpc/server/logger.go (1 hunks)
pkg/nanorpc/server/logger_test.go (1 hunks)
pkg/nanorpc/server/request_context.go (1 hunks)
pkg/nanorpc/server/request_context_test.go (1 hunks)
pkg/nanorpc/server/server.go (1 hunks)
pkg/nanorpc/server/server_test.go (1 hunks)
pkg/nanorpc/server/session.go (1 hunks)
pkg/nanorpc/server/session_manager.go (1 hunks)
pkg/nanorpc/server/session_test.go (1 hunks)

✅ Files skipped from review due to trivial changes (32)

pkg/nanorpc/client/config.go
pkg/nanorpc/client/request.go
README.md
pkg/nanorpc/common/fields_test.go
internal/build/cspell.json
pkg/nanorpc/server/interfaces.go
pkg/nanorpc/server/session_manager.go
AGENT.md
pkg/nanorpc/client/README.md
pkg/nanorpc/client/logger_test.go
pkg/nanorpc/server/handler_request_test.go
pkg/nanorpc/server/session_test.go
pkg/nanorpc/client/logger.go
pkg/nanorpc/server/logger.go
pkg/nanorpc/server/request_context.go
pkg/nanorpc/server/handler_test.go
pkg/nanorpc/server/handler.go
pkg/nanorpc/server/request_context_test.go
pkg/nanorpc/server/example_handlers_test.go
pkg/nanorpc/client/client.go
pkg/nanorpc/server/session.go
pkg/nanorpc/client/request_counter_test.go
pkg/nanorpc/doc.go
pkg/nanorpc/server/server_test.go
pkg/nanorpc/client/session.go
go.mod
pkg/nanorpc/client/request_test.go
pkg/nanorpc/client/config_test.go
pkg/nanorpc/server/server.go
pkg/nanorpc/server/README.md
pkg/nanorpc/README.md
pkg/nanorpc/server/logger_test.go

🚧 Files skipped from review as they are similar to previous changes (3)

pkg/generator/go.mod
pkg/nanopb/go.mod
pkg/nanorpc/go.mod

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/protomcp-migration

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

qodo-code-review · 2025-07-26T23:47:08Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶 25 - Partially compliant Compliant requirements: • Update all import statements from `github.com/amery/nanorpc` to `protomcp.org/nanorpc` • Update go.mod module declaration • Update any documentation references • Update README.md - installation instructions and examples • Update AGENT.md - development guidelines • Update pkg/nanorpc/server/README.md • Update all Go source files in pkg/nanorpc/server/.go, pkg/nanorpc/.go, pkg/generator/*.go • Update test files throughout the codebase • Update any example code in documentation Non-compliant requirements: • Update CI/CD configurations that reference the old path Requires further human verification: • Run full test suite with new import paths • Verify `go get protomcp.org/nanorpc` works correctly
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Inconsistent Badge The codecov badge URLs still reference the old `gh/amery/nanorpc` organization instead of the new `gh/protomcp/nanorpc` organization, creating inconsistency with other updated references. [codecov-badge]: https://codecov.io/gh/amery/nanorpc/branch/main/graph/badge.svg [codecov-url]: https://codecov.io/gh/amery/nanorpc Inconsistent Badge The codecov badge URLs still reference the old `gh/amery/nanorpc` organization instead of the new `gh/protomcp/nanorpc` organization, creating inconsistency with other updated references. [codecov-badge]: https://codecov.io/gh/amery/nanorpc/branch/main/graph/badge.svg?flag=nanorpc [codecov-url]: https://codecov.io/gh/amery/nanorpc?flag=nanorpc

qodo-code-review · 2025-07-26T23:47:10Z

PR Code Suggestions ✨

No code suggestions found for the PR.

coderabbitai

Actionable comments posted: 2

🔭 Outside diff range comments (1)

.vscode/cspell.json (1)
1-54: Invalid JSON breaks CSpell integration

The file begins with a stray relative path and is missing an opening brace. VS Code will fail to load this config.

Fix by replacing the current contents with a minimal wrapper that merely extends the shared config:
-../internal/build/cspell.json
-  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
-  "version": "0.2",
-  "language": "en-GB",
-  "words": [
-    /* … large block omitted … */
-  ],
-  "ignorePaths": [
-    /* … */
-  ]
-}
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "extends": ["../internal/build/cspell.json"]
+}

🧹 Nitpick comments (2)

pkg/nanorpc/README.md (1)
255-260: Update Codecov badge & URL to new org path

Import paths were migrated, but the Codecov badge still points to the old amery repo. This will break coverage links once the fork is archived.
-[codecov-badge]: https://codecov.io/gh/amery/nanorpc/branch/main/graph/badge.svg?flag=nanorpc
-[codecov-url]: https://codecov.io/gh/amery/nanorpc?flag=nanorpc
+[codecov-badge]: https://codecov.io/gh/protomcp/nanorpc/branch/main/graph/badge.svg?flag=nanorpc
+[codecov-url]: https://codecov.io/gh/protomcp/nanorpc?flag=nanorpc
pkg/nanorpc/server/README.md (1)
305-310: Codecov badge still references deprecated repository

For consistency with the migration, update the Codecov links:
-[codecov-badge]: https://codecov.io/gh/amery/nanorpc/branch/main/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/amery/nanorpc
+[codecov-badge]: https://codecov.io/gh/protomcp/nanorpc/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/protomcp/nanorpc

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe3bdea and 19fd485.

⛔ Files ignored due to path filters (1)

pkg/nanorpc/nanorpc.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (37)

.vscode/cspell.json (1 hunks)
.vscode/settings.json (1 hunks)
AGENT.md (1 hunks)
README.md (1 hunks)
go.mod (1 hunks)
internal/build/cspell.json (1 hunks)
pkg/generator/go.mod (1 hunks)
pkg/nanopb/go.mod (1 hunks)
pkg/nanorpc/README.md (3 hunks)
pkg/nanorpc/client/README.md (2 hunks)
pkg/nanorpc/client/client.go (1 hunks)
pkg/nanorpc/client/config.go (1 hunks)
pkg/nanorpc/client/config_test.go (1 hunks)
pkg/nanorpc/client/logger.go (1 hunks)
pkg/nanorpc/client/logger_test.go (1 hunks)
pkg/nanorpc/client/request.go (1 hunks)
pkg/nanorpc/client/request_counter_test.go (1 hunks)
pkg/nanorpc/client/request_test.go (1 hunks)
pkg/nanorpc/client/session.go (1 hunks)
pkg/nanorpc/common/fields_test.go (1 hunks)
pkg/nanorpc/doc.go (1 hunks)
pkg/nanorpc/go.mod (3 hunks)
pkg/nanorpc/server/README.md (6 hunks)
pkg/nanorpc/server/example_handlers_test.go (1 hunks)
pkg/nanorpc/server/handler.go (1 hunks)
pkg/nanorpc/server/handler_request_test.go (1 hunks)
pkg/nanorpc/server/handler_test.go (1 hunks)
pkg/nanorpc/server/interfaces.go (1 hunks)
pkg/nanorpc/server/logger.go (1 hunks)
pkg/nanorpc/server/logger_test.go (1 hunks)
pkg/nanorpc/server/request_context.go (1 hunks)
pkg/nanorpc/server/request_context_test.go (1 hunks)
pkg/nanorpc/server/server.go (1 hunks)
pkg/nanorpc/server/server_test.go (1 hunks)
pkg/nanorpc/server/session.go (1 hunks)
pkg/nanorpc/server/session_manager.go (1 hunks)
pkg/nanorpc/server/session_test.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.md