Skip to content

feat(lsp): add Rename Symbol support#19

Merged
amondnet merged 6 commits into
mainfrom
18-featlsp-add-rename-symbol-support
Dec 18, 2025
Merged

feat(lsp): add Rename Symbol support#19
amondnet merged 6 commits into
mainfrom
18-featlsp-add-rename-symbol-support

Conversation

@amondnet

Copy link
Copy Markdown
Contributor

Summary

Implements LSP Rename Symbol support (textDocument/prepareRename and textDocument/rename) for the @pleaseai/code-lsp package.

Changes

  • Add type schemas (TextEdit, WorkspaceEdit, PrepareRenameResult) with Zod validation
  • Add prepareRename() method to validate rename at position
  • Add rename() method to perform symbol rename
  • Add normalization for both changes and documentChanges WorkspaceEdit formats
  • Add rename capability (prepareSupport: true) to client initialization
  • Update CLAUDE.md documentation with new methods

Architecture Decisions (from Serena reference)

  • First successful result pattern: Only one LSP server typically owns a symbol's rename, so return first non-null result
  • WorkspaceEdit normalization: Normalize documentChanges format to changes for consistent handling
  • PrepareRenameResult: Support all three LSP formats (Range, {range, placeholder}, {defaultBehavior})

Test plan

  • 12 unit tests for type schema validation
  • 10 integration tests for prepareRename/rename LSP requests
  • Tests cover valid rename, invalid positions, parameter rename, and disabled manager

Closes #18

[Auto-checkpoint from /please:dev Phase 6]

Tasks completed:
- T001: Add type schemas (TextEdit, WorkspaceEdit, PrepareRenameResult)
- T002: Add rename capability to client initialization
- T003: Add normalization methods (normalizeWorkspaceEdit, normalizePrepareRename)
- T004: Add prepareRename() method
- T005: Add rename() method

Issue: #18
- Update CLAUDE.md with prepareRename/rename method documentation
- Add 12 unit tests for TextEdit, WorkspaceEdit, PrepareRenameResult schemas
- Add integration tests for prepareRename and rename LSP requests
- Tests verify both valid rename operations and edge cases

Part of #18
@amondnet amondnet linked an issue Dec 18, 2025 that may be closed by this pull request
8 tasks
@codecov

codecov Bot commented Dec 18, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 9.19540% with 158 lines in your changes missing coverage. Please review.
✅ Project coverage is 29.72%. Comparing base (e60e5c0) to head (764dfc9).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
packages/lsp/src/index.ts 8.67% 158 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #19      +/-   ##
==========================================
- Coverage   31.79%   29.72%   -2.07%     
==========================================
  Files           4        4              
  Lines        1730     1904     +174     
==========================================
+ Hits          550      566      +16     
- Misses       1180     1338     +158     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Add debug logging to prepareRename() and rename() catch handlers
- Filter out expected "method not found" errors from logging
- Add input validation for empty/whitespace newName parameter
- Update JSDoc to clarify null return semantics
- Add unit tests for empty newName validation
- Add documentation test for documentChanges normalization

Addresses PR #19 review feedback:
- Silent error handling now logs unexpected failures
- Ambiguous null returns are now documented
- Fix JSDoc @param syntax in rename() method
- Update eslint config to ignore spec/doc markdown files
- Add 4 more integration tests for edge cases:
  - Empty newName validation (integration)
  - Whitespace-only newName validation (integration)
  - Non-existent file handling for prepareRename
  - Non-existent file handling for rename

Note: Patch coverage gap is primarily due to:
- Private helper methods exercised through integration tests
- Error catch blocks requiring LSP server failures to trigger
Disable eslint --cache flag to prevent platform-specific cache
issues between local development and CI environments.
- Add husky for git hooks management
- Configure lint-staged to run eslint --fix on staged JS/TS files
- Use lint-staged --diff in CI for PR changed files only
- Keep full lint for push to main branch
@amondnet
amondnet merged commit 12ec597 into main Dec 18, 2025
6 of 9 checks passed
@amondnet
amondnet deleted the 18-featlsp-add-rename-symbol-support branch December 18, 2025 09:02
@passionfactory-bot passionfactory-bot Bot mentioned this pull request Dec 18, 2025
amondnet added a commit that referenced this pull request Dec 18, 2025
- Mark Rename Symbol as completed in TODO.md (PR #19)
- Add prepareRename and rename methods to packages/lsp/README.md
- Update session tasklist to reflect completed implementation
amondnet added a commit that referenced this pull request Dec 18, 2025
- Mark Rename Symbol as completed in TODO.md (PR #19)
- Add prepareRename and rename methods to packages/lsp/README.md
- Update session tasklist to reflect completed implementation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(lsp): add Rename Symbol support

1 participant