Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request reorganizes the module exports and import paths across several packages. The previous export entries for Changes
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
More templates
@orpc/client
@orpc/contract
@orpc/openapi
@orpc/openapi-client
@orpc/react-query
@orpc/shared
@orpc/server
@orpc/standard-server
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
packages/client/package.json (1)
23-27: Consolidated Export under thestandardAdapter in PublishConfig
The publish configuration now replaces the removedopenapiandrpcexport entries with a consolidated./standardentry. This promotes a clearer export structure. Ensure that consumers of the package update their import paths accordingly.packages/openapi-client/README.md (5)
1-3: Use Standard<img>Tag for LogoThe current code uses an
<image>element, which is not a standard HTML tag. Using<img>with an appropriatealtattribute is recommended for better HTML compliance and accessibility.-<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 /> +<img align="center" src="https://orpc.unnoq.com/logo.webp" width="280" alt="oRPC logo" />
5-5: Empty<h1>TagThere is an empty
<h1></h1>tag on line 5. If it is not serving a purpose, please remove it; otherwise, populate it with a meaningful title to improve semantic structure.
28-46: Review Highlights Section for Consistency and SpellingThe “Highlights” list is comprehensive and informative. However, please double-check the term “Pinia Colada” (line 32) to ensure it is the intended name rather than a potential misspelling. Additionally, consider varying sentence structures in the bullet points where similar phrasing is used for enhanced readability.
🧰 Tools
🪛 LanguageTool
[misspelling] ~35-~35: Possible spelling mistakes found.
Context: ...: Supports Tanstack Query (React, Vue), Pinia Colada, and more. - Server Actions ⚡️: Ful...(EN_MULTITOKEN_SPELLING_TWO)
47-51: Documentation Link SectionThe “Documentation” section clearly provides a link to the full documentation. For an even better user experience, consider adding a brief summary of what users can expect to find there.
51-61: Enhance Package Descriptions for ConsistencyIn the “Packages” section, several bullet points (particularly for
@orpc/react-queryand@orpc/vue-query) are simply links without descriptive text. To maintain consistency and improve clarity, consider adding a brief description for these items. Additionally, rephrase some bullet points to vary the opening words and avoid repetitive sentence structures as flagged by static analysis.For example, you might revise:
- - [@orpc/react-query](https://tanstack.com/query/latest/docs/framework/react/overview). + - [@orpc/react-query](https://tanstack.com/query/latest/docs/framework/react/overview): Integrates React Query for efficient data fetching.🧰 Tools
🪛 LanguageTool
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... API on the client with type-safety. - [@orpc/react-query](https://www.npmjs.com/pack...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...test/docs/framework/react/overview). - [@orpc/vue-query](https://www.npmjs.com/packag...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...latest/docs/framework/vue/overview). - [@orpc/vue-colada](https://www.npmjs.com/packa...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~58-~58: Possible spelling mistakes found.
Context: ...ge/@orpc/vue-colada): Integration with Pinia Colada. - [@or...(EN_MULTITOKEN_SPELLING_TWO)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ada](https://pinia-colada.esm.dev/). - [@orpc/openapi](https://www.npmjs.com/package/...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...I specs and handle OpenAPI requests. - [@orpc/zod](https://www.npmjs.com/package/@orp...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (20)
packages/client/package.json(2 hunks)packages/client/src/adapters/fetch/rpc-link.ts(1 hunks)packages/client/src/adapters/standard/index.ts(1 hunks)packages/client/src/adapters/standard/rpc-serializer.test.ts(1 hunks)packages/client/src/adapters/standard/rpc-serializer.ts(1 hunks)packages/client/src/openapi/index.ts(0 hunks)packages/client/src/rpc/index.ts(0 hunks)packages/openapi-client/.gitignore(1 hunks)packages/openapi-client/README.md(1 hunks)packages/openapi-client/package.json(1 hunks)packages/openapi-client/src/adapters/standard/index.ts(1 hunks)packages/openapi-client/src/adapters/standard/openapi-serializer.test.ts(1 hunks)packages/openapi-client/src/adapters/standard/openapi-serializer.ts(1 hunks)packages/openapi-client/tsconfig.json(1 hunks)packages/openapi/package.json(1 hunks)packages/openapi/src/adapters/standard/openapi-codec.ts(1 hunks)packages/openapi/src/openapi-generator.ts(1 hunks)packages/openapi/tsconfig.json(1 hunks)packages/server/src/adapters/standard/rpc-codec.ts(1 hunks)packages/vue-colada/src/key.ts(1 hunks)
💤 Files with no reviewable changes (2)
- packages/client/src/rpc/index.ts
- packages/client/src/openapi/index.ts
✅ Files skipped from review due to trivial changes (14)
- packages/client/src/adapters/standard/index.ts
- packages/vue-colada/src/key.ts
- packages/openapi-client/.gitignore
- packages/openapi-client/src/adapters/standard/index.ts
- packages/client/src/adapters/standard/rpc-serializer.ts
- packages/openapi/src/openapi-generator.ts
- packages/openapi-client/tsconfig.json
- packages/client/src/adapters/fetch/rpc-link.ts
- packages/server/src/adapters/standard/rpc-codec.ts
- packages/openapi/src/adapters/standard/openapi-codec.ts
- packages/openapi-client/src/adapters/standard/openapi-serializer.test.ts
- packages/openapi-client/src/adapters/standard/openapi-serializer.ts
- packages/openapi-client/package.json
- packages/client/src/adapters/standard/rpc-serializer.test.ts
🧰 Additional context used
🪛 LanguageTool
packages/openapi-client/README.md
[misspelling] ~35-~35: Possible spelling mistakes found.
Context: ...: Supports Tanstack Query (React, Vue), Pinia Colada, and more. - Server Actions ⚡️: Ful...
(EN_MULTITOKEN_SPELLING_TWO)
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... API on the client with type-safety. - [@orpc/react-query](https://www.npmjs.com/pack...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...test/docs/framework/react/overview). - [@orpc/vue-query](https://www.npmjs.com/packag...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...latest/docs/framework/vue/overview). - [@orpc/vue-colada](https://www.npmjs.com/packa...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~58-~58: Possible spelling mistakes found.
Context: ...ge/@orpc/vue-colada): Integration with Pinia Colada. - [@or...
(EN_MULTITOKEN_SPELLING_TWO)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ada](https://pinia-colada.esm.dev/). - [@orpc/openapi](https://www.npmjs.com/package/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...I specs and handle OpenAPI requests. - [@orpc/zod](https://www.npmjs.com/package/@orp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (7)
packages/openapi/package.json (1)
67-69: New Dependency Addition:@orpc/openapi-client
The dependency"@orpc/openapi-client": "workspace:*"has been added to the dependencies. This aligns with the restructuring and integration of the new OpenAPI client package. Verify that the workspace version correctly resolves in your development environment and that any peer dependencies are updated accordingly.packages/openapi/tsconfig.json (1)
4-6: Added Project Reference for OpenAPI-Client
A new reference entry for theopenapi-clientpackage has been added in the"references"array. This change will help TypeScript correctly type-check and build across the projects in the workspace. Please double-check that this addition does not introduce any circular dependency issues.packages/client/package.json (1)
36-38: Updated Entry Point for thestandardAdapter
The new export entry"./standard": "./src/adapters/standard/index.ts"in the"exports"section correctly points to the updated adapter implementation. Confirm that all functionalities previously provided under the old entries are fully covered by the newstandardexport.packages/openapi-client/README.md (4)
7-20: Badge Section Looks GoodThe centered badge section is well structured, and the links provide clear information about the project (code coverage, downloads, license, and community). No changes needed here.
22-26: Clear Introductory SectionThe header “Typesafe APIs Made Simple 🪄” and the accompanying statement effectively communicate the package’s benefits. This section is concise and engaging.
62-65: Concise Description for@orpc/openapi-clientThis section succinctly describes the package’s core functionality (i.e., providing a core serializer for OpenAPI requests and responses). The description is clear and appropriate.
66-69: License InformationThe license section is standard and clearly provides the necessary details, including a link to the full MIT License text.
dinwwwh
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (9)
packages/contract/README.md (1)
2-2: Accessibility Improvement Added
The addition of thealt="oRPC logo"attribute on the image enhances accessibility by providing descriptive alternative text.Suggestion: Consider using the standard
<img>element instead of<image>unless a custom component is intended.packages/shared/README.md (1)
2-2: Accessibility Improvement Added
Addingalt="oRPC logo"to the image tag improves accessibility for users relying on assistive technologies.Suggestion: Evaluate if using the HTML-standard
<img>tag would be more appropriate for broader compatibility.packages/client/README.md (1)
2-2: Enhanced Image Accessibility
The updated image tag now includes analtattribute, which is a great step towards improving accessibility.Suggestion: If this
<image>element isn’t a custom component, consider replacing it with<img>to adhere to common HTML practices.packages/zod/README.md (1)
2-2: Accessibility Improvement in Documentation
Providing analt="oRPC logo"attribute ensures the image has a proper text alternative, aiding screen readers.Suggestion: Verify if the
<image>tag is intentional. If standard HTML is desired, switching to<img>may be beneficial.packages/server/README.md (1)
2-2: Image Tag Accessibility Enhanced
The inclusion ofalt="oRPC logo"improves the semantic quality and accessibility of the documentation.Suggestion: Consider using
<img>instead of<image>if there is no custom handling behind the tag.packages/openapi/README.md (1)
2-2: Accessibility Improvement & HTML Tag Review:
The addition of thealt="oRPC logo"attribute is a great improvement for accessibility by ensuring a proper text alternative is available for the logo. However, note that<image>is not a standard HTML element (typically,<img>is used). Please verify whether<image>is intentional for this project or if it should be replaced with<img>to ensure broader compatibility.packages/openapi-client/README.md (3)
5-5: Suggestion: Empty<h1>Element.
The<h1></h1>appears empty. Consider either removing it or providing a meaningful title that reflects the package’s identity.
24-24: Phrasing Improvement: Clarify Opening Statement.
The sentence beginning with "oRPC is a powerful combination of RPC and OpenAPI," could be rephrased for improved clarity and grammatical flow (e.g., "oRPC combines RPC and OpenAPI to enable end-to-end type safety...").
55-58: Style Improvement: Vary Sentence Beginnings in Package Descriptions.
The bullet points for [@orpc/react-query], [@orpc/vue-query], and [@orpc/vue-colada] all start with "Integration with." Consider varying the phrasing (for example, "Seamlessly integrates with" or "Offers compatibility with") to enhance readability.🧰 Tools
🪛 LanguageTool
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... API on the client with type-safety. - [@orpc/react-query](https://www.npmjs.com/pack...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...test/docs/framework/react/overview). - [@orpc/vue-query](https://www.npmjs.com/packag...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...latest/docs/framework/vue/overview). - [@orpc/vue-colada](https://www.npmjs.com/packa...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~58-~58: Possible spelling mistakes found.
Context: ...ge/@orpc/vue-colada): Integration with Pinia Colada. - [@or...(EN_MULTITOKEN_SPELLING_TWO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
README.md(1 hunks)packages/client/README.md(1 hunks)packages/contract/README.md(1 hunks)packages/openapi-client/README.md(1 hunks)packages/openapi/README.md(1 hunks)packages/react-query/README.md(1 hunks)packages/server/README.md(1 hunks)packages/shared/README.md(1 hunks)packages/standard-server-fetch/README.md(1 hunks)packages/standard-server-node/README.md(1 hunks)packages/standard-server/README.md(1 hunks)packages/vue-colada/README.md(1 hunks)packages/vue-query/README.md(1 hunks)packages/zod/README.md(1 hunks)
✅ Files skipped from review due to trivial changes (7)
- packages/standard-server/README.md
- packages/vue-colada/README.md
- README.md
- packages/vue-query/README.md
- packages/standard-server-node/README.md
- packages/react-query/README.md
- packages/standard-server-fetch/README.md
🧰 Additional context used
🪛 LanguageTool
packages/openapi-client/README.md
[misspelling] ~35-~35: Possible spelling mistakes found.
Context: ...: Supports Tanstack Query (React, Vue), Pinia Colada, and more. - Server Actions ⚡️: Ful...
(EN_MULTITOKEN_SPELLING_TWO)
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... API on the client with type-safety. - [@orpc/react-query](https://www.npmjs.com/pack...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...test/docs/framework/react/overview). - [@orpc/vue-query](https://www.npmjs.com/packag...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...latest/docs/framework/vue/overview). - [@orpc/vue-colada](https://www.npmjs.com/packa...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~58-~58: Possible spelling mistakes found.
Context: ...ge/@orpc/vue-colada): Integration with Pinia Colada. - [@or...
(EN_MULTITOKEN_SPELLING_TWO)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ada](https://pinia-colada.esm.dev/). - [@orpc/openapi](https://www.npmjs.com/package/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...I specs and handle OpenAPI requests. - [@orpc/zod](https://www.npmjs.com/package/@orp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (2)
packages/openapi-client/README.md (2)
35-35: Verify Library Name: "Pinia Colada".
A static analysis hint flagged a potential spelling issue. Please confirm that "Pinia Colada" is the intended library name and not a typographical error.🧰 Tools
🪛 LanguageTool
[misspelling] ~35-~35: Possible spelling mistakes found.
Context: ...: Supports Tanstack Query (React, Vue), Pinia Colada, and more. - Server Actions ⚡️: Ful...(EN_MULTITOKEN_SPELLING_TWO)
5-69: General Observation: Overall Readability and Consistency.
The README provides a comprehensive overview of features and related packages with clear badges and links. Ensure that all links (such as the documentation and license) remain updated as the ecosystem evolves, and review the formatting in a live preview to verify that all HTML elements render as expected.🧰 Tools
🪛 LanguageTool
[misspelling] ~35-~35: Possible spelling mistakes found.
Context: ...: Supports Tanstack Query (React, Vue), Pinia Colada, and more. - Server Actions ⚡️: Ful...(EN_MULTITOKEN_SPELLING_TWO)
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~56-~56: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... API on the client with type-safety. - [@orpc/react-query](https://www.npmjs.com/pack...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...test/docs/framework/react/overview). - [@orpc/vue-query](https://www.npmjs.com/packag...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...latest/docs/framework/vue/overview). - [@orpc/vue-colada](https://www.npmjs.com/packa...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~58-~58: Possible spelling mistakes found.
Context: ...ge/@orpc/vue-colada): Integration with Pinia Colada. - [@or...(EN_MULTITOKEN_SPELLING_TWO)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ada](https://pinia-colada.esm.dev/). - [@orpc/openapi](https://www.npmjs.com/package/...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...I specs and handle OpenAPI requests. - [@orpc/zod](https://www.npmjs.com/package/@orp...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
| <div align="center"> | ||
| <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" /> | ||
| </div> |
There was a problem hiding this comment.
Critical: Incorrect HTML tag for image element.
The tag <image> is non-standard; HTML requires <img> for displaying images. Please update this to ensure correct rendering in browsers and GitHub Markdown.
1 participant
Summary by CodeRabbit
New Features
Refactor
Documentation
altattributes to image tags.Chores