devServerPublicPathRoute omitted from ConfigOptions

[trbagley-gresham]

Current behavior

When setting devServerPublicPathRoute in defineConfig, TypeScript complains that the property isn't valid despite it being documented.

Desired behavior

TypeScript should accept devServerPublicPathRoute as a valid property of component in defineConfig.

Test code to reproduce

Set devServerPublicPathRoute in cypress.config.ts:

export default defineConfig({
  component: {
    devServer: {
      framework: 'react',
      bundler: 'vite'
    }
  },
  devServerPublicPathRoute: '',
});

Cypress Version

13.11.0

Node version

20.11.1

Operating System

macOS 14.5

Debug Logs

No response

Other

No response

[AtofStryker]

Hi @trbagley-gresham. Thank you for opening an issue. I think this may have been oversight on my end when publicly exposing the option since right now its configured to be an internal option https://github.com/cypress-io/cypress/blob/develop/packages/config/src/options.ts#L530

[jennifer-shehane]

@AtofStryker Shouldn't this be within the component object of the config? The example shows it as being set outside of the component object.

[trbagley-gresham]

@jennifer-shehane That's correct, my mistake, although the same happens when devServerPublicPathRoute is placed within the component object. TypeScript tsc doesn't appear to report any issues though.

[cypress-app-bot]

This issue has not had any activity in 180 days. Cypress evolves quickly and the reported behavior should be tested on the latest version of Cypress to verify the behavior is still occurring. It will be closed in 14 days if no updates are provided.