Allow Hashtags in Timeline Titles, Sections, and Events #5399
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
1. Updated the regex for title, section, and event elements to allow hashtags. 2. Period elements remain unchanged. Changes to timeline.spec.js 1. Added test coverage to ensure that the title, section, and event elements allow hashtags without error.
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
FutzMonitor
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5399 +/- ##
=======================================
Coverage 5.74% 5.74%
=======================================
Files 277 276 -1
Lines 41899 41888 -11
Branches 489 514 +25
=======================================
Hits 2407 2407
+ Misses 39492 39481 -11
Flags with carried forward coverage won't be shown. Click here to find out more. |
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.
📑 Summary
This pull request removes the hashtag from the title, section, and event regex so that hashtags can be used in their text content. The period element were not included because of an inconsistency. Whereas you can put a hashtag anywhere in the string for a title, section, and event, the period element begins a line and thus is counted as comment.
These changes were made to allow for hashtags in the timeline diagram and to address the inconsistency between percent comments and hashtag comments. This way functionality isn't outright broken with a new comment notation
##versus#.Resolves #5356 .
📏 Design Decisions
I simply removed the hashtag symbol from the exclusion clause regex for the title, section, and event. I made sure to add test coverage to the timeline test suite and run
pnpm testto ensure that it was still working.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch