# graphql-prettier

> Prettify & simplify GraphQL query/mutation/subscription.

Latest version **1.0.6** (published 2019-07-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install graphql-prettier
pnpm add graphql-prettier
yarn add graphql-prettier
bun add graphql-prettier
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-07-04 |
| First published | 2019-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Martin Babinec |
| Maintainers | martinbabinec |
| Keywords | graphql, formatter, prettier |

## Links

- npm: https://www.npmjs.com/package/graphql-prettier
- Repository: https://github.com/Emetrop/graphql-prettier
- Homepage: https://github.com/Emetrop/graphql-prettier#readme
- Issues: https://github.com/Emetrop/graphql-prettier/issues
- npm.io page: https://npm.io/package/graphql-prettier

## Dependencies (1)

- [graphql](https://npm.io/package/graphql.md) ^14.1.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2019-07-04
- 1.0.5 — 2019-03-28
- 1.0.4 — 2019-03-27
- 1.0.3 — 2019-03-25
- 1.0.2 — 2019-03-25
- 1.0.1 — 2019-03-18

## README

# GraphQL Prettier [![Codacy Badge](https://api.codacy.com/project/badge/Grade/2893bfd204af465eb24e27e01efd6be1)](https://www.codacy.com/app/Emetrop/graphql-prettier) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/2893bfd204af465eb24e27e01efd6be1)](https://www.codacy.com/app/Emetrop/graphql-prettier) [![Build Status](https://travis-ci.org/Emetrop/graphql-prettier.svg?branch=master)](https://travis-ci.org/Emetrop/graphql-prettier)

Prettify & simplify GraphQL query/mutation/subscription.

## Description

Package exports a default function which accepts two parameters:

```
prettify(source: string, noDuplicates = true): string
```

`source` is a string with GraphQL query/mutation/subscription to prettify

`noDuplicates` is a boolean value which set up to false turns out function to leaving duplicated fields

## Install

```sh
npm install graphql-prettier
```

## Usage

```js
import gqlPrettier from 'graphql-prettier';

const query = `
query ViewerQuery {
  viewer {
    user {
      id
      name
      ...userFragment
    }
  }
}
fragment userFragment on User {
  id
  name
  email
}
`;

const prettifiedQuery = gqlPrettier(query); // returns string
```

## Example

```
query ViewerQuery {
  viewer {
    user {
      id
      name
      id
      ...userFragment
      name
    }
  }
}
fragment userFragment on User {
  id
  name
  email
  name
}
```

Is transformed to:

```
query ViewerQuery {
  viewer {
    user {
      id
      name
      email
    }
  }
}
```

### License

GraphQL Prettier is [MIT-licensed](https://github.com/Emetrop/graphql-prettier/blob/master/LICENSE).

---
_Source: https://npm.io/package/graphql-prettier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._