GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

fix(git): support single character branch names

Browse Source 
In gitGraph, add support branch names that only have a single
character.

The branch regex is checking for a starting character, and an
ending character, so it currently needs at least two characters.

I've wrapped everything except the first character in a `()?` to fix
this.

There are some really complicated regexes that do match what
valid git branches are (see https://stackoverflow.com/a/12093994), but
I'm reluctant to add them in, since it will be a pain to test all
the different edgecases.

Hopefully https://github.com/mermaid-js/mermaid/pull/3432 might be used
in the future to make a better gitgraph parser!
This commit is contained in:
Alois Klink 2022-09-15 01:05:11 +01:00
parent 9acdc0bc2e
commit 59c69600e8
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/diagrams/git/gitGraphParserV2.spec.js
View File

@ -372,14 +372,16 @@ describe('when parsing a gitGraph', function () {
branch cherry-pick03 branch cherry-pick03
branch branch/example-branch branch branch/example-branch
branch merge/test_merge branch merge/test_merge
%% single character branch name
branch A
`; `;
parser.parse(str); parser.parse(str);
const commits = parser.yy.getCommits(); const commits = parser.yy.getCommits();
expect(Object.keys(commits).length).toBe(1); expect(Object.keys(commits).length).toBe(1);
expect(parser.yy.getCurrentBranch()).toBe('merge/test_merge'); expect(parser.yy.getCurrentBranch()).toBe('A');
expect(parser.yy.getDirection()).toBe('LR'); expect(parser.yy.getDirection()).toBe('LR');
expect(Object.keys(parser.yy.getBranches()).length).toBe(6); expect(Object.keys(parser.yy.getBranches()).length).toBe(7);
expect(Object.keys(parser.yy.getBranches())).toEqual( expect(Object.keys(parser.yy.getBranches())).toEqual(
expect.arrayContaining([ expect.arrayContaining([
'branch01', 'branch01',
@ -387,6 +389,7 @@ describe('when parsing a gitGraph', function () {
'cherry-pick03', 'cherry-pick03',
'branch/example-branch', 'branch/example-branch',
'merge/test_merge', 'merge/test_merge',
'A',
]) ])
); );
}); });

2
src/diagrams/git/parser/gitGraph.jison
View File

@ -61,7 +61,7 @@ checkout(?=\s|$) return 'CHECKOUT';
<string>["] this.popState(); <string>["] this.popState();
<string>[^"]* return 'STR'; <string>[^"]* return 'STR';
[0-9]+(?=\s|$) return 'NUM'; [0-9]+(?=\s|$) return 'NUM';
\w[-\./\w]*[-\w] return 'ID'; // only a subset of https://git-scm.com/docs/git-check-ref-format \w([-\./\w]*[-\w])? return 'ID'; // only a subset of https://git-scm.com/docs/git-check-ref-format
<<EOF>> return 'EOF'; <<EOF>> return 'EOF';
\s+ /* skip all whitespace */ // lowest priority so we can use lookaheads in earlier regex \s+ /* skip all whitespace */ // lowest priority so we can use lookaheads in earlier regex