[code-infra] The parser of the describe conformance consider `skip` but not `only` config
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Found while reviewing https://github.com/mui/mui-x/pull/13647/
If you use the describeConformance(..., () => ({ only: ['themeDefaultProps'})), all the attributes will be added to the API page instead of just the theme dfault props one.
THe reason is that the script filter the skipped test but do not take into consideration the only:
Solution can either be to remove only from describe conformance, or take only into consideration in the parsing
Search keywords:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in packages/api-docs-builder/utils/parseTest.ts around lines 164-185 and reproduce the describeConformance case using only: ['themeDefaultProps']. Trace how skip and only are handled. Done means the generated API page includes only the selected attribute rather than all attributes; verify the behavior with the parser's existing tests if available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100