Skip to content

Conversation

@ibc
Copy link
Collaborator

@ibc ibc commented Oct 27, 2025

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.
  • 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)

Zight Recording 2025-10-29 at 04 37 23 PM

@ibc ibc marked this pull request as ready for review October 29, 2025 15:38
@ibc ibc requested a review from clux October 29, 2025 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants