Schema linting in GraphQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is schema linting in GraphQL?

Schema linting is the process of checking a GraphQL schema for style, consistency, and best practices to catch errors early and improve quality.

beginner

Why is schema linting important?

It helps find mistakes and inconsistencies in the schema before runtime, making APIs more reliable and easier to maintain.

beginner

Name a common tool used for GraphQL schema linting.

One common tool is graphql-schema-linter, which checks schemas against configurable rules.

intermediate

What kind of issues can schema linting detect?

It can detect naming inconsistencies, missing descriptions, deprecated fields, and violations of style rules.

intermediate

How does schema linting improve teamwork?

By enforcing consistent schema style and rules, it helps all team members write schemas that look and behave similarly, reducing confusion.

What is the main goal of schema linting in GraphQL?

A To execute GraphQL queries faster

B To check schema for errors and style issues

C To generate database tables automatically

D To encrypt GraphQL data

Schema linting focuses on checking the schema for errors and style issues before runtime.

Which of these is a common schema linting tool?

A Postman

B GraphQL Playground

C Apollo Client

D graphql-schema-linter

graphql-schema-linter is a tool specifically for linting GraphQL schemas.

Schema linting can help detect which of the following?

A Missing field descriptions

B Network latency

C Database connection errors

D User authentication failures

Schema linting checks schema structure and style, including missing descriptions.

How does schema linting benefit a development team?

A By generating UI components automatically

B By speeding up query execution

C By enforcing consistent schema style

D By managing user sessions

Consistent style helps teams avoid confusion and maintain quality.

When is schema linting usually performed?

A Before deploying the schema

B Only after deployment

C During user login

D When running database backups

Linting is done before deployment to catch issues early.

Explain what schema linting is and why it is useful in GraphQL development.

Think about how checking your work before sharing helps avoid problems.

Describe how schema linting tools help teams maintain a consistent GraphQL schema.

Consider how rules and checks keep everyone on the same page.

Practice

1. What is the main purpose of schema linting in GraphQL?

easy

A. To generate database tables automatically

B. To execute queries faster

C. To check the schema for mistakes and style issues

D. To encrypt data in the schema

Solution

1. Step 1: Understand schema linting role

   Schema linting is used to find errors and style problems in GraphQL schemas.

2. Step 2: Compare with other options

   Options B, C, and D describe unrelated tasks like query speed, database creation, or encryption.

3. Final Answer:

   To check the schema for mistakes and style issues -> Option C

4. Quick Check:

   Schema linting = check mistakes and style [OK]

Hint: Linting means checking code or schema for errors [OK]

Common Mistakes:

• Confusing linting with query execution
• Thinking linting creates database tables
• Assuming linting encrypts data

2. Which of the following is a correct way to define a linting rule for a GraphQL schema?

easy

A. schemaLint: off

B. lintSchema = false

C. enableLinting = 0

D. "no-unused-types": true

Solution

1. Step 1: Identify correct lint rule syntax

   Linting rules are usually defined as key-value pairs like "no-unused-types": true.

2. Step 2: Check other options for syntax errors

   Options A, B, and D use invalid or incorrect syntax for linting rules.

3. Final Answer:

   "no-unused-types": true -> Option D

4. Quick Check:

   Lint rule syntax = key: value [OK]

Hint: Lint rules use key-value pairs like "rule-name": true [OK]

Common Mistakes:

• Using assignment (=) instead of key-value pairs
• Using invalid property names
• Turning off linting with wrong syntax

3. Given this linting configuration snippet:

{
  "no-deprecated-fields": true,
  "require-description": true
}

What will happen if the schema uses a deprecated field without a description?

medium

A. Linting will pass without errors

B. Linting will report errors for both deprecated field and missing description

C. Linting will only check for missing descriptions

D. Linting will ignore deprecated fields

Solution

1. Step 1: Analyze linting rules

   "no-deprecated-fields": true means deprecated fields cause errors. "require-description": true means missing descriptions cause errors.

2. Step 2: Apply rules to schema case

   Schema has a deprecated field without description, so both rules trigger errors.

3. Final Answer:

   Linting will report errors for both deprecated field and missing description -> Option B

4. Quick Check:

   Both rules active = errors for both issues [OK]

Hint: Active lint rules cause errors for matching schema issues [OK]

Common Mistakes:

• Assuming lint ignores deprecated fields
• Thinking only one rule applies
• Believing missing description is allowed

4. You run a schema linter and get an error: Field 'userAge' is missing a description. Which fix will resolve this error?

medium

A. Add a description string above the 'userAge' field in the schema

B. Rename the field to 'ageUser'

C. Remove the 'userAge' field from the schema

D. Ignore the error and continue

Solution

1. Step 1: Understand the error meaning

   The error says the field lacks a description, so the linter expects a comment or description string.

2. Step 2: Choose the fix that adds description

   Adding a description string above the field satisfies the linter. Renaming or removing the field or ignoring the error does not fix the missing description.

3. Final Answer:

   Add a description string above the 'userAge' field in the schema -> Option A

4. Quick Check:

   Missing description = add description [OK]

Hint: Add descriptions as comments to fix missing description errors [OK]

Common Mistakes:

• Renaming field instead of adding description
• Deleting field unnecessarily
• Ignoring lint errors

5. You want to enforce that all GraphQL schema types have descriptions and no unused types exist. Which combined linting configuration achieves this?

hard

A. { "require-description": true, "no-unused-types": true }

B. { "allow-unused-types": true, "require-description": false }

C. { "no-deprecated-fields": true, "allow-unused-types": false }

D. { "require-description": false, "no-unused-types": false }

Solution

1. Step 1: Identify rules for descriptions and unused types

   "require-description": true enforces descriptions. "no-unused-types": true disallows unused types.

2. Step 2: Match configuration to requirements

   { "require-description": true, "no-unused-types": true } sets both rules to true, matching the goal. Other options disable one or both rules.

3. Final Answer:

   { "require-description": true, "no-unused-types": true } -> Option A

4. Quick Check:

   Both rules true = enforce descriptions and no unused types [OK]

Hint: Set both rules true to enforce descriptions and no unused types [OK]

Common Mistakes:

• Disabling required rules
• Confusing allow and no rules
• Partial enforcement only