Feedback for “config field”

[machineghost]

This page tells you how to use it ... but doesn't explain what it is.

It's referenced on https://the-guild.dev/graphql/codegen/docs/config-reference/codegen-config, but all I can grok is that it's a way to set plugin options. However, the core codegen-config isn't a plugin (and it has its own way of specifying options ... which includes config), so it's confusing why it has a config property (to configure itself as a plugin?) ... and this page explains nothing.

[eddeee888]

Hi @machineghost ,

Thank you for your feedback!

If I understand correctly, you are talking about this config field page.

codegen-config isn't a plugin (and it has its own way of specifying options ... which includes config), so it's confusing why it has a config property

This is what we call the "Root level" config. Whatever value provided to this level is applied to all plugins in generates blocks below.

For example, the following setup are the same

// Setup 1
const config: CodegenConfig = {
  // ... other options
  config: {
    namingConvention: 'change-case-all#lowerCase'
  }
  generates: {
    'src/type1.ts': {
      plugins: ['typescript']
    },
    'src/type2ts': {
      plugins: ['typescript']
    }
  }
}

// Setup 2
const config: CodegenConfig = {
  // ... other options
  generates: {
    'src/type1.ts': {
      plugins: ['typescript'],
      config: {
        namingConvention: 'change-case-all#lowerCase'
      }
    },
    'src/type2ts': {
      plugins: ['typescript'],
      config: {
        namingConvention: 'change-case-all#lowerCase'
      }
    }
  }
}

---

Hope that helps! Happy to clarify if anything's not clear.

Side note: if you had to update this page, how would you word it?

[machineghost]

Side note: if you had to update this page, how would you word it?

It currently says:

config - Options we would like to provide to the specified plugins. The options may vary depending on what plugins you specified. Read the documentation of that specific plugin for more information. You can read more about passing configuration to plugins here

I would suggest adding what you wrote, more or less:

config - Options we would like to provide to the specified plugins. When used at the "Root level", whatever value is provided is applied to all plugins in "generates" blocks below. If it is instead used inside a plugin's configuration, it applies only to that plugin. Either way, the options may vary depending on what plugins you specified.

Read the documentation of that specific plugin for more information. You can read more about passing configuration to plugins here

[R4F44L]

@eddeee888 Hi, might be not exactyly perfect topic to ask this question, but using the "plugin" config and customFetch property doesn't work for me. Is the config for plugins accepting all "root" config options?

For example:

  //works but for all plugins
  customFetch: myCustomFetchas as any,
  generates: {
    "test1": {
      config: {
        // does not work
        customFetch: myCustomFetchas as any,
      }
      // doesn't work
      customFetch: myCustomFetchas as any,
    }
}
}```

I'd like to have per plugin setup with this