/graphql-usage

🛠 A tool for refactoring GraphQL APIs

Primary LanguageTypeScriptMIT LicenseMIT

graphql-usage

Version CircleCI License

🛠 A tool for refactoring GraphQL APIs.

Installation

Global installation (recommended)

NPM:

$ npm install -g graphql-usage

Yarn:

$ yarn global add graphql-usage

Local installation

NPM:

$ npm install --save-dev graphql-usage

Yarn:

$ yarn add -D graphql-usage

Support and Requirements

  • Source files using JS, Flow, or TypeScript
  • Projects using Relay, Apollo, or graphql-tag
  • Source files must be in a Git project and the branch that's being analyzed must be pushed to GitHub

Usage

$ graphql-usage SCHEMA SOURCEDIR

Arguments:

  • SCHEMA: Path to the Graphql schema to report usage info for. Can be either a .json or .graphql file.
  • SOURCEDIR: Path to the source directory to analyze.

Options:

  • -h, --help: show CLI help
  • -v, --version: show CLI version
  • --exclude: Directories to ignore under src
  • --port: Port to run the report server on
  • --quiet: No output to stdout

Example:

$ graphql-usage ./schema.graphql ./src/