Skip to content

Fix table formatter width for arrows and rare wide characters #1581

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.

Sign up for GitHub

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

Open
seeones wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix table formatter width for arrows and rare wide characters #1581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/tableFormatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,10 @@ class MarkdownDocumentFormatter implements vscode.DocumentFormattingEditProvider
const fieldRegExp = new RegExp(/((\\\||[^\|])*)\|/gu);
// Emoji and CJK characters with double visual width (width 2)
// https://www.ling.upenn.edu/courses/Spring_2003/ling538/UnicodeRanges.html
// Extended_Pictographic includes all graphical emoji chars
// Extended_Pictographic includes all graphical emoji chars (e.g. ✅ ⬜ ❌)
// CJK ranges: U+3000-U+9FFF, U+AC00-U+D7AF, U+FF01-U+FF60
const doubleWidthRegex = /\p{Extended_Pictographic}|[\u3000-\u9fff\uac00-\ud7af\uff01-\uff60]/gu;
// Arrows (U+2190-U+21FF, e.g. ↑ ↓ ← →) are rendered double-width in CJK contexts
const doubleWidthRegex = /\p{Extended_Pictographic}|[\u1100-\u115F\u2190-\u21FF\u2329\u232A\u2E80-\u2FFF\u3000-\u9FFF\uA000-\uA4CF\uA960-\uA97F\uAC00-\uD7FF\uF900-\uFAFF\uFE10-\uFE19\uFE30-\uFE6B\uFF01-\uFF60\uFFE0-\uFFE6\u{16FE0}-\u{16FF6}\u{17000}-\u{18D1E}\u{1AFF0}-\u{1AFFE}\u{1B000}-\u{1B2FB}\u{1D300}-\u{1D376}\u{1F200}-\u{1F265}\u{20000}-\u{3FFFD}]/gu;

const lines = rows.map((row, iRow) => {
// Normalize
Expand Down Expand Up @@ -223,7 +224,7 @@ class MarkdownDocumentFormatter implements vscode.DocumentFormattingEditProvider
const visualWidth = colWidth[iCol];
let jsLength = splitter.splitGraphemes(cell + ' '.repeat(visualWidth)).slice(0, visualWidth).join('').length;

// Subtract double-width characters (emoji and CJK)
// Subtract double-width characters (emoji, CJK, and wide symbols)
jsLength -= cell.match(doubleWidthRegex)?.length ?? 0;

return this.alignText(cell, colAlign[iCol], jsLength);
Expand Down
20 changes: 20 additions & 0 deletions src/test/suite/integration/tableFormatter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,4 +471,24 @@ suite("Table formatter.", () => {
],
new Selection(0, 0, 0, 0));
});

test("Wide symbols in table cells", () => {
return testCommand('editor.action.formatDocument',
[
'| 阶段 | 状态 |',
'| --- | --- |',
'| 需求定义 | ✅ 完成 |',
'| 测试 | ⬜ 待开始 |',
'| 方向 | ↑↓←→ |'
],
new Selection(0, 0, 0, 0),
[
'| 阶段 | 状态 |',
'| -------- | --------- |',
'| 需求定义 | ✅ 完成 |',
'| 测试 | ⬜ 待开始 |',
'| 方向 | ↑↓←→ |'
],
new Selection(0, 0, 0, 0));
});
});