@graphql-inspector/commands

What is @graphql-inspector/commands?

@graphql-inspector/commands is a toolset for inspecting, validating, and comparing GraphQL schemas. It helps developers ensure the integrity and compatibility of their GraphQL APIs by providing various commands to check for changes, validate schemas, and more.

What are @graphql-inspector/commands's main functionalities?

Schema Diff

The `diff` command allows you to compare two GraphQL schemas and identify the differences between them. This is useful for understanding what has changed between schema versions.

const { diff } = require('@graphql-inspector/commands');

const oldSchema = `type Query { hello: String }`;
const newSchema = `type Query { hello: String, goodbye: String }`;

const result = diff(oldSchema, newSchema);
console.log(result);

Schema Validation

The `validate` command checks a GraphQL schema for errors and inconsistencies. This helps ensure that the schema is correctly defined and adheres to GraphQL specifications.

const { validate } = require('@graphql-inspector/commands');

const schema = `type Query { hello: String }`;
const result = validate(schema);
console.log(result);

Schema Coverage

The `coverage` command analyzes how well your GraphQL queries cover your schema. This helps identify parts of the schema that are not being used or tested.

const { coverage } = require('@graphql-inspector/commands');

const schema = `type Query { hello: String }`;
const documents = [{ query: `{ hello }` }];

const result = coverage(schema, documents);
console.log(result);

Other packages similar to @graphql-inspector/commands

graphql-cli

graphql-cli is a command-line tool that provides various utilities for working with GraphQL schemas and queries. It offers functionalities like schema validation, introspection, and code generation. Compared to @graphql-inspector/commands, graphql-cli is more focused on providing a broad set of tools for different aspects of GraphQL development.

graphql-schema-linter

graphql-schema-linter is a tool for linting GraphQL schemas. It helps enforce best practices and coding standards by checking the schema against a set of rules. While @graphql-inspector/commands offers schema validation as one of its features, graphql-schema-linter is dedicated solely to linting and enforcing schema quality.

apollo

Apollo provides a suite of tools for building, managing, and monitoring GraphQL APIs. It includes features like schema validation, performance monitoring, and client-server communication. Apollo is a more comprehensive solution compared to @graphql-inspector/commands, which is focused specifically on schema inspection and validation.