Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Making it possible to require all of the given field names on require-id-when-available #1075

Open
ikesyo opened this issue May 24, 2022 · 5 comments
Assignees
Labels
process/candidate Candidate for next Milestone.

Comments

@ikesyo
Copy link

ikesyo commented May 24, 2022

Is your feature request related to a problem? Please describe.
When using the require-id-when-available rule with passing an array of field names, the rule passes if one of the field names exists in the selection set. I want that all of them should exist in the selection set (all given fields are required if the fields are defined on a type).

Describe the solution you'd like

Add configuration option which treating the given fields as all required.

Describe alternatives you've considered

Additional context

Migration from apollographql/eslint-plugin-graphql's required-fields rule (migration to graphql-eslint is suggested in the README). That rule's behavior is desirable for us.

@dimaMachina dimaMachina added the process/candidate Candidate for next Milestone. label Jun 2, 2022
@milashkaJason
Copy link

Not working with error Rule require-id-when-availablerequiresparserOptions.operations, my config {
"files": [".ts"],
"processor": "@graphql-eslint/graphql"
},
{
"files": ["
.graphql"],
"extends": "plugin:@graphql-eslint/operations-recommended",
"rules": {
"@graphql-eslint/known-type-names": "error"
},
"parserOptions": {
"operations": "./src/**/*.graphql"
],
"schema": "./remote-schema.graphql"
}
}`

@dimaMachina
Copy link
Owner

Hi @milashkaJason, does your issue related to require-id-when-available? Can you give more context or maybe make a reproduction repo?

@francois-spectre
Copy link

I got the same issue and I finally get it work by disabling the rules

'@graphql-eslint/require-id-when-available': 'off',
'@graphql-eslint/no-unused-fragments': 'off',

@milashkaJason
Copy link

The problem was in the parameter parserOptions: {
operations}, because it interfered .graphqlconfig

@TuvalSimha TuvalSimha self-assigned this Aug 15, 2022
@alexeyr-ci
Copy link

alexeyr-ci commented Jan 5, 2024

I'm posting the reproduction here instead of reopening #1159. To reproduce, go to the playground and enter in operation.graphql:

# eslint @graphql-eslint/require-id-when-available: ["error", { fieldName: ["id", "__typename"] }]
query Q {
  posts {
    id
    title
  }
}

Or ["id", "createdAt"]. The code should be invalid, since only id is included in the selection and __typename/createdAt isn't.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process/candidate Candidate for next Milestone.
Projects
None yet
Development

No branches or pull requests

6 participants