dotansimha / dotansimha/graphql-code-generator

`skipDocumentsValidation` is missing in `CodegenConfig`

Open
#9,913 2 comments 5 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
11.3k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
23

Description

### Which packages are impacted by your issue?

@graphql-codegen/cli

### Describe the bug

[The docs clearly state that a `skipDocumentsValidation` attribute](https://the-guild.dev/graphql/codegen/docs/config-reference/codegen-config#configuration-options) should be available in the config but this is not a part of the `CodegenConfig` type and when added this config setting is completely ignored.

### Your Example Website or App

https://codesandbox.io/p/devbox/vibrant-lake-y7dmnw

### Steps to Reproduce the Bug or Issue

1. Go to any `codegen.ts` in your repo using codegen
2. Try to add `skipDocumentsValidation`
3. 💥

### Expected behavior

The `skipDocumentsValidation` to work and ignore certain rules.

### Screenshots or Videos

_No response_

### Platform

- OS: [e.g. macOS, Windows, Linux]
- NodeJS: [e.g. 18.5.0]
- `graphql` version: [e.g. 16.3.0]
- `@graphql-codegen/*` version(s): [e.g. 2.6.2]

### Codegen Config File

```
import { CodegenConfig } from "@graphql-codegen/cli";

const config: CodegenConfig = {
schema: "schema.graphql",
documents: "document.graphql",
skipDocumentsValidation: {
ignoreRules: ["OverlappingFieldsCanBeMergedRule"],
},
generates: {
"types.ts": { plugins: ["typescript", "typescript-operations"] },
},
};

export default config;
```

### Additional context

Being able to do this would fix a lot other issues like #2781

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.