TS code examples

[sequba]

Context

• convert all JS examples to TS by hand
  • accessibility/
  • cell-features/
  • cell-types/
  • formulas/
  • navigation/
  • rows/
  • tools-and-building/
  • accessories-and-menus/
  • cell-functions/
  • columns/
  • getting-started/
  • internationalization/
  • optimization/
  • security/
  • technical-specification/
  • upgrade-and-migration/
• create a script that
  • compiles all TS examples files to JS (tsc)
  • formats them to be more human-readable (eslint)
• run the script during the docs build

There are 192 js files in the docs/content/guides dir:

$ find docs/content/guides -name "*.js" | wc
    192     192   13076

How has this been tested?

This has been tested locally plus using visual tests for regression checking

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature or improvement (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Additional language file or change to the existing one (translations)

Related issue(s):

1. https://github.com/handsontable/dev-handsontable/issues/1867

Affected project(s):

• handsontable
• @handsontable/angular
• @handsontable/react
• @handsontable/vue
• @handsontable/vue3

Checklist:

• I have reviewed the guidelines about Contributing to Handsontable and I confirm that my code follows the code style of this project.
• I have signed the Contributor License Agreement
• My change requires a change to the documentation.

[skip changelog]

[github-actions]

Launch the local version of documentation by running:

npm run docs:review fdf2eb9e6cbad6a13ca28529a634f925a6746a07

[evanSe]

In general everything looks good, a few improvements I would create.

• generate multiple examples files at once (currently it takes along time)
• do have generation as part of start script if its so slow.

If speeding up the script takes more than an hour I wouldn't bother with it

[evanSe]

Also its worth rebasing this branch, it has 165 commits currently.

[sequba]

Rebased. @evanSe please re-review.

[magierg]

@sequba There is a problem when running npm run docs:start as TS -> JS conversion not being triggered

[sequba]

@evanSe wrote here:

do have generation as part of start script if its so slow.

@magierg wrote here:

There is a problem when running npm run docs:start as TS -> JS conversion not being triggered

Currently, npm run docs:start doesn't run the generate-js-examples script, but it could be added there. Personally, I prefer the start script to be fast, as we use it frequently during development. @evanSe, please make a decision about it.