eslint-plugin-dprint

@ben_12/dprint/graphql

Format code with dprint.

Rule Details

Run dprint to format code.

Options

{
  "@ben_12/dprint/graphql": [
    "error",
    {
      // Use dprint JSON configuration file (default: "dprint.json")
      // It may be created using `dprint init` command
      // See also https://dprint.dev/config/
      "configFile": "dprint.json",
      "config": {
        // The graphql configuration of dprint
        // See also https://dprint.dev/plugins/pretty_graphql/config/
      },
    },
  ],
}

Pre-resolved formatter

The plugin can also be given a pre-resolved dprint formatter via ESLint’s settings. The dprint-plugin-graphql package ships only plugin.wasm with no JS entrypoint, so the formatter has to be built from the wasm file directly. See the main README for the full explanation and the other accepted shapes. Minimal example for this rule:

import { createFromBuffer } from "@dprint/formatter";
import fs from "node:fs";

const graphqlFormatter = createFromBuffer(
  fs.readFileSync(new URL(import.meta.resolve("dprint-plugin-graphql/plugin.wasm"))),
);

export default [{
  settings: {
    "@ben_12/dprint": {
      formatters: { graphql: graphqlFormatter },
    },
  },
  rules: {
    "@ben_12/dprint/graphql": ["error", { config: { /* dprint config */ } }],
  },
}];

This site is open source. Improve this page.