GraphQL config not recognized by graphql-eslint

[FloEdelmann]

I started migrating to graphql-eslint v4 now. My minimal ESLint configuration (.eslintrc.js) looks like this:

module.exports = {
    root: true,
    overrides: [
        {
            files: '**/*.graphql',
            extends: 'plugin:@graphql-eslint/operations-recommended',
        },
    ],
}

There is a graphql.config.ts file in the same folder. The GraphQL files are located in subdirectories. Linting yields this error:

Error while loading rule '@graphql-eslint/no-deprecated': Rule `no-deprecated` requires graphql-config `schema` field to be set and loaded. See https://the-guild.dev/graphql/eslint/docs/usage#providing-schema for more info

I investigated a bit by adding console.log statements to various functions in graphql-eslint and graphql-config:

• loadOnDiskGraphQLConfig is called with the file path of the GraphQL file in the subdirectory.
• getFirstExistingPath(path.dirname(filePath)) thus returns that subdirectory.
• Since that subdirectory doesn't include the GraphQL config file, loadConfigSync returns undefined.
• If I manually pass the root directory path as rootDir instead, linting works as expected.

So I think that the logic for finding the nearest GraphQL config file is wrong, since it doesn't traverse up the directory tree (until the working directory, or until the directory that the ESLint config file is in), or do I miss something?

Also, the location of the GraphQL config file can't be specified, so there is no way around the issue, right?

[dimaMachina]

Hi, please try to make this test fail https://github.com/dimaMachina/graphql-eslint/blob/d455b5be393fdc4b1afdf83f66c572681036196e/packages/plugin/__tests__/schema.spec.ts#L115

[FloEdelmann]

I tried but couldn't. But thanks for the hint anyway.

In the end I updated the (transitive) graphql-config dependency from 5.1.2 to 5.1.3 and that fixed it 🥳

[FloEdelmann]

The https://github.com/kamilkisiela/graphql-config/releases/tag/v5.1.3 release notes mention only one PR and that fixes the exact issue I had.

[dimaMachina]

seems we need update a range in https://github.com/dimaMachina/graphql-eslint/blob/d455b5be393fdc4b1afdf83f66c572681036196e/packages/plugin/package.json#L53, would you want to submit a PR?

[FloEdelmann]

Ah indeed, that prevents this problem for other users. I created a PR: #2805