dangerouslySkipConventions

[brillout]

Description

// vike.config.js

export default {
  dangerouslySkipConventions: {
    // Allow any NODE_ENV value
    nodeEnv: true,
    // Allow any path aliases, e.g. path aliases that cannot be disambiguated from npm package names 
    pathAlias: true
  }
}

This new config turns errors into warnings, unblocking users that cannot respect conventions.

With the upcoming onLog() hook you'll then also be able to suppress the warning.

Vike could accept a value 'suppress-warning' (e.g. dangerouslySkipConventions.nodeEnv === 'suppress-warning') for an easier DX, but we purposely make it tedious to deviate from conventions in order to encourage users to respect them.

Edit: dangerouslySkipConventions.nodeEnv will probably not be needed after #1528 is implemented.

See also

• New setting to avoid the passToClient error #1776
• Show warning when the user sets path aliases that look like npm package imports #1567