-
Notifications
You must be signed in to change notification settings - Fork 55
test: component description conformance test #400
Conversation
abb8135
to
25b312d
Compare
"test:visual": "gulp screener", | ||
"test:projects:cra-ts": "gulp test:projects:cra-ts", | ||
"test:watch": "yarn test --watchAll", | ||
"test:watch": "gulp test:watch", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review+ on the changes, but I am not approving as I made changes as well.
@@ -45,6 +45,7 @@ export interface RadioGroupItemState { | |||
} | |||
|
|||
/** | |||
* A single radio with a radio group. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'A single radio within a radio group.' might be better description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with one suggestion for consideration in the RadioGroupItem's description.
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