Switch to TypeScript

[ibc]

Details

• Switch to TypeScript (no need for @types/sdp-transform anymore, which BTW has lot of incorrect and missing type definitions).
  • The src/ folder contains TypeScript code.
  • The lib/ folder contains transpiled JavaScript code. lib/ folder is git ignored, however when publishing the NPM package, only lib/ folder is included into it.
  • Tests are moved to src/test (but they are not included in the NPM package when publishing).
• Modernize everything:
  • Use latest ESlint version.
  • Use Prettier.
  • Update all deps.
  • Use jest and ts-jest for tests instead of bandaje which is literally 10 years old and of course it's not TypeScript compatile.
• Add TypeDoc to generate the website with full API documentation. I attach below a preview gif.
  • The website is compiled when pushing to master branch and the resulting HTML site is available at https://clux.github.io/sdp-transform.
  • Well, not exactly, GH pages must be activated in sdp-transform Settings.
  • Check how I do it in my project rtp.js => API website: https://versatica.github.io/rtp.js/
• Simplify the README file so all the documentation is written in place within the source code above publicly exported functions and TypeScript types.

TypeDoc API documentation website (preview)

[ibc]

@clux, friendly ping.