refactor: update package names from @enclavejs to @enclave-vm across the codebase#39
refactor: update package names from @enclavejs to @enclave-vm across the codebase#39frontegg-david merged 2 commits intomainfrom
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThis PR renames packages and import specifiers across the repo from the Changes
Sequence Diagram(s)(omitted — change set is a namespace/mapping migration without new multi-component control flow) Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/enclave/guides/scaling.mdx (1)
140-143: Inconsistent naming: "EnclaveJS Broker" references remain.The import paths have been correctly updated to
@enclave-vm/broker, but there are still references to "EnclaveJS Broker" in:
- Line 141: ASCII diagram label
- Line 495: Related links section
These should be updated for consistency with the new
@enclave-vmnamespace.📝 Suggested fix
┌─────────────────────────────────────────────────────────┐ │ Load Balancer │ └───────────────────────┬─────────────────────────────────┘ │ ┌───────────────┼───────────────┐ ▼ ▼ ▼ ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ │ API Pod 1 │ │ API Pod 2 │ │ API Pod 3 │ │ EnclaveClient │ │ EnclaveClient │ │ EnclaveClient │ └───────┬───────┘ └───────┬───────┘ └───────┬───────┘ │ │ │ └─────────────────┼─────────────────┘ ▼ - ┌─────────────────────┐ - │ EnclaveJS Broker │ - │ (Redis-backed) │ - └─────────┬───────────┘ + ┌─────────────────────┐ + │ Enclave Broker │ + │ (Redis-backed) │ + └─────────┬───────────┘And for the Related section:
-- [EnclaveJS Broker](/enclavejs/broker) - Broker configuration +- [Enclave Broker](/enclave-vm/broker) - Broker configurationAlso applies to: 495-495
libs/enclavejs-react/project.json (1)
1-6: Update project name to match the new namespace.The
namefield in project.json (line 2) remainsenclavejs-react, but package.json declares the npm package as@enclave-vm/react. The tags were updated to reflect the new namespace, but the project name should be aligned. Update line 2 to use the new naming convention consistently.
🤖 Fix all issues with AI agents
In `@docs/enclave/enclavejs/overview.mdx`:
- Line 176: Update the Markdown link text to match the target namespace: change
the link "[npm `@enclavejs`](https://www.npmjs.com/org/enclave-vm)" so the visible
text reflects the URL's organization (e.g., "[npm
`@enclave-vm`](https://www.npmjs.com/org/enclave-vm)"); locate the line containing
that link text in overview.mdx and replace only the link label to match the
"enclave-vm" namespace.
In `@libs/enclave-vm/package.json`:
- Around line 2-3: Add a CHANGELOG.md entry for version 2.8.0 documenting the
breaking rename from enclave-vm to `@enclave-vm/core`; state it is a breaking
change, show the before/after import example (import { Enclave } from
'enclave-vm' → import { Enclave } from '@enclave-vm/core'), and reference the
new package name "@enclave-vm/core" and version "2.8.0" so release notes clearly
call out migration steps for consumers.
🧹 Nitpick comments (5)
libs/enclavejs-types/package.json (1)
4-16: Consider updating description and keywords to reflect new branding.The description still says "EnclaveJS streaming runtime protocol" and the keywords include
"enclavejs". For consistency with the new@enclave-vmnamespace, these could be updated.📝 Suggested diff
- "description": "Type definitions and Zod schemas for the EnclaveJS streaming runtime protocol", + "description": "Type definitions and Zod schemas for the Enclave VM streaming runtime protocol", ... "keywords": [ - "enclavejs", "enclave", + "enclave-vm", "streaming",libs/enclavejs-client/package.json (1)
4-4: Consider updating the description to match the new namespace.The description still references "EnclaveJS" while the package has been renamed to
@enclave-vm/client. Consider updating for consistency:- "description": "Browser and Node.js client SDK for the EnclaveJS streaming runtime", + "description": "Browser and Node.js client SDK for the Enclave VM streaming runtime",libs/enclavejs-stream/src/index.ts (1)
2-4: Minor documentation inconsistency.Line 2 uses the new namespace
@enclave-vm/stream, but line 4 still references "EnclaveJS runtime" instead of "Enclave VM" as used in other files (e.g.,libs/enclavejs-broker/src/index.tsuses "Enclave VM streaming runtime").📝 Suggested fix for consistency
/** * `@enclave-vm/stream` * - * Streaming protocol implementation for EnclaveJS runtime. + * Streaming protocol implementation for Enclave VM runtime. * Includes NDJSON parsing, encryption, and reconnection handling.libs/enclavejs-broker/src/broker.ts (1)
1-7: Minor documentation inconsistency.The file-level doc comment at line 4 still references "EnclaveJS tool broker". Similarly, the class-level doc at line 56 mentions "EnclaveJS streaming sessions". Consider updating these for consistency with the namespace migration.
📝 Suggested fix for consistency
/** * Broker * - * Main entry point for the EnclaveJS tool broker. + * Main entry point for the Enclave VM tool broker. * * `@packageDocumentation` */And at line 56:
/** * Broker * - * The main orchestrator for EnclaveJS streaming sessions. + * The main orchestrator for Enclave VM streaming sessions.libs/enclavejs-stream/package.json (1)
2-4: Consider updating the description for consistency.The package name is updated to
@enclave-vm/stream, but the description still references "EnclaveJS runtime". Consider updating the description to align with the new namespace.Suggested change
{ "name": "@enclave-vm/stream", "version": "0.1.0", - "description": "Streaming protocol implementation for EnclaveJS runtime (NDJSON, encryption, reconnection)", + "description": "Streaming protocol implementation for Enclave VM runtime (NDJSON, encryption, reconnection)",
1 participant
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.