chore: add build step to generate react docgen metadata

[vpicone]

Closes #4635

New:

• BABEL_ENV docgen
  • includes babel-plugin-react-docgen
  • outputs abuild/docgen (not published)
• Use build/docgen to generate a react-docgen.json file (published)

Testing:

• yarn workspace carbon-components-react build
• Should generate a react-docgen.json file with docgen data in the react package.

[netlify]

Deploy preview for the-carbon-components ready!

Built with commit c253887

https://deploy-preview-4662--the-carbon-components.netlify.com

[netlify]

Deploy preview for carbon-components-react ready!

Built with commit c253887

https://deploy-preview-4662--carbon-components-react.netlify.com

[netlify]

Deploy preview for carbon-elements ready!

Built with commit c253887

https://deploy-preview-4662--carbon-elements.netlify.com

[asudoh]

LGTM basically - Would you fix the CI? Thanks @vpicone!

[vpicone]

@asudoh fixed thanks! @jnm2377 @joshblack holler if you have any questions

[emyarod]

looks good to me, docgen directory and react-docgen.json are generated

Use build/docgen to generate a react-docgen.json file (published)

just wondering, does react-docgen.json need to be separate from build/docgen if they're both ignored? or does the json file need to be at the package root?

[vpicone]

@emyarod "publish" here refers to what get's pushed to npm. The build directory is ignored when publishing, the react-docgen.json file is not.

It doesn't need to be at the package root per-se, but it makes it easy to find/import. It's also where we put metadata files historically (icons, pictograms).

[emyarod]

looks good to me, thanks for confirming