CLI TypeScript migration (re)

[Harjun751]

What is the purpose of this pull request?

• Documentation update
• Bug fix
• Feature addition or enhancement
• Code maintenance
• DevOps
• Improve developer experience
• Others, please explain:

Overview of changes:
Bear with me

Partially completes #2754

• Migrate functional code in CLI package to typescript

  • index.js and all util files converted to typescript
  • live-server patch is still JavaScript - added type definitions for now.
  • Test files migrated to typescript
  • Add typescript configs in the cli package - generated files go to cli/dist/

• Package changes

  • Modified cli/package.json to properly prepare and publish the markbind-cli package.
  • Modified root package.json to use the built CLI module in cli/dist/
  • Updated selected packages to get built-in type definitions
  • Installed some type definitions

• Developer-facing changes

  • Added a build/dev script in cli/package.json
  • Updated root build/dev scripts to utilize Project References (running the build/dev scripts are functionally the same as a developer)
  • Added tsx as a dev dependency - run TypeScript files directly using the bundled runner
  • Update dev docs on modified setup instructions & on how to use tsx to directly run files

Anything you'd like to highlight/discuss:
The migrated code is TypeScript, but it's not good TypeScript. There's liberal use of any, so it could definitely be improved. I think we could do refactoring as a separate PR, as I didn't want to clutter this PR any further. LMK, though.

Suggested things to refactor:

1. Refactor core Site constructor. The CLI was using the constructor without properly specifying all the arguments - create an overloaded constructor for this?

2. TypeScript 4.4 set the error type of catch variable to unknown. This means that to extract the error message, type narrowing was required. This introduces an extra branch and decision - what to log when the type of error is unknown? Currently, it simply logs "unknown error". Suggest: extract a variable/function that can be re-used in these cases, instead of hard-coding a message.

3. Create an interface/type that can be used for the option parameter of the commander package callbacks

4. Generally improve logger re-use in the cmd/ files - a lot of code duplication.

5. Create an interface/type that can be used for the ServerConfig object in serve.ts

6. Decrease the high level of coupling between the CLI and Core package

I chose tsx over ts-node since tsx seems more actively-maintained (the last release for ts-node was 3 years ago). Furthermore, tsx seems generally faster, and I had a good experience using tsx with Webstorm with zero configuration or issues. If there's another option worth considering, feel free to raise it up.

In terms of documentation, I did not add an entry on how to configure VSCode with tsx to run TypeScript code directly with, as I don't use VSC. If you think it's valuable, please do add it in!

Testing instructions:

Above running normal tests, you can check if your IDE/setup can correctly run individual test cases/suites in the cli/test/unit directory, since they use TypeScript now.

Proposed commit message: (wrap lines at 72 characters)

Migrate functional code in CLI package to TypeScript

---

Checklist: ☑️

• Updated the documentation for feature additions and enhancements
• Added tests for bug fixes or features
• Linked all related issues
• No unrelated changes

---

Reviewer checklist:

Indicate the SEMVER impact of the PR:

• Major (when you make incompatible API changes)
• Minor (when you add functionality in a backward compatible manner)
• Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

• To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

• what was the old feature that was made obsolete
• any replacement feature (if any), and
• how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

[codecov]

Codecov Report

❌ Patch coverage is 92.50000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.20%. Comparing base (2f6cb37) to head (df2ce3f).

Files with missing lines	Patch %	Lines
packages/cli/src/util/cliUtil.ts	91.66%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2830      +/-   ##
==========================================
- Coverage   72.20%   72.20%   -0.01%     
==========================================
  Files         134      134              
  Lines        7454     7461       +7     
  Branches     1528     1566      +38     
==========================================
+ Hits         5382     5387       +5     
- Misses       2026     2028       +2     
  Partials       46       46              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[gerteck]

LGTM, good job on this

Note to self:

• --build for tsc is for project references, which builds each package in dependency order.

Other stuff

1. CLI snapshot test fails on my local after checking out to this branch. (EDIT: Due to .DS_Store due to dev on MacOS, unrelated to this PR. Tests pass on CI.)

2. I got a permission denied as in, had to run chmod to add execute perms. i wonder if it is just a local dev env thing? Have not faced this before.
   Generated js file does not have executable flag enabled.

Edit: The markbind CLI command fails with "permission denied" because the generated packages/cli/dist/index.js
file loses its executable flag during the build process. tsc does not preserve permissions from source files.