Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add GQLoom to ecosystem #3995

Merged
merged 1 commit into from
Feb 26, 2025
Merged

docs: add GQLoom to ecosystem #3995

merged 1 commit into from
Feb 26, 2025

Conversation

xcfox
Copy link
Contributor

@xcfox xcfox commented Feb 17, 2025

I'm very excited to introduce GQLoom to you, which can weave Zod types into GraphQL Schema.

GQLoom is a Code First GraphQL Schema Loom, used to weave runtime types in the TypeScript/JavaScript ecosystem into a GraphQL Schema.

As the most popular runtime validation library, Zod is given primary support by GQLoom!

With GQLoom and Zod, you can easily create a GraphQL Schema without writing GraphQL.

import { resolver, query, weave } from "@gqloom/core"
import { ZodWeaver } from "@gqloom/zod"
import { z } from "zod"

const helloResolver = resolver({
  hello: query(z.string())
   .input({ name: z.string().nullish() })
   .resolve(({ name }) => `Hello, ${name?? "World"}!`),
})

export const schema = weave(ZodWeaver, helloResolver)

The above code will be woven into the following GraphQL Schema:

type Query {
  hello(name: String): String!
}

GQLoom is also integrated with popular ORM libraries such as Prisma, MikroORM, and Drizzle. You only need to write the database table structure or entity model once, and GQLoom will weave them into the GraphQL Schema. GQLoom also provides resolver factories, with which you can create a complete GraphQL CRUD interface for database tables with just a few lines of code!

Summary by CodeRabbit

  • Documentation
    • Expanded ecosystem resources by adding a new reference, GQLoom, which offers an integration approach for connecting GraphQL schemas and resolvers using Zod. This update is reflected across several language versions of the documentation, providing users with an additional tool to enhance their development workflows.

Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The pull request updates the documentation by adding a new entry for the GQLoom project. This entry appears in multiple README files: the main English README, the Korean README, the Chinese README, and the Deno library README. Each addition introduces a link to GQLoom, a tool for weaving GraphQL schema and resolvers using Zod. No existing content has been removed or altered aside from appending these new entries.

Changes

File(s) Change Summary
README.md, README_KO.md, README_ZH.md, deno/.../README.md Added a new entry for GQLoom in the respective ecosystem/API sections to document its role in integrating GraphQL with Zod.

Poem

I'm a little rabbit with a hop so light,
Skipping through docs in the soft moonlight,
GQLoom joined the group with a cheerful cheer,
Bringing GraphQL and Zod together here,
With a twitch of my nose and a joyful tune,
I celebrate this update beneath the springtime moon!


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for guileless-rolypoly-866f8a ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 651e8fe
🔍 Latest deploy log https://app.netlify.com/sites/guileless-rolypoly-866f8a/deploys/67b35dfad7385d0008136a09
😎 Deploy Preview https://deploy-preview-3995--guileless-rolypoly-866f8a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (1)

539-540: Enhance the GQLoom Entry Description

The new entry for GQLoom has been added correctly with the appropriate link and a concise description. To further enhance clarity and better reflect the tool’s unique value—as highlighted in the PR objectives—consider expanding the description slightly (for example, by emphasizing its "code-first" approach and integration features with popular ORMs). Also, double-check that the punctuation and phrasing are consistent with the other entries in the list.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~539-~539: Loose punctuation mark.
Context: ...](https://github.com/modevol-com/gqloom): Weave GraphQL schema and resolvers usin...

(UNLIKELY_OPENING_PUNCTUATION)

deno/lib/README.md (1)

539-539: New Ecosystem Entry for GQLoom Added

The new entry for GQLoom integrates well into the Ecosystem list, providing a useful resource that showcases how Zod can be extended to generate GraphQL schema and resolvers. Consider reviewing the phrasing for consistency; for example, it might read more naturally as “Weave GraphQL schemas and resolvers using Zod” (note the plural “schemas”) to align with the common terminology in similar entries. Additionally, please double-check punctuation according to your style guide as a static analysis hint mentioned a loose punctuation mark near this addition.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~539-~539: Loose punctuation mark.
Context: ...](https://github.com/modevol-com/gqloom): Weave GraphQL schema and resolvers usin...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e308703 and 651e8fe.

📒 Files selected for processing (4)
  • README.md (1 hunks)
  • README_KO.md (1 hunks)
  • README_ZH.md (1 hunks)
  • deno/lib/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • README_KO.md
  • README_ZH.md
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~539-~539: Loose punctuation mark.
Context: ...](https://github.com/modevol-com/gqloom): Weave GraphQL schema and resolvers usin...

(UNLIKELY_OPENING_PUNCTUATION)

deno/lib/README.md

[uncategorized] ~539-~539: Loose punctuation mark.
Context: ...](https://github.com/modevol-com/gqloom): Weave GraphQL schema and resolvers usin...

(UNLIKELY_OPENING_PUNCTUATION)

@colinhacks colinhacks merged commit 1d6e1cb into colinhacks:main Feb 26, 2025
5 checks passed
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.

2 participants