From e1feba47c561da42de85a2519072dbff584afcc8 Mon Sep 17 00:00:00 2001 From: hikerpig Date: Wed, 28 Feb 2024 23:47:15 +0800 Subject: [PATCH] fix: multiline note with comma text makes crash some diagrams (#264) * fix: multiline note with comma text makes crash some diagrams * chore: update shiki grammar --- .changeset/mean-jars-hug.md | 11 +++++++++++ .../src/activity/parser/activityDiagram.ne | 2 +- .../src/sequence/__tests__/sequence-parser.spec.js | 4 ++-- .../src/sequence/parser/sequenceDiagram.ne | 2 +- packages/test-shared/example-files/sequence-1.pintora | 2 +- website/docs/diagrams/activity-diagram.mdx | 2 +- website/docs/diagrams/sequence-diagram.mdx | 4 ++-- .../current/diagrams/activity-diagram.mdx | 2 +- .../current/diagrams/sequence-diagram.mdx | 4 ++-- website/static/data/pintora.tmLanguage.json | 4 ++-- 10 files changed, 24 insertions(+), 13 deletions(-) create mode 100644 .changeset/mean-jars-hug.md diff --git a/.changeset/mean-jars-hug.md b/.changeset/mean-jars-hug.md new file mode 100644 index 00000000..14dcbea8 --- /dev/null +++ b/.changeset/mean-jars-hug.md @@ -0,0 +1,11 @@ +--- +'@pintora/test-shared': patch +'pintora-website': patch +'pintora-demo': patch +'@pintora/cli': patch +'@pintora/standalone': patch +'@pintora/target-wintercg': patch +--- + +fix: multiline note with comma text makes crash some diagrams + diff --git a/packages/pintora-diagrams/src/activity/parser/activityDiagram.ne b/packages/pintora-diagrams/src/activity/parser/activityDiagram.ne index 09b63c4f..f35d9ab3 100644 --- a/packages/pintora-diagrams/src/activity/parser/activityDiagram.ne +++ b/packages/pintora-diagrams/src/activity/parser/activityDiagram.ne @@ -295,7 +295,7 @@ placement -> | "right" {% (d) => "right" %} multilineNoteText -> - (%WORD|%NL):* %END_NOTE {% + (%COMMA|%WORD|%NL):* %END_NOTE {% function(d) { const v = d[0].map(l => { return l.map(o => tv(o)) diff --git a/packages/pintora-diagrams/src/sequence/__tests__/sequence-parser.spec.js b/packages/pintora-diagrams/src/sequence/__tests__/sequence-parser.spec.js index f5ba0aad..73f3dc5b 100644 --- a/packages/pintora-diagrams/src/sequence/__tests__/sequence-parser.spec.js +++ b/packages/pintora-diagrams/src/sequence/__tests__/sequence-parser.spec.js @@ -52,7 +52,7 @@ sequenceDiagram const multilineNoteExample = stripStartEmptyLines(` sequenceDiagram @start_note right of Pintora - aaa note - + aaa, note - bbb @end_note `) @@ -62,7 +62,7 @@ sequenceDiagram expect(result.notes.length).toEqual(1) // parseMessage will trim text, so this may be somehow strange const messageText = result.notes[0].text - expect(messageText).toEqual('aaa note -\nbbb') + expect(messageText).toEqual('aaa, note -\nbbb') expect(result.notes[0].actor).toEqual('Pintora') }) diff --git a/packages/pintora-diagrams/src/sequence/parser/sequenceDiagram.ne b/packages/pintora-diagrams/src/sequence/parser/sequenceDiagram.ne index 080caf51..810cbbd9 100644 --- a/packages/pintora-diagrams/src/sequence/parser/sequenceDiagram.ne +++ b/packages/pintora-diagrams/src/sequence/parser/sequenceDiagram.ne @@ -289,7 +289,7 @@ textWithColon -> %COLON _ %REST_OF_LINE {% %} multilineNoteText -> - (%WORD|%NL):* %END_NOTE {% + (%WORD|%COMMA|%NL):* %END_NOTE {% function(d) { // console.log('[multiline text]', d) const v = d[0].map(l => { diff --git a/packages/test-shared/example-files/sequence-1.pintora b/packages/test-shared/example-files/sequence-1.pintora index 41e75211..018b5c39 100644 --- a/packages/test-shared/example-files/sequence-1.pintora +++ b/packages/test-shared/example-files/sequence-1.pintora @@ -9,7 +9,7 @@ sequenceDiagram deactivate Pintora @note over User,Pintora: note over @note right of User: note aside actor - @note right of User + @start_note right of User multiline note is possible @end_note diff --git a/website/docs/diagrams/activity-diagram.mdx b/website/docs/diagrams/activity-diagram.mdx index 3ee14fc7..36025a5d 100644 --- a/website/docs/diagrams/activity-diagram.mdx +++ b/website/docs/diagrams/activity-diagram.mdx @@ -199,7 +199,7 @@ activityDiagram :print error; endif - @note left + @start_note left left multiline note, no colon after placement @end_note diff --git a/website/docs/diagrams/sequence-diagram.mdx b/website/docs/diagrams/sequence-diagram.mdx index 7c84de6d..5e60d232 100644 --- a/website/docs/diagrams/sequence-diagram.mdx +++ b/website/docs/diagrams/sequence-diagram.mdx @@ -31,7 +31,7 @@ sequenceDiagram Pintora->>User: Return error message end deactivate Pintora - @note left of Pintora + @start_note left of Pintora Different output formats according to render targets 1. In browser side. output SVG or Canvas 2. In Node.js side. output PNG file @@ -47,7 +47,7 @@ sequenceDiagram Frida-->>Georgia: Flowers are beautiful @note over Frida,Georgia: Painters @note right of Georgia: Right - @note left of Georgia + @start_note left of Georgia multiline note @end_note diff --git a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/activity-diagram.mdx b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/activity-diagram.mdx index d50381c2..4b477278 100644 --- a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/activity-diagram.mdx +++ b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/activity-diagram.mdx @@ -200,7 +200,7 @@ activityDiagram :print error; endif - @note left + @start_note left 左边的 多行注释 @end_note diff --git a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/sequence-diagram.mdx b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/sequence-diagram.mdx index 608fef3e..c3a6ee47 100644 --- a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/sequence-diagram.mdx +++ b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/diagrams/sequence-diagram.mdx @@ -31,7 +31,7 @@ sequenceDiagram Pintora->>用户: 返回报错信息 end deactivate Pintora - @note left of Pintora + @start_note left of Pintora 渲染目标不同，结果媒介会有所不同 1. 浏览器，可直接渲染到页面上 svg / canvas 2. Node.js，默认 canvas，输出 PNG 位图 @@ -81,7 +81,7 @@ sequenceDiagram Frida-->>Georgia: Flowers are beautiful @note over Frida,Georgia: Painters @note right of Georgia: Right - @note left of Georgia + @start_note left of Georgia multiline note @end_note diff --git a/website/static/data/pintora.tmLanguage.json b/website/static/data/pintora.tmLanguage.json index c654c66f..a127fad3 100644 --- a/website/static/data/pintora.tmLanguage.json +++ b/website/static/data/pintora.tmLanguage.json @@ -527,7 +527,7 @@ }, { "comment": "(note)(direction)(Actor)(,)?(Actor)?(:)(Message)", - "match": "\\s*(note|@note)\\s+((?:left|right)\\sof|over)\\s+(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)(,)?(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)?(:)(?:\\s+([^;#]*))?", + "match": "\\s*(note|@note|@start_note)\\s+((?:left|right)\\sof|over)\\s+(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)(,)?(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)?(:)(?:\\s+([^;#]*))?", "captures": { "1": { "name": "keyword.control.pintora" @@ -554,7 +554,7 @@ }, { "comment": "Multiline note", - "begin": "(@note)\\s+((?:left|right)\\sof|over)\\s+(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)(,)?(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)?\\n", + "begin": "(@start_note)\\s+((?:left|right)\\sof|over)\\s+(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)(,)?(\\b[\"\\(\\)$&%\\^/#.?!*=<>\\'\\\\\\w\\s]+\\b\\s*)?\\n", "end": "(@end_note)", "beginCaptures": { "1": {