README.md

tslint-plugin-graphql

Check your GraphQL query strings against a schema.

Install

npm install tslint-plugin-graphql --save-dev

Usage

Example of tslint.json

{
    "extends": [
        "tslint:latest",
        "tslint-plugin-graphql"
    ],
    "rules": {
        "object-literal-sort-keys": false,
        "graphql": [
            true,
            {
                // Import default settings for your GraphQL client. Supported values:
                // 'apollo', 'relay', 'lokka'
                "env": "apollo",
                "schemaJsonFilepath": "./graphql.schema.json",
                "tagName": "Relay.QL"
                // tagName is gql by default 
            }
        ]
    }
}

API

Test

npm install
npm test