[docs] Include default values in IntelliSense

[eps1lon]

Not so sure about this one. I think @default is fundamentally flawed when spreading props. ButtonBase having type="button" is not the same as Button documenting this as a default value. This is only noticeable for custom variants at the moment though.

The default values (for documented props in e.g. https://material-ui.com/api/chip/#props) are now part of IntelliSense.

We verify that actual default values are kept in sync with default values from the @default annotation in yarn docs:api. This fails if:

• there is a documented default value but no @default annotation

  JSDOC @default annotation not found for '${propName}'.

• there is a documented default value but the @default annotation does not match

  Expected JSDOC @default annotation for prop '${propName}' of "${jsdocDefaultValue.value}" to equal runtime default value of "${defaultValue?.value}"

• there is a @default annotation but no default value at runtime

  Declared a @default annotation in JSDOC for prop '${propName}' but could not find a default value in the implementation.

  This ensures that IntelliSense displays the same as the docs. One could argue that we have more space in IntelliSense and could therefore document more default values. We can follow-up on this with concrete use cases.

[mui-pr-bot]

@material-ui/lab: parsed: +0.12% , gzip: +0.17%

Details of bundle changes

Generated by 🚫 dangerJS against 50d155b

[oliviertassinari]

Nice!