test: component description conformance test#400
Conversation
levithomason
requested review from
dvdzkwsk,
kuzhelov,
miroslavstastny and
mnajdova
as code owners
levithomason
force-pushed
the
test/component-descriptions
branch
2 times, most recently
from
abb8135 to
25b312d
Compare
levithomason
changed the title
levithomason
added
good first issue
package.json
Outdated
There was a problem hiding this comment.
This change was required to run jest's watch and gulp's doc watch commands in parallel. The watchers never exit so they cannot be started in series.
levithomason
force-pushed
the
test/component-descriptions
branch
from
547947f to
1d5b3e8
Compare
Codecov Report
@@ Coverage Diff @@
## master #400 +/- ##
=======================================
Coverage 91.76% 91.76%
=======================================
Files 41 41
Lines 1324 1324
Branches 168 168
=======================================
Hits 1215 1215
Misses 105 105
Partials 4 4
Continue to review full report at Codecov.
|
miroslavstastny
left a comment
miroslavstastny
left a comment
There was a problem hiding this comment.
Review+ on the changes, but I am not approving as I made changes as well.
| } | ||
|
|
||
| /** | ||
| * A single radio with a radio group. |
There was a problem hiding this comment.
'A single radio within a radio group.' might be better description
mnajdova
left a comment
mnajdova
left a comment
There was a problem hiding this comment.
Approved with one suggestion for consideration in the RadioGroupItem's description.
5 participants
This PR adds a failing conformance test for missing component descriptions. It also attempts to add some heuristics around detecting an unhelpful component description.
Workflow changes
Watch and rebuild component info JSON files during tests. This enables changes to doc info, like descriptions, to be picked up and tested between tests. Specifically, conformance tests can now be run in watch mode and successfully pick up on changes to documentation concerns.
Tests added