[docs] Improved demo transpiling

[merceyz]

• I have followed (at least) the PR section of the contributing guide.

• formattedTSDemos.js

  • Added support for running babel directly from the script, reducing I/O down to one read and write per demo transpiled
  • Added ignore list and babel config
  • Added support for watching for file changes with --watch
  • Added "cache" to skip transpiling if the JavaScript version is newer, can be disabled with --disable-cache
  • Added support for fixBabelGeneratorIssues to detect the line endings used, instead of always using \n, if no line ending is found, it uses the OS default
  • Fixed fixBabelGeneratorIssues not working with \r\n line endings

• package.json

  • Changed yarn docs:typescript to use formattedTSDemos.js in watch mode, this fixes it outputting with incorrect formatting

• circleci

  • Changed to run docs:typescript:formatted with --disable-cache

• Other:

  • Deleted docs/babel.config.ts.js and docs/ts-demo-ignore.json, moved into formattedTSDemos.js, edited CONTRIBUTING.md to reflect this

[mui-pr-bot]

No bundle size changes comparing 6bff226...1b63f39

Generated by 🚫 dangerJS against 1b63f39

[eps1lon]

@merceyz Really dig the new script. Just added some minor tweaks to the code structure.

[merceyz]

Really dig the new script

Makes working with the docs a nicer experience

Just added some minor tweaks to the code structure.

Looks a lot cleaner 👍

[merceyz]

@eps1lon I added "cache" support, so that it wont transpile or hit the drive at all when it doesn't have to (disabled in CI builds).
Running yarn docs:typescript:formatted went from always taking 5+ seconds to ~0,5 seconds, if there is nothing to transpile. If you could do another review that would be great.

[oliviertassinari]

@merceyz 👌. This change can inspire us for a few improvements in the API generation logic, e.g. the caching 👀.

[merceyz]

I have a few more ideas for this, hold off on merging please

[oliviertassinari]

@merceyz It's already a nice improvement. We don't mind two pull requests. Let us know :).

[merceyz]

@oliviertassinari I was trying to make babel automatically generate propTypes from the TypeScript definitions, but the plugin is unable to handle all the cases.

Go ahead and merge, i'll look at it another time.

[eps1lon]

@oliviertassinari I was trying to make babel automatically generate propTypes from the TypeScript definitions, but the plugin is unable to handle all the cases.

Making this work would be amazing. This would require a rewrite of our api parser since we extract prop API docs from the propTypes.

Verifying that propTypes and type definitions match would already be a huge improvement. Those get out of sync pretty easily (seems like we get an issue every 1 or 2 weeks about this).