Platform Compatibility

[LyubomirT]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Breaking Change
• Documentation Update

Description

As discussed in #23, I rewrote the code using Node.js and optimized it for all platforms using platform-independent methods built into Node.js. This has no dependencies and requires nothing but node to be installed (I used v20.11.0 for this, but since there is a deprecation issue, rmSync may not work on older versions. But it's easily resolvable). It does pretty much the same as the original .sh file. HOWEVER, I've noticed that the CITATION.cff file doesn't work properly with the placeholder replacement algorithm, due to how {{PROJECT_NAME}} and {{NAME}} placeholders are formatted in it, so I had to fix that as well. (changed the template). Honestly, I'm not very proud of how I wrote this, so any feedback or criticism is much appreciated. I hope this code works for you!

Related Tickets & Documents

• Related Issue Platform compatibility #23
• Closes Platform compatibility #23

Added/updated tests?

• Yes
• No, and this is why: The code itself seems similar to a unit test, so all testing can be done straight from it (but I can implement a separate similar copy as a unit test if needed).
• I need help with writing tests

[optional] Are there any post deployment tasks we need to perform?

Don't think so.

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
  (I trust it should be updated after my code is reviewed)

[caffeine-addictt]

Hey! Amazing work so far.
Just a little maintainability improvements here and there.

[caffeine-addictt]

As for tests, they will be implemented in another PR that closes #26 (currently waiting for this pr)

[caffeine-addictt]

@LyubomirT I can also send a PR over if you need help with it

[LyubomirT]

@LyubomirT I can also send a PR over if you need help with it

No need for that just yet, I'll handle it. Appreciate the feedback nonetheless!

[LyubomirT]

Applied all your requested changes, please review the code again, if possible.

[caffeine-addictt]

LGTM!

[caffeine-addictt]

I'll go ahead and update linting CI before merging

[LyubomirT]

I'll go ahead and update linting CI before merging

Okay! Take your time.

[caffeine-addictt]

I'll go ahead and update linting CI before merging

Okay! Take your time.

Looks like merging into main won't affect the CI here.
Could you merge main into your branch and run npm run lint:fix? (As it seems like prettier doesn't like setup.js)

[LyubomirT]

I'm not sure if I did this correctly, but it seems to have worked. Please check if everything is in order?

[caffeine-addictt]

Yep! No issues with linting anymore. Just some permission issues for my labeler GHaction 🥲

[caffeine-addictt]

Thank you for your contribution!! (●´□`)♡