Automatic typescript checking of code in documentation #7448
Labels
Component: Documentation
Issue or pull request is related to Documentation
Status: Needs Triage
Issue will be reviewed by Core Team and a relevant label will be added as soon as possible
Describe the bug
I already brought this up a while ago, that an (semi)-automated checking of the typescript code in the documentation is feasible.
Before working on this, I just wanted to ask how you would prefer a pull request? One big PR with everything? One PR per component? One PR per problem type? Easiest for me is probably one per component.
There are various kinds of errors that can be found. The most common ones are type error and import issues:
Type errors like:
tab.disabled
does not exist on the entries of thetabs
array.primereact/components/doc/accordion/dynamicdoc.js
Lines 7 to 25 in 54acecd
loading
refers to a value, but is being used as a type hereprimereact/components/doc/treetable/lazyloaddoc.js
Line 216 in 54acecd
Import issues like:
primereact/components/doc/captcha/captchadoc.js
Line 41 in 54acecd
primereact/components/doc/accordion/templatedoc.js
Lines 64 to 65 in 54acecd
In the long run it might make sense to store the code examples in the docs as separate files (that can be type checked & linted more easily) instead of storing the code in strings.
Reproducer
No response
System Information
Steps to reproduce the behavior
No response
Expected behavior
No response
The text was updated successfully, but these errors were encountered: