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

tools: add graphql-shield-generator #1342

Open
wants to merge 1 commit into
base: source
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: GraphQL Shield Generator
description: Emits a GraphQL Shield from your GraphQL schema.
url: https://github.com/omar-dulaimi/graphql-shield-generator
github: omar-dulaimi/graphql-shield-generator
npm: "graphql-shield-generator"
---

This project helps you to automatically generate a GraphQL Shield from your GraphQL Schema, eliminating the need for manually
writing it. It reads your schema, so the shield generated is always in-sync.

```ts
import { generateGraphqlShield } from 'graphql-shield-generator';

await generateGraphqlShield({
schema,
options: {
outputDir: './permissions',
fileName: 'shield',
extension: 'ts',
},
});

// or

await generateGraphqlShield({
schema: { typeDefs, resolvers },
options: {
outputDir: './permissions',
fileName: 'shield',
extension: 'ts',
},
});

```