GraphQL Schema Linter Action

A GitHub Action to lint GraphQL schema files for naming conventions using graphql-schema-linter.

Usage

- uses: DataSQRL/graphql-schema-linter-action@v1

With custom options

- uses: DataSQRL/graphql-schema-linter-action@v1
  with:
    schemas: 'src/**/*.graphqls'
    rules: 'fields-are-camel-cased,types-are-capitalized'
    ignore: '{"fields-are-camel-cased":["Query.Shipment","Query.Customer"]}'

Inputs

Input	Required	Default	Description
schemas	No	**/*.graphqls	Glob pattern or space-separated list of schema files
rules	No	fields-are-camel-cased,types-are-capitalized,enum-values-all-caps,input-object-values-are-camel-cased	Comma-separated linting rules
ignore	No	{}	JSON object for ignoring specific rule violations

Available Rules

• fields-are-camel-cased - Field names should be camelCase
• types-are-capitalized - Type names should be PascalCase
• enum-values-all-caps - Enum values should be ALL_CAPS
• input-object-values-are-camel-cased - Input object field names should be camelCase

See graphql-schema-linter rules for more options.

Example Workflow

name: Lint

on: [push, pull_request]

jobs:
  lint-graphql:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: DataSQRL/graphql-schema-linter-action@v1
        with:
          ignore: '{"fields-are-camel-cased":["Query.MyTable"]}'

License

MIT