refactor: improved Typedoc generation with async file handling and better error management

[Ultimecia1463]

Refactored the Typedoc generation script to enhance error handling, improve asynchronous file operations, and optimize JSON parsing for output.

• Implemented fs.promises for asynchronous file reading and writing, improving performance and responsiveness.
• Added error handling with try/catch blocks to gracefully manage failures during Typedoc generation and file operations.
• Reduced redundant calls to process.cwd() for better efficiency and readability.
• Streamlined JSON parsing to avoid unnecessary operations when creating the minified output.

[CLAassistant]

All committers have signed the CLA.

[mikehardy]

interesting! thanks - our docs are in flux right now and have been unpublished for quite some time so I don't have a great way to review this via actually looking at the result but the code changes seem reasonable.

I'm working on getting the docs publishing again and I'll give this a final review then once we can make sure things are still generating fine (they should be - but verifying is vital...)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.08%. Comparing base (ca4572a) to head (a93dc30).
Report is 43 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1112   +/-   ##
=======================================
  Coverage   77.08%   77.08%           
=======================================
  Files          32       32           
  Lines        1727     1727           
  Branches      579      556   -23     
=======================================
  Hits         1331     1331           
- Misses        343      395   +52     
+ Partials       53        1   -52     

[Ultimecia1463]

thanks for you time @mikehardy

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[Ultimecia1463]

@mikehardy

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[mikehardy]

I'm changing all of the docs generation now and hope to do typedocs without javascript, rather just with a config file in the future - this won't remain relevant, sorry