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

Allow Semicolons in Timeline Titles, Sections, Periods, and Events #5335

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
8 changes: 4 additions & 4 deletions packages/mermaid/src/diagrams/timeline/parser/timeline.jison
Expand Up @@ -18,19 +18,19 @@
\#[^\n]* /* skip comments */

"timeline" return 'timeline';
"title"\s[^#\n;]+ return 'title';
"title"\s[^#\n]+ return 'title';
accTitle\s*":"\s* { this.begin("acc_title");return 'acc_title'; }
<acc_title>(?!\n|;|#)*[^\n]* { this.popState(); return "acc_title_value"; }
accDescr\s*":"\s* { this.begin("acc_descr");return 'acc_descr'; }
<acc_descr>(?!\n|;|#)*[^\n]* { this.popState(); return "acc_descr_value"; }
accDescr\s*"{"\s* { this.begin("acc_descr_multiline");}
<acc_descr_multiline>[\}] { this.popState(); }
<acc_descr_multiline>[^\}]* return "acc_descr_multiline_value";
"section"\s[^#:\n;]+ return 'section';
"section"\s[^#:\n]+ return 'section';

// event starting with "==>" keyword
":"\s[^#:\n;]+ return 'event';
[^#:\n;]+ return 'period';
":"\s[^#:\n]+ return 'event';
[^#:\n]+ return 'period';


<<EOF>> return 'EOF';
Expand Down
25 changes: 25 additions & 0 deletions packages/mermaid/src/diagrams/timeline/timeline.spec.js
Expand Up @@ -98,5 +98,30 @@ describe('when parsing a timeline ', function () {
}
});
});

it('TL-6 should handle a section, and task and its multi line events with semicolons', function () {
let str = `timeline
section ;a;bc-123;
;ta;sk1;: ;ev;ent1;
;tas;k2;: ;eve;nt2;: ;event;3;
: ;eve;nt4: ;even;t5;
`;
timeline.parse(str);
expect(timelineDB.getSections()[0]).to.deep.equal(';a;bc-123;');
timelineDB.getTasks().forEach((t) => {
switch (t.task.trim()) {
case ';ta;sk1;':
expect(t.events).to.deep.equal([';ev;ent1;']);
break;

case ';tas;k2;':
expect(t.events).to.deep.equal([';eve;nt2;', ';event;3;', ';eve;nt4', ';even;t5;']);
break;

default:
break;
}
});
});
Copy link
Member

Choose a reason for hiding this comment

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

instead of a loop with switch case, it'll be cleaner to access the tasks by index.

});
});