Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(gatsby-plugin-mdx): timeToRead returns NaN when word count is undefined #30489

Merged
merged 1 commit into from Mar 26, 2021
Merged

fix(gatsby-plugin-mdx): timeToRead returns NaN when word count is undefined #30489

merged 1 commit into from Mar 26, 2021

Conversation

JobenM
Copy link
Contributor

@JobenM JobenM commented Mar 26, 2021 •
edited

Description

It's possible to have an mdx components without words for example we sometimes have embedded videos/ youtube.

So in this use case the getCounts function returns words property of undefined because the AST visitor never hits a word/paragraph. Thus the calculation for timeToRead (Math.round(words / avgWPM)) returns NaN.

I propose we fallback to 0 for these properties returned in getCounts and then timeToRead can default to 1.

Related Issue

#30490

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Mar 26, 2021
@JobenM JobenM mentioned this pull request Mar 26, 2021
Closed
@vladar vladar added topic: MDX and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Mar 26, 2021
vladar
vladar approved these changes Mar 26, 2021
View reviewed changes
Copy link
Contributor

@vladar vladar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a pretty safe change 👍 Thank you!

@vladar vladar merged commit 75e234a into gatsbyjs:master Mar 26, 2021
@vladar vladar added this to To cherry-pick in Release candidate via automation Mar 26, 2021
@vladar
Copy link
Contributor

vladar commented Mar 26, 2021

Will be published in gatsby-plugin-mdx@2.2.0 next Tuesday.

@JobenM
Copy link
Contributor Author

JobenM commented Mar 27, 2021

Will be published in gatsby-plugin-mdx@2.2.0 next Tuesday.

Great news. Thanks @vladar

@axe312ger
Copy link
Collaborator

Thank you!

@vladar vladar mentioned this pull request Mar 30, 2021
Merged
vladar pushed a commit that referenced this pull request Mar 30, 2021
@JobenM @vladar
fix(gatsby-plugin-mdx): timeToRead returns NaN when word count is 0 (#…
ec6f986 
…30489)

(cherry picked from commit 75e234a)
@vladar vladar moved this from To cherry-pick to Backport PR opened in Release candidate Mar 30, 2021
vladar added a commit that referenced this pull request Mar 30, 2021
@vladar @JobenM
fix(gatsby-plugin-mdx): timeToRead returns NaN when word count is 0 (#…
21804e3 
…30489) (#30563)

(cherry picked from commit 75e234a)

Co-authored-by: Joe Milne <joekmilne@gmail.com>
@vladar vladar moved this from Backport PR opened to Backported in Release candidate Mar 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vladar vladar vladar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
No open projects
Release candidate
Backported
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JobenM @vladar @axe312ger