GraphQL Exemplar

Description

GraphQL Exemplar is a powerful package designed to ensure that your GraphQL schema adheres to specific naming conventions set by your team. It enforces standards such as requiring DateTime fields to end with 'At', ensuring that fields are camelCase, types are PascalCase, and enum values are UPPER_SNAKE_CASE. This tool is highly configurable, allowing you to set up your own rules to meet your team's needs. Built to integrate seamlessly into deploy pipelines, it's an essential tool for maintaining consistency and quality in your GraphQL schemas.

Installation

Install GraphQL Exemplar using npm by running the following command in your terminal:

npm install graphql-exemplar

This command installs GraphQL Exemplar and adds a binary executable graphql-exemplar to your project, which you can easily configure to run as part of your deployment pipelines.

Usage

After installation, add the following script to your package.json to integrate GraphQL Exemplar into your npm scripts:

"scripts": {
  "graphql:ci": "graphql-exemplar"
}

You can run GraphQL Exemplar directly from your command line using:

npm run graphql:ci

Command Line Arguments

graphql-exemplar accepts the following arguments:

• --schema: Path to your GraphQL schema file. Default: schema.graphql
• --rules: Path to your rules file in YAML format. Default: exemplar.yml
• --printer: Output format (simple, grouped, summary).

Configuration

Set up and customize your rules according to your project's needs. Here's the default configuration file that's loaded in.

rules:
  naming:
    - pattern: "^.+At$"
      message: "`At` suffix should be for types: DateTime"
      allowedTypes: ["DateTime"]
    - pattern: "^.+On$"
      message: "`On` suffix should be for types: Date"
      allowedTypes: ["Date"]
  typing:
    DateTime: "^.+At$"
    LocalDateTime: "^.+At$"
    Date: "^.+On$"
    Weekday: "^.+On$"
    Boolean: "^(is|has|can|should).+$"
    ID: "^(.+Id|id)$"
  casing:
    type: "PascalCase"
    field: "camelCase"
    enum: "UPPER_SNAKE_CASE"
  plural: "^.+s$"
  documentation:
    nullable: false
    nonNullable: true

Adjust the rules as necessary to match the specific conventions of your project. You can do this by creating your own configuration file while will extend/override above configuration.

Contributing

Contributions to GraphQL Exemplar are welcome! If you have suggestions for improvements or encounter any issues, please feel free to open an issue or submit a pull request.

License

Distributed under the MIT License. See LICENSE for more information.