@ovrsea/graphql-schema-checker v1.0.4

Ovrsea GraphQL Schema Checker

A GraphQL Schema Checker that reads through your codebase and compares the graphql resolvers (queries & mutations) and fragments used with your project's graphql schema.json and returns the unused resolvers and fragments to keep a clean codebase.

Quickstart

Installing

npm install @ovrsea/graphql-schema-checker

Basic Usage

type FilePath = string;

type Options = {
  cwd?: string;
  ignore?: FilePath | string[];
  pattern?: string;
  verbose?: boolean;
  whitelist?: FilePath | string[];
};

const detectUnusedResolvers = async (
  schema: Schema,
  options: Options = {}) =>: Promise<{
    unnecessarilyWhitelistedResolvers: string[];
    unusedFragments: string[];
    unusedResolvers: string[];
  }> {};

Parameters

schema: JSON of the graphql schema

cwd: Path to the current working directory. Defaults to ""

ignore: FilePath (string) to a pattern ignore or string[] of patterns to ignore. Defaults to file path ./.schema-checker-ignore. An example is available in .schema-checker-ignore.example

pattern: A glob pattern to the files to check. Defaults to **/*.{ts,tsx,js},

verbose: Adds more log. Defaults to false,

whitelist: FilePath (string) to a whitelist of resolvers (queries and mutations only) or string[] of resolvers to whitelist. Defaults to ./.schema-checker-whitelist. An example is available in .schema-checker-whitelist.example

Return values

const detectUnusedResolvers = async (...) =>: Promise<{
    unnecessarilyWhitelistedResolvers: string[];
    unusedFragments: string[];
    unusedResolvers: string[];
  }> {};