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

Switch from SyntaxHighlighter to Prism for syntax highlighting #7122

Merged

Conversation

david-yz-liu
Copy link
Collaborator

@david-yz-liu david-yz-liu commented Jun 17, 2024

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

Our current syntax highlighting library, SyntaxHighlighter, is no longer maintained. This pull request switches to using the more modern Prism. This resolves #6140. Note that while there are React-based libraries for syntax highlighting built on top of Prism (and other libraries like highlight.js), because our approach to annotations involves manual DOM manipulation, I chose to make manual use of Prism. This could be changed in the future.

Switching libraries has resulted in the following improvements:

Screenshots of your changes (if applicable)

image

Associated [documentation repository](https://github.com/MarkUsProject/Wiki) pull request (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue) X
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency) X
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@david-yz-liu david-yz-liu force-pushed the prism-syntax-highlighting branch 2 times, most recently from a378799 to cdab0a9 Compare June 17, 2024 03:01
@coveralls
Copy link
Collaborator

coveralls commented Jun 17, 2024

Pull Request Test Coverage Report for Build 9541276762

Details

  • 3 of 53 (5.66%) changed or added relevant lines in 2 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.1%) to 91.29%

Changes Missing Coverage Covered Lines Changed/Added Lines %
app/assets/javascripts/Components/Result/text_viewer.jsx 2 52 3.85%
Files with Coverage Reduction New Missed Lines %
app/assets/javascripts/Components/Result/text_viewer.jsx 1 18.66%
Totals Coverage Status
Change from base Build 9528555904: -0.1%
Covered Lines: 40054
Relevant Lines: 43190

💛 - Coveralls

@david-yz-liu david-yz-liu force-pushed the prism-syntax-highlighting branch from cdab0a9 to 933e6e9 Compare June 29, 2024 20:57
@coveralls
Copy link
Collaborator

coveralls commented Jun 29, 2024

Pull Request Test Coverage Report for Build 9726865504

Details

  • 33 of 53 (62.26%) changed or added relevant lines in 2 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 91.412%

Changes Missing Coverage Covered Lines Changed/Added Lines %
app/assets/javascripts/Components/Result/text_viewer.jsx 32 52 61.54%
Files with Coverage Reduction New Missed Lines %
app/assets/javascripts/Components/Result/text_viewer.jsx 1 55.97%
Totals Coverage Status
Change from base Build 9719714420: 0.02%
Covered Lines: 40143
Relevant Lines: 43241

💛 - Coveralls

@david-yz-liu david-yz-liu merged commit e3406c7 into MarkUsProject:master Jun 29, 2024
6 checks passed
@david-yz-liu david-yz-liu deleted the prism-syntax-highlighting branch June 29, 2024 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants