test(theme-common): increase filterDocCardListItems test coverage #9064
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
slorber
requested changes
Jun 14, 2023
Comment on lines
+787
to
+794
| it('includes html items', () => { | ||
| const items = [ | ||
| {type: 'link', href: '/foo/bar', label: 'Foo'}, | ||
| {type: 'link', href: 'bar/foo', label: 'Bar'}, | ||
| {type: 'html', value: 'baz'}, | ||
| ]; | ||
| expect(filterDocCardListItems(items)).toEqual(items); | ||
| }); |
There was a problem hiding this comment.
maybe html items can be included in the first test case? "list of valid items"
Comment on lines
+776
to
+786
| it('filters out unlisted items', () => { | ||
| const items = [ | ||
| {type: 'link', href: '/foo/bar', label: 'Foo'}, | ||
| {type: 'link', href: 'bar/foo', label: 'Bar'}, | ||
| {type: 'link', href: '/foo/unlisted', label: 'Unlisted', unlisted: true}, | ||
| ]; | ||
| expect(filterDocCardListItems(items)).toEqual([ | ||
| {type: 'link', href: '/foo/bar', label: 'Foo'}, | ||
| {type: 'link', href: 'bar/foo', label: 'Bar'}, | ||
| ]); | ||
| }); |
There was a problem hiding this comment.
Maybe add other filtered item types here?
- link with no href
- category with unlisted link
- category with no href
- category having all its direct childs being filtered
slorber
changed the title
slorber
reviewed
Jun 14, 2023
Comment on lines
+768
to
+775
| it('returns original list of valid items', () => { | ||
| const items = [ | ||
| {type: 'link', href: '/foo/bar', label: 'Foo'}, | ||
| {type: 'link', href: 'bar/foo', label: 'Bar'}, | ||
| {type: 'link', href: '/foo/listed', label: 'Listed'}, | ||
| ]; | ||
| expect(filterDocCardListItems(items)).toEqual(items); | ||
| }); |
There was a problem hiding this comment.
maybe add html items here, and also valid categories with valid items as children
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-flight checklist
Motivation
I was getting the repo set up locally and looking at the test infrastructure and noticed some coverage missing for the common theme utils - I chose this package and file pretty arbitrarily just as a starting point to look at the code base. The tests added here are primarily a sanity check to make sure the behavior of this function doesn't drastically change, and it pushes up Jest's coverage for the file.
Test Plan
Test links
Deploy preview: https://deploy-preview-9064--docusaurus-2.netlify.app/
Related issues/PRs