Descriptions are not generated in the form of comments

[nandita1]

When we add the schema as a *.graphql file, descriptions of fields inside the schema file do not get added as JSDOC comments in the generated types file but they do get generate if the schema is a *.json file.
With *.graphql schema file:


With *.json schema file:

The codegen file:

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

const config: CodegenConfig = {
  schema: 'src/gql/schema.json',
  documents: [
    'src/**/*.tsx',
    'src/**/*.graphql',
    '!src/**/__tests__/*',
    '!src/**/*.spec.tsx',
    '!src/generated/**/*',
  ],
  generates: {
    './src/types-v3.ts': {
      plugins: [
        {
          add: {
            content: `
          /** THIS FILE IS AUTO-GENERATED **/
          /** DO NOT EDIT **/
          /* eslint-disable */
          /* tslint:disable */
          `,
          },
        },
        'typescript',
        'typescript-operations',
      ],
      config: {
        namingConvention: 'keep',
        avoidOptionals: {
          field: true,
        },
        scalars: {
          Long: 'number',
          UUID: 'string',
          DateTime: 'string',
          LocalTime: 'string',
          Duration: 'string',
          Void: 'void',
          URL: 'URL',
        },
        nonOptionalTypename: true,
        skipTypeNameForRoot: true,
        immutableTypes: true,
        declarationKind: 'interface',
        dedupeOperationSuffix: true,
        onlyOperationTypes: true,
      },
    },
  },
};

export default config;

[charlypoly]

We got a similar bug report (#8327), I will try to reproduce it and provide a patch.

[charlypoly]

Hi @nandita1,

Fields and scalars comments (called "descriptions" in GraphQL) should use the following syntax:

"Link"
scalar URL

type Query {
    "Get a user"
    user(id: ID!): User!
}

type User {
    id: ID!
    "a username is unique"
    username: String
    email: String!
}

[charlypoly]

For more information, please refer to the following answer: #8327 (comment)