Readme by jbearak · Pull Request #16 · jbearak/raven

jbearak · 2026-02-01T04:43:00Z

Summary by CodeRabbit

Release Notes

Documentation
- Expanded documentation with new guides for configuration, cross-file awareness, and package awareness features.
- Reorganized README with updated branding and installation instructions.
Chores
- Rebranded project from Rlsp to Raven across all user-facing components, including the VS Code extension and configuration keys.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

- Rename project from Rlsp to Raven throughout README - Add "Why Raven?" section explaining cross-file awareness value - Add comparison table vs Ark and R Language Server - Document provenance: Ark (MIT) foundation + Sight cross-file system - Update copyright headers in Ark-derived files to include original Posit copyright (2024-2026) and note modifications (2026) - Files updated: main.rs, handlers.rs, backend.rs, state.rs, r_env.rs

- Rename crate directory: crates/rlsp -> crates/raven - Update package name in Cargo.toml - Update binary name from rlsp to raven - Update VS Code extension: name, displayName, config prefix (raven.*) - Update LSP protocol method: raven/activeDocumentsChanged - Update GitHub workflow for raven binary names - Update setup.sh and .gitignore - Update README config key prefixes to raven.*

Move detailed reference documentation to separate files: - docs/cross-file.md: Cross-file awareness reference - docs/packages.md: Package function awareness reference - docs/configuration.md: All configuration options consolidated README now focuses on installation, quick start, and comparison.

coderabbitai · 2026-02-01T04:43:15Z

📝 Walkthrough

Walkthrough

Comprehensive project rebrand from "rlsp" to "raven" affecting build configurations, source code identifiers, VS Code extension manifests, documentation, and CI/CD workflows. Changes include binary names, configuration namespaces, repository references, LSP notification channels, and setup scripts, with addition of new configuration and feature documentation files.

Changes

Cohort / File(s)	Summary
Build & CI/CD `.github/workflows/release.yml`, `setup.sh`	Updated binary names from rlsp to raven in build targets, artifact generation, VSCode extension packaging, and installation paths. Added TypeScript compilation step and VSIX fallback error handling.
Workspace & Manifest `Cargo.toml`, `crates/raven/Cargo.toml`, `.gitignore`	Updated workspace member from crates/rlsp to crates/raven, renamed binary target and package name from rlsp to raven, changed repository URL to reflect Raven project, and updated ignored binary paths.
Source Code `crates/raven/src/backend.rs`, `crates/raven/src/main.rs`, `crates/raven/src/handlers.rs`, `crates/raven/src/r_env.rs`, `crates/raven/src/state.rs`	Updated copyright headers across files with 2024–2026 date ranges and modification attribution. Renamed LSP notification route from "rlsp/activeDocumentsChanged" to "raven/activeDocumentsChanged" in backend.rs. Updated user-facing binary name in main.rs version/usage output from rlsp to raven.
VS Code Extension `editors/vscode/package.json`, `editors/vscode/scripts/bundle.js`, `editors/vscode/src/extension.ts`, `editors/vscode/src/test/helper.ts`	Renamed extension identity, display name, repository URL, and configuration namespace from rlsp to raven. Updated bundled binary names, notification channels, output channel label, client identifiers, and extension ID lookup in tests.
Documentation `README.md`, `docs/configuration.md`, `docs/cross-file.md`, `docs/packages.md`	Reorganized README with new branding (Raven vs Ark vs R Language Server comparisons), removed implementation-specific directives, added Installation/Download sections, and created three new documentation files covering configuration options, cross-file awareness features, and package function awareness.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Priority 2 3 indexing #2: Shares direct connection to the custom LSP notification route changes from "rlsp/activeDocumentsChanged" to "raven/activeDocumentsChanged" that affect backend and handler integration points.

Poem

🐰 A rabbit hops through code so bright,
From "rlsp" to "raven"—what a sight!
Names rebrand, binaries align,
Docs spring forth in prose divine,
The project soars on raven's wing! 🎉

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 63.64% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'Readme' is vague and does not convey the actual scope of changes, which includes a comprehensive project rebrand from 'Rlsp' to 'Raven' across multiple components, documentation updates, and build configuration changes.	Use a more descriptive title that captures the main objective, such as 'Rebrand project from Rlsp to Raven' or 'Update branding and documentation for Raven release'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

amazon-q-developer

Overall Assessment

This PR successfully implements a comprehensive rebranding from "rlsp" to "raven" across the entire codebase. The changes are systematic and well-executed, covering:

✅ Comprehensive Coverage: All major components updated including:

Cargo workspace and package names
Binary names and paths
VS Code extension configuration
Documentation and README
Build scripts and CI workflows
LSP method names and comments

✅ Consistent Implementation: The renaming is applied consistently across:

58 files changed with 502 additions and 440 deletions
Package.json, Cargo.toml, and all configuration files
Build scripts, setup scripts, and CI workflows
Documentation structure with new organized docs/

✅ Functional Correctness: Critical functionality preserved:

LSP method names updated correctly (raven/activeDocumentsChanged)
Binary paths and build targets updated
Extension configuration and settings updated
Copyright notices properly updated

✅ Documentation Improvements: The new README is much more concise and user-friendly, with better organization of documentation into separate files.

Minor Observations

The rebranding appears complete and functional. The code maintains all existing functionality while successfully transitioning to the new "raven" identity. The new documentation structure is an improvement over the previous monolithic README.

This is a clean, well-executed rebranding that should not introduce any functional regressions.

You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

⚠️ This PR contains more than 30 files. Amazon Q is better at reviewing smaller PRs, and may miss issues in larger changesets.

amazon-q-developer · 2026-02-01T04:44:27Z


    let (service, socket) = LspService::build(Backend::new)
-        .custom_method("rlsp/activeDocumentsChanged", Backend::handle_active_documents_changed)
+        .custom_method("raven/activeDocumentsChanged", Backend::handle_active_documents_changed)


The custom method name has been correctly updated from "rlsp/activeDocumentsChanged" to "raven/activeDocumentsChanged" to match the rebranding.

jbearak added 3 commits January 31, 2026 23:31

amazon-q-developer Bot reviewed Feb 1, 2026

View reviewed changes

jbearak merged commit c253bc7 into main Feb 1, 2026
2 checks passed

jbearak deleted the readme branch February 1, 2026 04:51

coderabbitai Bot mentioned this pull request Feb 3, 2026

Refactor #20

Merged

This was referenced May 6, 2026

Harden send-to-R temp cleanup and restrict config scopes #175

Merged

Add httpgd-backed plot viewer for Raven-managed R terminals #176

Merged

vscode r coexistence docs #194

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Readme#16

Readme#16
jbearak merged 3 commits intomainfrom
readme

jbearak commented Feb 1, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Feb 1, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

amazon-q-developer Bot left a comment

Uh oh!

amazon-q-developer Bot Feb 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

jbearak commented Feb 1, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai Bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

amazon-q-developer Bot left a comment

Choose a reason for hiding this comment

Overall Assessment

Minor Observations

Uh oh!

amazon-q-developer Bot Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jbearak commented Feb 1, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Feb 1, 2026 •

edited

Loading