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.

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

tree shaking highlightjs dependency #1108

Merged
merged 3 commits into from
Nov 4, 2021
Merged

Conversation

stackoverfloweth
Copy link
Contributor

@stackoverfloweth stackoverfloweth commented Nov 3, 2021

PR Checklist:

  • add a short description of what's changed to the top of the CHANGELOG.md
  • add/update tests (or don't, for reasons explained below)

Describe this PR

This package's use of Highlight.js was over double the size of the next biggest dependency. Removing this dependency and the 3 lines from markdownParser I was able to bring down the highlightjs bundle size from 1.3M to 77.5K!

While at first glance, I expected this to have an impact on user experience, I cannot find an instance where this change actually effected what the user sees. I confirmed the "describe" component used in a flow's readme, as well as the artifacts tab of a flow-run. Markdown entry and parsing seems uneffected by this change.

zhen0
zhen0 previously requested changes Nov 3, 2021
Copy link
Member

@zhen0 zhen0 left a comment

Choose a reason for hiding this comment

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

This looks good to me @stackoverfloweth. I also checked tutorials as I believe they also use markdown and looked fine. As she did some work of the initial work on the markdown parser I'd like to have @ThatGalNatalie take a look at this before we merge.

@zhen0 zhen0 dismissed their stale review November 3, 2021 20:15

I did not mean to request changes there!

zhen0
zhen0 previously requested changes Nov 3, 2021
Copy link
Member

@zhen0 zhen0 left a comment

Choose a reason for hiding this comment

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

Oh actually I do have a requested change @stackoverfloweth - can you update the changelog please? (And update to latest master!). Thanks!

@stackoverfloweth stackoverfloweth dismissed zhen0’s stale review November 3, 2021 20:37

suggestion should be addressed

ThatGalNatalie
ThatGalNatalie previously approved these changes Nov 3, 2021
Copy link
Contributor

@ThatGalNatalie ThatGalNatalie left a comment

Choose a reason for hiding this comment

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

looks good to me too

zhen0
zhen0 previously approved these changes Nov 3, 2021
Copy link
Member

@zhen0 zhen0 left a comment

Choose a reason for hiding this comment

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

Also looks good to me @stackoverfloweth - but can you add the latest from master so we can merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants