Skip to main content

coverage

Schema coverage based on documents. Find out how many times types and fields are used in your application. See the official GraphQL Inspector documentation for details.

Installation#

yarn global add @graphql-cli/coverage

Usage#

graphql coverage [DOCUMENTS] [SCHEMA]

Arguments#

argumentdescriptiondefault
DOCUMENTSA glob pattern that points to GraphQL Documents / Operationsdocuments property in GraphQL Config file
SCHEMAA pointer to a schemaschema property in GraphQL Config file

Options#

optionaliasdescriptiondefault
--silent-sDo not render any stats in the terminalfalse
--write-wWrite a file with coverage statsdisabled
--deprecated-dFail on deprecated usagefalse
--require-rRequire a module[]
--token-tAn access tokenundefined
--header-hSet HTTP header (--header 'Auth: Basic 123')undefined