Remove short circuit preventing 'Failed to find any GraphQL type definitions' error from appearing #7407

person1123 · 2025-08-20T19:12:50Z

Description

If you have a pointer that doesn't match any files containing graphql, loadFile should result in an error reporting that no graphql type definitions were identified. However, right now, if there is exactly one error produced by the loader, the meaningful error, the fact that no type definitions were identified, will be hidden. This can be very confusing if there error produced by the loader happens to be unrelated.

An easy reproduction, using graphql-codegen:

/src
  Test.vue

<script setup lang="ts">
import {Props} from 'props.ts';

defineProps<Props>();
</script>

  gqlType.ts

  import { graphql } from '@generated/graphql';

  const MY_FRAGMENT = graphql(`
    fragment MyFragment on SomeType {
      id
    }
  `);

/codegen
  /index.ts

import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
  schema: './codegen/schema.config.ts',
  documents: ['src/**/*.vue', 'src/**/*.ts'],
  generates: {
    './generated/graphql/': {
      preset: 'client',
      config: {
        useTypeImports: true,
      },
    },
  },
};

export default config;

package.json

{
  "name": "test",
  "version": "1.0.0",
  "scripts": {
    "build:graphql-codegen": "graphql-codegen -c codegen/index.ts",
   },
  "dependencies": {
    "vue": "3.5.18",
    "graphql": "16.6.0",
  },
  "devDependencies": {
    "@graphql-codegen/cli": "3.3.0",
    "@graphql-codegen/client-preset": "3.0.1",
  }
}

If you run npm run build:graphql-codegen, the reason codegen fails is because there are no graphql type definitions for any file matched by the .vue file matcher. However, the only error it will report is this:

[@vue/compiler-sfc] No fs option provided to `compileScript` in non-Node environment. File system access is required for resolving imported types.

This error is preventing the file Test.vue from being parsed, but it's not why graphql codegen in general is failing. If you were to add another vue file with a graphql type definition in it, that file would parse correctly and graphql-codegen would succeed. If you want graphql-codegen to work on the current project setup, you can remove the .vue file matcher from codegen/index.ts.

This change results in the following output instead:

 ✖ Failed to find any GraphQL type definitions in: src/**/*.vue;
      - [@vue/compiler-sfc] No fs option provided to `compileScript` in non-Node environment. File system access is required for resolving imported types.

I think this is much clearer.

Related # (issue)
#7406

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as
expected)
This change requires a documentation update

How Has This Been Tested?

Before, running graphql-codegen on a project with a matcher that results in no graphql type definitions and one parsing error:

✔ Parse Configuration
⚠ Generate outputs
  ❯ Generate to ./generated/graphql/
    ✔ Load GraphQL schemas
    ✖ [@vue/compiler-sfc] No fs option provided to `compileScript` in non-Node environment. File system access is required for resolving imported types.
      anonymous.vue
      22 |  import type { SpacePublicationFragment } from '@generated/graphql/graphql';
      23 |
      24 |  const props = defineProps<Props>();
      |                            ^^^^^
      25 |  const instance = getCurrentInstance();
      26 |
    ◼ Generate

After, running graphql-codegenon a project with a matcher that results in no graphql type definitions and one parsing error:

✔ Parse Configuration
⚠ Generate outputs
  ❯ Generate to ./generated/graphql/
    ✔ Load GraphQL schemas
    ✖ Failed to find any GraphQL type definitions in: src/**/*.vue;
      - [@vue/compiler-sfc] No fs option provided to `compileScript` in non-Node environment. File system access is required for resolving imported types.
      anonymous.vue
      22 |  import type { SpacePublicationFragment } from '@generated/graphql/graphql';
      23 |
      24 |  const props = defineProps<Props>();
      |                            ^^^^^
      25 |  const instance = getCurrentInstance();
      26 |
    ◼ Generate

Test Environment:

OS: MacOS 14.5
@graphql-tools/load: 8.0.0
NodeJS: v17.9.1