docs: clarify legacy graphify-ts rename guidance#481
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughThe pull request updates user-facing documentation, registry metadata, and test assertions to clarify that Madar is the renamed continuation of graphify-ts. A "Rename and migration" section is added to the README, registry metadata notes are extended with rename context, and test infrastructure is added to validate rebrand content across canonical surfaces. ChangesRebrand surface and assertion updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 `@tests/unit/mcp-registry-metadata.test.ts`:
- Around line 178-180: The test currently verifies repo URLs but misses
asserting the canonical npm package name; update the unit test in
tests/unit/mcp-registry-metadata.test.ts to also assert that the CLI reference
text includes the package identifier by adding an expectation against the same
variable used for the CLI reference (reference) toContain the string
"`@lubab/madar`" so the test fails if the canonical package name is removed or
changed.
🪄 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 Plus
Run ID: 4d45ca52-2b56-409c-be26-c09b5596dd35
📒 Files selected for processing (5)
README.mddocs/mcp-registry/server.jsondocs/reference/cli-and-mcp.mdtests/unit/mcp-registry-metadata.test.tstests/unit/rebrand-surface.test.ts
Comment on lines
+178
to
180
| expect(reference).toContain('If you still discover older `graphify-ts` links or listings, Madar is the current project name.') | ||
| expect(reference).toContain('`https://github.com/mohanagy/madar`') | ||
| expect(releaseDoc).toContain('npm run registry:validate') |
There was a problem hiding this comment.
Assert the canonical npm package in this docs contract test.
These checks lock the repo URL, but they do not lock @lubab/madar. If the package identifier drops out of the CLI reference rename note, this PR objective still regresses while the test stays green.
Suggested assertion
expect(reference).toContain('If you still discover older `graphify-ts` links or listings, Madar is the current project name.')
+ expect(reference).toContain('`@lubab/madar`')
expect(reference).toContain('`https://github.com/mohanagy/madar`')📝 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.
Suggested change
| expect(reference).toContain('If you still discover older `graphify-ts` links or listings, Madar is the current project name.') | |
| expect(reference).toContain('`https://github.com/mohanagy/madar`') | |
| expect(releaseDoc).toContain('npm run registry:validate') | |
| expect(reference).toContain('If you still discover older `graphify-ts` links or listings, Madar is the current project name.') | |
| expect(reference).toContain('`@lubab/madar`') | |
| expect(reference).toContain('`https://github.com/mohanagy/madar`') | |
| expect(releaseDoc).toContain('npm run registry:validate') |
🤖 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 `@tests/unit/mcp-registry-metadata.test.ts` around lines 178 - 180, The test
currently verifies repo URLs but misses asserting the canonical npm package
name; update the unit test in tests/unit/mcp-registry-metadata.test.ts to also
assert that the CLI reference text includes the package identifier by adding an
expectation against the same variable used for the CLI reference (reference)
toContain the string "`@lubab/madar`" so the test fails if the canonical package
name is removed or changed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Testing
Closes #468
Summary by CodeRabbit
Documentation
Tests