gqlformatter

README

gqlformatter

This is a GraphQL formatter, based on vektah/gqlparser.

The main objective is to provide a line by line output of GraphQL so it's easy to spot changes in committed queries.

Example use:

package main

import (
    "fmt"
    "log"

    "github.com/diegosz/gqlformatter"
)

func main() {
    s := "query{products(where:{and:{id:{gte:20} label:{eq:$label}}}){id name price}}"
    q, err := gqlformatter.FormatQuery(s)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(q)
}

query {
  products(
    where: {
      and: {
        id: { gte: 20 }
        label: { eq: $label }
      }
    }
  ) {
    id
    name
    price
  }
}

Documentation

Index

• Constants
• func FormatQuery(input string) (string, error)
• func FormatQueryMinified(input string) (string, error)
• func FormatQueryWithIndent(input, indent string) (string, error)
• type Formatter
  • func NewFormatter(w io.Writer, opts ...Option) Formatter
• type Option
  • func WithIndent(indent string) Option
  • func WithMinification() Option
• type Options

Constants

const (
	DefaultIndent = "  "
)

Functions

func FormatQuery

func FormatQuery(input string) (string, error)

func FormatQueryMinified

func FormatQueryMinified(input string) (string, error)

func FormatQueryWithIndent

func FormatQueryWithIndent(input, indent string) (string, error)

Types

type Formatter

type Formatter interface {
	FormatQueryDocument(doc *ast.QueryDocument)
}

func NewFormatter

func NewFormatter(
	w io.Writer,
	opts ...Option) Formatter

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures the Formatter.

func WithIndent

func WithIndent(indent string) Option

WithIndent returns an Option which sets the tab string to use.

func WithMinification

func WithMinification() Option

WithMinification returns an Option which sets minified output.

type Options

type Options []Option

Options turns a list of Option instances into an Option.