react-markdown-table-ts 0.2.5 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/errors.js +31 -0
- package/dist/errors.js.map +1 -0
- package/dist/helpers.js +93 -0
- package/dist/helpers.js.map +1 -0
- package/dist/index.cjs.js +17 -17
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +17 -17
- package/dist/index.esm.js.map +1 -1
- package/dist/src/errors.d.ts +6 -0
- package/dist/src/errors.js +31 -0
- package/dist/src/errors.js.map +1 -0
- package/dist/src/helpers.d.ts +34 -0
- package/dist/src/helpers.js +93 -0
- package/dist/src/helpers.js.map +1 -0
- package/dist/src/index.d.ts +19 -0
- package/dist/src/index.js +201 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/types.d.ts +62 -0
- package/dist/src/types.js +3 -0
- package/dist/src/types.js.map +1 -0
- package/dist/src/utils.d.ts +47 -0
- package/dist/src/utils.js +142 -0
- package/dist/src/utils.js.map +1 -0
- package/dist/src/validation.d.ts +7 -0
- package/dist/src/validation.js +65 -0
- package/dist/src/validation.js.map +1 -0
- package/dist/test/MarkdownTable.test.d.ts +1 -0
- package/dist/test/MarkdownTable.test.js +91 -0
- package/dist/test/MarkdownTable.test.js.map +1 -0
- package/dist/test/helpers.test.d.ts +1 -0
- package/dist/test/helpers.test.js +99 -0
- package/dist/test/helpers.test.js.map +1 -0
- package/dist/test/jest.setup.d.ts +2 -0
- package/dist/test/jest.setup.js +3 -0
- package/dist/test/jest.setup.js.map +1 -0
- package/dist/test/utils.test.d.ts +1 -0
- package/dist/test/utils.test.js +191 -0
- package/dist/test/utils.test.js.map +1 -0
- package/dist/test/validation.test.d.ts +1 -0
- package/dist/test/validation.test.js +87 -0
- package/dist/test/validation.test.js.map +1 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/utils.js +142 -0
- package/dist/utils.js.map +1 -0
- package/dist/validation.js +65 -0
- package/dist/validation.js.map +1 -0
- package/package.json +2 -1
@@ -0,0 +1,191 @@
|
|
1
|
+
import { calculateColumnWidths, formatMarkdownRow, formatAlignmentRow, generateMarkdownTableString, replaceNewlinesInCell, } from '../src/utils';
|
2
|
+
describe('calculateColumnWidths', function () {
|
3
|
+
it('calculates correct column widths for simple data', function () {
|
4
|
+
var inputData = [
|
5
|
+
['Header 1', 'Header 2', 'Header 3'],
|
6
|
+
['Short', 'Medium length', 'Longest content here'],
|
7
|
+
['A', 'B', 'C'],
|
8
|
+
];
|
9
|
+
var result = calculateColumnWidths(inputData, 3);
|
10
|
+
expect(result).toEqual([8, 13, 20]);
|
11
|
+
});
|
12
|
+
it('handles empty cells', function () {
|
13
|
+
var inputData = [
|
14
|
+
['Header 1', '', 'Header 3'],
|
15
|
+
['Content', 'Medium', ''],
|
16
|
+
];
|
17
|
+
var result = calculateColumnWidths(inputData, 3);
|
18
|
+
expect(result).toEqual([8, 6, 8]);
|
19
|
+
});
|
20
|
+
it('uses minimum width of 3 for empty columns', function () {
|
21
|
+
var inputData = [
|
22
|
+
['', '', ''],
|
23
|
+
['A', '', 'C'],
|
24
|
+
];
|
25
|
+
var result = calculateColumnWidths(inputData, 3);
|
26
|
+
expect(result).toEqual([3, 3, 3]);
|
27
|
+
});
|
28
|
+
it('handles varying number of columns', function () {
|
29
|
+
var inputData = [
|
30
|
+
['Header 1', 'Header 2'],
|
31
|
+
['Content 1', 'Content 2', 'Extra Content'],
|
32
|
+
['A', 'B', 'C', 'D'],
|
33
|
+
];
|
34
|
+
var result = calculateColumnWidths(inputData, 4);
|
35
|
+
expect(result).toEqual([9, 9, 13, 3]);
|
36
|
+
});
|
37
|
+
});
|
38
|
+
describe('formatMarkdownRow', function () {
|
39
|
+
it('formats a simple row correctly with default alignments and widths', function () {
|
40
|
+
var tableRow = ['Column 1', 'Column 2', 'Column 3'];
|
41
|
+
var result = formatMarkdownRow(3, tableRow, []);
|
42
|
+
expect(result).toBe('| Column 1 | Column 2 | Column 3 |');
|
43
|
+
});
|
44
|
+
it('applies column widths correctly', function () {
|
45
|
+
var tableRow = ['Short', 'Medium', 'Long'];
|
46
|
+
var columnWidths = [10, 10, 10];
|
47
|
+
var result = formatMarkdownRow(3, tableRow, [], columnWidths);
|
48
|
+
expect(result).toBe('| Short | Medium | Long |');
|
49
|
+
});
|
50
|
+
it('applies alignments correctly', function () {
|
51
|
+
var tableRow = ['Left', 'Center', 'Right'];
|
52
|
+
var columnWidths = [10, 10, 10];
|
53
|
+
var columnAlignments = ['left', 'center', 'right'];
|
54
|
+
var result = formatMarkdownRow(3, tableRow, columnAlignments, columnWidths);
|
55
|
+
expect(result).toBe('| Left | Center | Right |');
|
56
|
+
});
|
57
|
+
it('handles empty cells', function () {
|
58
|
+
var tableRow = ['Content', '', 'More'];
|
59
|
+
var result = formatMarkdownRow(3, tableRow, []);
|
60
|
+
expect(result).toBe('| Content | | More |');
|
61
|
+
});
|
62
|
+
it('replaces newlines with <br> tags when specified', function () {
|
63
|
+
var tableRow = ['Line1\nLine2', 'SingleLine', 'Another\nLine'];
|
64
|
+
var columnWidths = [12, 10, 12];
|
65
|
+
var columnAlignments = ['left', 'center', 'right'];
|
66
|
+
var result = formatMarkdownRow(3, tableRow, columnAlignments, columnWidths, false, true);
|
67
|
+
expect(result).toBe('| Line1<br>Line2 | SingleLine | Another<br>Line |');
|
68
|
+
});
|
69
|
+
it('uses tabs between columns when useTabs is true', function () {
|
70
|
+
var tableRow = ['Tab1', 'Tab2', 'Tab3'];
|
71
|
+
var columnWidths = [5, 5, 5];
|
72
|
+
var columnAlignments = ['left', 'center', 'right'];
|
73
|
+
var result = formatMarkdownRow(3, tableRow, columnAlignments, columnWidths, true);
|
74
|
+
// Use a regular expression to match the pattern, allowing for flexible whitespace
|
75
|
+
expect(result).toMatch(/^\|\s*Tab1\s*\|\s*Tab2\s*\|\s*Tab3\s*\|$/);
|
76
|
+
});
|
77
|
+
});
|
78
|
+
describe('formatAlignmentRow', function () {
|
79
|
+
it('generates default left alignment for all columns with default widths', function () {
|
80
|
+
var result = formatAlignmentRow(3, []);
|
81
|
+
expect(result).toBe('| :-- | :-- | :-- |');
|
82
|
+
});
|
83
|
+
it('applies custom alignments correctly', function () {
|
84
|
+
var columnAlignments = ['left', 'center', 'right'];
|
85
|
+
var columnWidths = [10, 10, 10];
|
86
|
+
var result = formatAlignmentRow(3, columnAlignments, columnWidths);
|
87
|
+
expect(result).toBe('| :--------- | :--------: | ---------: |');
|
88
|
+
});
|
89
|
+
it('handles custom widths', function () {
|
90
|
+
var columnWidths = [5, 10, 5];
|
91
|
+
var columnAlignments = ['left', 'center', 'right'];
|
92
|
+
var result = formatAlignmentRow(3, columnAlignments, columnWidths);
|
93
|
+
expect(result).toBe('| :---- | :--------: | ----: |');
|
94
|
+
});
|
95
|
+
it('uses default alignment when not enough alignments are provided', function () {
|
96
|
+
var columnAlignments = ['center'];
|
97
|
+
var result = formatAlignmentRow(3, columnAlignments);
|
98
|
+
expect(result).toBe('| :-: | :-- | :-- |');
|
99
|
+
});
|
100
|
+
it('uses "none" alignment correctly', function () {
|
101
|
+
var columnAlignments = ['none', 'left', 'right'];
|
102
|
+
var columnWidths = [5, 10, 5];
|
103
|
+
var result = formatAlignmentRow(3, columnAlignments, columnWidths);
|
104
|
+
expect(result).toBe('| ----- | :--------- | ----: |');
|
105
|
+
});
|
106
|
+
});
|
107
|
+
describe('generateMarkdownTableString', function () {
|
108
|
+
it('should generate a complete Markdown table string with default settings', function () {
|
109
|
+
var inputData = {
|
110
|
+
inputDataHeader: ['Name', 'Age', 'City'],
|
111
|
+
inputDataBody: [
|
112
|
+
['Alice', '30', 'New York'],
|
113
|
+
['Bob', '25', 'Los Angeles'],
|
114
|
+
],
|
115
|
+
};
|
116
|
+
var columnAlignments = ['left', 'center', 'right'];
|
117
|
+
var result = generateMarkdownTableString(inputData, columnAlignments);
|
118
|
+
var expected = "| Name | Age | City |\n| :---- | :-: | ----------: |\n| Alice | 30 | New York |\n| Bob | 25 | Los Angeles |";
|
119
|
+
expect(result).toBe(expected);
|
120
|
+
});
|
121
|
+
it('should adjust column widths based on content when adjustColumnWidths is true', function () {
|
122
|
+
var inputData = {
|
123
|
+
inputDataHeader: ['Header', 'Another Header', 'Short'],
|
124
|
+
inputDataBody: [
|
125
|
+
['Longer Content', 'Mid', 'S'],
|
126
|
+
['A', 'B', 'C'],
|
127
|
+
],
|
128
|
+
};
|
129
|
+
var columnAlignments = ['left', 'center', 'right'];
|
130
|
+
var result = generateMarkdownTableString(inputData, columnAlignments);
|
131
|
+
var expected = "| Header | Another Header | Short |\n| :------------- | :------------: | ----: |\n| Longer Content | Mid | S |\n| A | B | C |";
|
132
|
+
expect(result).toBe(expected);
|
133
|
+
});
|
134
|
+
it('should use tabs between columns when useTabs is true', function () {
|
135
|
+
var inputData = {
|
136
|
+
inputDataHeader: ['Name', 'Age', 'City'],
|
137
|
+
inputDataBody: [
|
138
|
+
['Alice', '30', 'New York'],
|
139
|
+
['Bob', '25', 'Los Angeles'],
|
140
|
+
],
|
141
|
+
};
|
142
|
+
var columnAlignments = ['left', 'center', 'right'];
|
143
|
+
var result = generateMarkdownTableString(inputData, columnAlignments, true, true, false);
|
144
|
+
var expected = "\n| Name | Age | City |\n| :---- | :-: | ----------: |\n| Alice | 30 | New York |\n| Bob | 25 | Los Angeles |\n "
|
145
|
+
.trim()
|
146
|
+
.replace(/\s+/g, ' ');
|
147
|
+
expect(result.replace(/\s+/g, ' ')).toBe(expected);
|
148
|
+
});
|
149
|
+
it('should handle tables with varying number of columns', function () {
|
150
|
+
var inputData = {
|
151
|
+
inputDataHeader: ['Name', 'Age'],
|
152
|
+
inputDataBody: [
|
153
|
+
['Alice', '30', 'Engineer'],
|
154
|
+
['Bob', '25'],
|
155
|
+
['Charlie', '35', 'Teacher', 'Extra Column'],
|
156
|
+
],
|
157
|
+
};
|
158
|
+
var columnAlignments = [
|
159
|
+
'left',
|
160
|
+
'center',
|
161
|
+
'right',
|
162
|
+
'none',
|
163
|
+
];
|
164
|
+
var result = generateMarkdownTableString(inputData, columnAlignments);
|
165
|
+
var expected = "| Name | Age | | |\n| :------ | :-: | -------: | ------------ |\n| Alice | 30 | Engineer | |\n| Bob | 25 | | |\n| Charlie | 35 | Teacher | Extra Column |";
|
166
|
+
expect(result).toBe(expected);
|
167
|
+
});
|
168
|
+
});
|
169
|
+
describe('replaceNewlinesInCell', function () {
|
170
|
+
it('replaces newline characters with <br> tags', function () {
|
171
|
+
var tableCell = 'Line1\nLine2\nLine3';
|
172
|
+
var result = replaceNewlinesInCell(tableCell);
|
173
|
+
expect(result).toBe('Line1<br>Line2<br>Line3');
|
174
|
+
});
|
175
|
+
it('returns the original string if there are no newline characters', function () {
|
176
|
+
var tableCell = 'No newlines here';
|
177
|
+
var result = replaceNewlinesInCell(tableCell);
|
178
|
+
expect(result).toBe('No newlines here');
|
179
|
+
});
|
180
|
+
it('handles empty string', function () {
|
181
|
+
var tableCell = '';
|
182
|
+
var result = replaceNewlinesInCell(tableCell);
|
183
|
+
expect(result).toBe('');
|
184
|
+
});
|
185
|
+
it('handles strings with only newline characters', function () {
|
186
|
+
var tableCell = '\n\n';
|
187
|
+
var result = replaceNewlinesInCell(tableCell);
|
188
|
+
expect(result).toBe('<br><br>');
|
189
|
+
});
|
190
|
+
});
|
191
|
+
//# sourceMappingURL=utils.test.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../../test/utils.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,cAAc,CAAC;AAKtB,QAAQ,CAAC,uBAAuB,EAAE;IAChC,EAAE,CAAC,kDAAkD,EAAE;QACrD,IAAM,SAAS,GAAe;YAC5B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC;YACpC,CAAC,OAAO,EAAE,eAAe,EAAE,sBAAsB,CAAC;YAClD,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SAChB,CAAC;QACF,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE;QACxB,IAAM,SAAS,GAAe;YAC5B,CAAC,UAAU,EAAE,EAAE,EAAE,UAAU,CAAC;YAC5B,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC;SAC1B,CAAC;QACF,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE;QAC9C,IAAM,SAAS,GAAe;YAC5B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;YACZ,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC;SACf,CAAC;QACF,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE;QACtC,IAAM,SAAS,GAAe;YAC5B,CAAC,UAAU,EAAE,UAAU,CAAC;YACxB,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,CAAC;YAC3C,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SACrB,CAAC;QACF,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE;IAC5B,EAAE,CAAC,mEAAmE,EAAE;QACtE,IAAM,QAAQ,GAAa,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAChE,IAAM,MAAM,GAAG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE;QACpC,IAAM,QAAQ,GAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvD,IAAM,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,IAAM,MAAM,GAAG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE;QACjC,IAAM,QAAQ,GAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACvD,IAAM,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,iBAAiB,CAC9B,CAAC,EACD,QAAQ,EACR,gBAAgB,EAChB,YAAY,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE;QACxB,IAAM,QAAQ,GAAa,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,IAAM,MAAM,GAAG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE;QACpD,IAAM,QAAQ,GAAa,CAAC,cAAc,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QAC3E,IAAM,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,iBAAiB,CAC9B,CAAC,EACD,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,KAAK,EACL,IAAI,CACL,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE;QACnD,IAAM,QAAQ,GAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACpD,IAAM,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/B,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,iBAAiB,CAC9B,CAAC,EACD,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,IAAI,CACL,CAAC;QACF,kFAAkF;QAClF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,EAAE,CAAC,sEAAsE,EAAE;QACzE,IAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE;QACxC,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,IAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE;QAC1B,IAAM,YAAY,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAChC,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE;QACnE,IAAM,gBAAgB,GAAsB,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE;QACpC,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,IAAM,YAAY,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAChC,IAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,6BAA6B,EAAE;IACtC,EAAE,CAAC,wEAAwE,EAAE;QAC3E,IAAM,SAAS,GAAc;YAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC;YACxC,aAAa,EAAE;gBACb,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC;gBAC3B,CAAC,KAAK,EAAE,IAAI,EAAE,aAAa,CAAC;aAC7B;SACF,CAAC;QACF,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxE,IAAM,QAAQ,GAAG,4HAGS,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE;QACjF,IAAM,SAAS,GAAc;YAC3B,eAAe,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,CAAC;YACtD,aAAa,EAAE;gBACb,CAAC,gBAAgB,EAAE,KAAK,EAAE,GAAG,CAAC;gBAC9B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;aAChB;SACF,CAAC;QACF,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxE,IAAM,QAAQ,GAAG,oLAGuB,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE;QACzD,IAAM,SAAS,GAAc;YAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC;YACxC,aAAa,EAAE;gBACb,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC;gBAC3B,CAAC,KAAK,EAAE,IAAI,EAAE,aAAa,CAAC;aAC7B;SACF,CAAC;QACF,IAAM,gBAAgB,GAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,IAAM,MAAM,GAAG,2BAA2B,CACxC,SAAS,EACT,gBAAgB,EAChB,IAAI,EACJ,IAAI,EACJ,KAAK,CACN,CAAC;QACF,IAAM,QAAQ,GAAG,qHAKhB;aACE,IAAI,EAAE;aACN,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACxB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE;QACxD,IAAM,SAAS,GAAc;YAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;YAChC,aAAa,EAAE;gBACb,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC;gBAC3B,CAAC,KAAK,EAAE,IAAI,CAAC;gBACb,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC;aAC7C;SACF,CAAC;QACF,IAAM,gBAAgB,GAAsB;YAC1C,MAAM;YACN,QAAQ;YACR,OAAO;YACP,MAAM;SACP,CAAC;QACF,IAAM,MAAM,GAAG,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxE,IAAM,QAAQ,GAAG,iOAIuB,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE;IAChC,EAAE,CAAC,4CAA4C,EAAE;QAC/C,IAAM,SAAS,GAAG,qBAAqB,CAAC;QACxC,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE;QACnE,IAAM,SAAS,GAAG,kBAAkB,CAAC;QACrC,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE;QACzB,IAAM,SAAS,GAAG,EAAE,CAAC;QACrB,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE;QACjD,IAAM,SAAS,GAAG,MAAM,CAAC;QACzB,IAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|
@@ -0,0 +1,87 @@
|
|
1
|
+
import { validateMarkdownTableProps } from '../src/validation';
|
2
|
+
import { MarkdownTableError } from '../src/errors';
|
3
|
+
describe('validateMarkdownTableProps', function () {
|
4
|
+
var validData = [
|
5
|
+
['Header 1', 'Header 2', 'Header 3'],
|
6
|
+
['Row 1, Col 1', 'Row 1, Col 2', 'Row 1, Col 3'],
|
7
|
+
['Row 2, Col 1', 'Row 2, Col 2', 'Row 2, Col 3'],
|
8
|
+
];
|
9
|
+
it('validates correct props without throwing', function () {
|
10
|
+
expect(function () {
|
11
|
+
return validateMarkdownTableProps({ inputData: validData });
|
12
|
+
}).not.toThrow();
|
13
|
+
});
|
14
|
+
it('throws error for empty data', function () {
|
15
|
+
expect(function () { return validateMarkdownTableProps({ inputData: [] }); }).toThrow(MarkdownTableError);
|
16
|
+
});
|
17
|
+
it('throws error for invalid data type', function () {
|
18
|
+
expect(function () {
|
19
|
+
return validateMarkdownTableProps({
|
20
|
+
inputData: 'not an array',
|
21
|
+
});
|
22
|
+
}).toThrow(MarkdownTableError);
|
23
|
+
});
|
24
|
+
it('throws error for invalid header when hasHeader is true', function () {
|
25
|
+
var invalidData = [[], ['Row 1']];
|
26
|
+
expect(function () {
|
27
|
+
return validateMarkdownTableProps({ inputData: invalidData, hasHeader: true });
|
28
|
+
}).toThrow(MarkdownTableError);
|
29
|
+
});
|
30
|
+
it('throws error for non-string cell in header', function () {
|
31
|
+
var invalidData = [
|
32
|
+
[1, 'Header 2', 'Header 3'],
|
33
|
+
['Row 1'],
|
34
|
+
];
|
35
|
+
expect(function () {
|
36
|
+
return validateMarkdownTableProps({
|
37
|
+
inputData: invalidData,
|
38
|
+
});
|
39
|
+
}).toThrow(MarkdownTableError);
|
40
|
+
});
|
41
|
+
it('throws error for non-string cell in body', function () {
|
42
|
+
var invalidData = [
|
43
|
+
['Header 1', 'Header 2'],
|
44
|
+
['Row 1', 2],
|
45
|
+
];
|
46
|
+
expect(function () {
|
47
|
+
return validateMarkdownTableProps({
|
48
|
+
inputData: invalidData,
|
49
|
+
});
|
50
|
+
}).toThrow(MarkdownTableError);
|
51
|
+
});
|
52
|
+
it('throws error for invalid column alignment', function () {
|
53
|
+
var props = {
|
54
|
+
inputData: validData,
|
55
|
+
columnAlignments: [
|
56
|
+
'left',
|
57
|
+
'invalid',
|
58
|
+
],
|
59
|
+
};
|
60
|
+
expect(function () { return validateMarkdownTableProps(props); }).toThrow(MarkdownTableError);
|
61
|
+
});
|
62
|
+
it('throws error for invalid isCompact prop', function () {
|
63
|
+
expect(function () {
|
64
|
+
return validateMarkdownTableProps({
|
65
|
+
inputData: validData,
|
66
|
+
isCompact: 'true',
|
67
|
+
});
|
68
|
+
}).toThrow(MarkdownTableError);
|
69
|
+
});
|
70
|
+
it('throws error for invalid hasTabs prop', function () {
|
71
|
+
expect(function () {
|
72
|
+
return validateMarkdownTableProps({
|
73
|
+
inputData: validData,
|
74
|
+
hasTabs: 'true',
|
75
|
+
});
|
76
|
+
}).toThrow(MarkdownTableError);
|
77
|
+
});
|
78
|
+
it('throws error for invalid canReplaceNewlines prop', function () {
|
79
|
+
expect(function () {
|
80
|
+
return validateMarkdownTableProps({
|
81
|
+
inputData: validData,
|
82
|
+
canReplaceNewlines: 'true',
|
83
|
+
});
|
84
|
+
}).toThrow(MarkdownTableError);
|
85
|
+
});
|
86
|
+
});
|
87
|
+
//# sourceMappingURL=validation.test.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"validation.test.js","sourceRoot":"","sources":["../../test/validation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,0BAA0B,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAC;AAGjD,QAAQ,CAAC,4BAA4B,EAAE;IACrC,IAAM,SAAS,GAAe;QAC5B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC;QACpC,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,CAAC;QAChD,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,CAAC;KACjD,CAAC;IAEF,EAAE,CAAC,0CAA0C,EAAE;QAC7C,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC,EAAC,SAAS,EAAE,SAAS,EAAC,CAAC;QAAlD,CAAkD,CACnD,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE;QAChC,MAAM,CAAC,cAAM,OAAA,0BAA0B,CAAC,EAAC,SAAS,EAAE,EAAE,EAAC,CAAC,EAA3C,CAA2C,CAAC,CAAC,OAAO,CAC/D,kBAAkB,CACnB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE;QACvC,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,cAAuC;aACnD,CAAC;QAFF,CAEE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE;QAC3D,IAAM,WAAW,GAAe,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC,EAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC;QAArE,CAAqE,CACtE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE;QAC/C,IAAM,WAAW,GAA0B;YACzC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC;YAC3B,CAAC,OAAO,CAAC;SACV,CAAC;QACF,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,WAAoC;aAChD,CAAC;QAFF,CAEE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE;QAC7C,IAAM,WAAW,GAA0B;YACzC,CAAC,UAAU,EAAE,UAAU,CAAC;YACxB,CAAC,OAAO,EAAE,CAAC,CAAC;SACb,CAAC;QACF,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,WAAoC;aAChD,CAAC;QAFF,CAEE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE;QAC9C,IAAM,KAAK,GAAuB;YAChC,SAAS,EAAE,SAAS;YACpB,gBAAgB,EAAE;gBAChB,MAAM;gBACN,SAAiD;aAClD;SACF,CAAC;QACF,MAAM,CAAC,cAAM,OAAA,0BAA0B,CAAC,KAAK,CAAC,EAAjC,CAAiC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE;QAC5C,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,SAAS;gBACpB,SAAS,EAAE,MAA4B;aACxC,CAAC;QAHF,CAGE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE;QAC1C,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,SAAS;gBACpB,OAAO,EAAE,MAA4B;aACtC,CAAC;QAHF,CAGE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE;QACrD,MAAM,CAAC;YACL,OAAA,0BAA0B,CAAC;gBACzB,SAAS,EAAE,SAAS;gBACpB,kBAAkB,EAAE,MAA4B;aACjD,CAAC;QAHF,CAGE,CACH,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/types.js
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAe"}
|
package/dist/utils.js
ADDED
@@ -0,0 +1,142 @@
|
|
1
|
+
// src/utils.ts
|
2
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
3
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
4
|
+
if (ar || !(i in from)) {
|
5
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
6
|
+
ar[i] = from[i];
|
7
|
+
}
|
8
|
+
}
|
9
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
10
|
+
};
|
11
|
+
/**
|
12
|
+
* Calculates the maximum width for each column based on the content.
|
13
|
+
* @param allRows - All rows (header and body) of the table.
|
14
|
+
* @param maxColumnCount - The maximum number of columns in the table.
|
15
|
+
* @returns An array of maximum widths for each column.
|
16
|
+
*/
|
17
|
+
export function calculateColumnWidths(allRows, maxColumnCount) {
|
18
|
+
var widths = new Array(maxColumnCount).fill(3); // Minimum width of 3 for each column.
|
19
|
+
allRows.forEach(function (row) {
|
20
|
+
var _a;
|
21
|
+
for (var i = 0; i < maxColumnCount; i++) {
|
22
|
+
var cell = (_a = row[i]) !== null && _a !== void 0 ? _a : '';
|
23
|
+
widths[i] = Math.max(widths[i], cell.length);
|
24
|
+
}
|
25
|
+
});
|
26
|
+
return widths;
|
27
|
+
}
|
28
|
+
/**
|
29
|
+
* Replaces newline characters in a string with <br> tags.
|
30
|
+
* @param cell - The cell content to process.
|
31
|
+
* @returns The processed cell content with newlines replaced.
|
32
|
+
*/
|
33
|
+
export function replaceNewlinesInCell(cell) {
|
34
|
+
return cell.replace(/\n/g, '<br>');
|
35
|
+
}
|
36
|
+
/**
|
37
|
+
* Formats a single row into a Markdown-formatted string.
|
38
|
+
* @param columnCount - The number of columns in the table.
|
39
|
+
* @param row - The data of the current row.
|
40
|
+
* @param columnAlignments - Alignment settings for each column.
|
41
|
+
* @param columnWidths - Widths of each column.
|
42
|
+
* @param useTabs - Flag to use tabs between columns.
|
43
|
+
* @param replaceNewlines - Flag to replace newlines with <br> tags.
|
44
|
+
* @returns The Markdown string for the row.
|
45
|
+
*/
|
46
|
+
export function formatMarkdownRow(columnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines) {
|
47
|
+
var _a, _b;
|
48
|
+
if (useTabs === void 0) { useTabs = false; }
|
49
|
+
if (replaceNewlines === void 0) { replaceNewlines = false; }
|
50
|
+
var defaultAlignment = 'left';
|
51
|
+
var adjustedAlignments = columnAlignments.length < columnCount
|
52
|
+
? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
|
53
|
+
var markdownRow = '|';
|
54
|
+
for (var i = 0; i < columnCount; i++) {
|
55
|
+
var cell = (_a = row[i]) !== null && _a !== void 0 ? _a : '';
|
56
|
+
if (replaceNewlines) {
|
57
|
+
cell = replaceNewlinesInCell(cell);
|
58
|
+
}
|
59
|
+
var alignment = (_b = adjustedAlignments[i]) !== null && _b !== void 0 ? _b : defaultAlignment;
|
60
|
+
var targetWidth = columnWidths ? columnWidths[i] : cell.length;
|
61
|
+
if (alignment === 'right') {
|
62
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padStart(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
|
63
|
+
}
|
64
|
+
else if (alignment === 'center') {
|
65
|
+
var totalPadding = targetWidth - cell.length;
|
66
|
+
var paddingLeft = Math.floor(totalPadding / 2);
|
67
|
+
var paddingRight = totalPadding - paddingLeft;
|
68
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(' '.repeat(paddingLeft)).concat(cell).concat(' '.repeat(paddingRight)).concat(useTabs ? '\t' : ' ', "|");
|
69
|
+
}
|
70
|
+
else {
|
71
|
+
// Left alignment or default
|
72
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padEnd(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
|
73
|
+
}
|
74
|
+
}
|
75
|
+
return markdownRow;
|
76
|
+
}
|
77
|
+
/**
|
78
|
+
* Generates the alignment row for the Markdown table syntax.
|
79
|
+
* @param columnCount - The number of columns in the table.
|
80
|
+
* @param columnAlignments - Alignment settings for each column.
|
81
|
+
* @param columnWidths - Widths of each column.
|
82
|
+
* @param useTabs - Flag to use tabs between columns.
|
83
|
+
* @returns The Markdown string for the alignment row.
|
84
|
+
*/
|
85
|
+
export function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs) {
|
86
|
+
var _a;
|
87
|
+
if (useTabs === void 0) { useTabs = false; }
|
88
|
+
var defaultAlignment = 'left';
|
89
|
+
var adjustedAlignments = columnAlignments.length < columnCount
|
90
|
+
? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
|
91
|
+
var alignmentRow = '|';
|
92
|
+
for (var i = 0; i < columnCount; i++) {
|
93
|
+
var alignment = (_a = adjustedAlignments[i]) !== null && _a !== void 0 ? _a : defaultAlignment;
|
94
|
+
var targetWidth = columnWidths ? columnWidths[i] : 3;
|
95
|
+
var alignIndicator = '';
|
96
|
+
switch (alignment) {
|
97
|
+
case 'left':
|
98
|
+
alignIndicator = ":".concat('-'.repeat(targetWidth - 1));
|
99
|
+
break;
|
100
|
+
case 'center':
|
101
|
+
alignIndicator = ":".concat('-'.repeat(targetWidth - 2), ":");
|
102
|
+
break;
|
103
|
+
case 'right':
|
104
|
+
alignIndicator = "".concat('-'.repeat(targetWidth - 1), ":");
|
105
|
+
break;
|
106
|
+
default:
|
107
|
+
alignIndicator = "".concat('-'.repeat(targetWidth));
|
108
|
+
break;
|
109
|
+
}
|
110
|
+
alignmentRow += "".concat(useTabs ? '\t' : ' ').concat(alignIndicator).concat(useTabs ? '\t' : ' ', "|");
|
111
|
+
}
|
112
|
+
return alignmentRow;
|
113
|
+
}
|
114
|
+
/**
|
115
|
+
* Generates a complete Markdown table string from the provided data.
|
116
|
+
* @param tableData - The table data including headers and rows.
|
117
|
+
* @param columnAlignments - Alignment settings for each column.
|
118
|
+
* @param adjustColumnWidths - Flag to adjust column widths based on content.
|
119
|
+
* @param useTabs - Flag to use tabs between columns.
|
120
|
+
* @param replaceNewlines - Flag to replace newlines with <br> tags.
|
121
|
+
* @returns The complete Markdown table string.
|
122
|
+
*/
|
123
|
+
export function generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, useTabs, replaceNewlines) {
|
124
|
+
if (adjustColumnWidths === void 0) { adjustColumnWidths = true; }
|
125
|
+
if (useTabs === void 0) { useTabs = false; }
|
126
|
+
if (replaceNewlines === void 0) { replaceNewlines = false; }
|
127
|
+
var headerColumnCount = tableData.header.length;
|
128
|
+
var bodyColumnCounts = tableData.rows.map(function (row) { return row.length; });
|
129
|
+
var maxColumnCount = Math.max.apply(Math, __spreadArray([headerColumnCount], bodyColumnCounts, false));
|
130
|
+
var columnWidths = adjustColumnWidths
|
131
|
+
? calculateColumnWidths(__spreadArray([tableData.header], tableData.rows, true), maxColumnCount)
|
132
|
+
: undefined;
|
133
|
+
var markdownHeaderRow = formatMarkdownRow(maxColumnCount, tableData.header, columnAlignments, columnWidths, useTabs, replaceNewlines);
|
134
|
+
var markdownAlignmentRow = formatAlignmentRow(maxColumnCount, columnAlignments, columnWidths, useTabs);
|
135
|
+
var markdownBodyRows = tableData.rows
|
136
|
+
.map(function (row) {
|
137
|
+
return formatMarkdownRow(maxColumnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines);
|
138
|
+
})
|
139
|
+
.join('\n');
|
140
|
+
return "".concat(markdownHeaderRow, "\n").concat(markdownAlignmentRow, "\n").concat(markdownBodyRows).trimEnd();
|
141
|
+
}
|
142
|
+
//# sourceMappingURL=utils.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,eAAe;;;;;;;;;;AAIf;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAA4B,EAC5B,cAAsB;IAEtB,IAAM,MAAM,GAAa,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,sCAAsC;IAElG,OAAO,CAAC,OAAO,CAAC,UAAC,GAAa;;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;YACvC,IAAM,IAAI,GAAG,MAAA,GAAG,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;YAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAC9C;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,GAAa,EACb,gBAAmE,EACnE,YAAgC,EAChC,OAAe,EACf,eAAuB;;IADvB,wBAAA,EAAA,eAAe;IACf,gCAAA,EAAA,uBAAuB;IAEvB,IAAM,gBAAgB,GAAyC,MAAM,CAAC;IACtE,IAAM,kBAAkB,GACtB,gBAAgB,CAAC,MAAM,GAAG,WAAW;QACnC,CAAC,iCACM,gBAAgB,SAChB,KAAK,CAAC,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,CAClD,gBAAgB,CACjB,QAEL,CAAC,CAAC,gBAAgB,CAAC;IAEvB,IAAI,WAAW,GAAG,GAAG,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,IAAI,IAAI,GAAG,MAAA,GAAG,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;QACxB,IAAI,eAAe,EAAE;YACnB,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;SACpC;QACD,IAAM,SAAS,GAAG,MAAA,kBAAkB,CAAC,CAAC,CAAC,mCAAI,gBAAgB,CAAC;QAC5D,IAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAEjE,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,WAAW,IAAI,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC/F;aAAM,IAAI,SAAS,KAAK,QAAQ,EAAE;YACjC,IAAM,YAAY,GAAG,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;YAC/C,IAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACjD,IAAM,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;YAChD,WAAW,IAAI,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,SAAG,IAAI,SAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC9H;aAAM;YACL,4BAA4B;YAC5B,WAAW,IAAI,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC7F;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,gBAAmE,EACnE,YAAgC,EAChC,OAAe;;IAAf,wBAAA,EAAA,eAAe;IAEf,IAAM,gBAAgB,GAAyC,MAAM,CAAC;IACtE,IAAM,kBAAkB,GACtB,gBAAgB,CAAC,MAAM,GAAG,WAAW;QACnC,CAAC,iCACM,gBAAgB,SAChB,KAAK,CAAC,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,CAClD,gBAAgB,CACjB,QAEL,CAAC,CAAC,gBAAgB,CAAC;IAEvB,IAAI,YAAY,GAAG,GAAG,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,IAAM,SAAS,GAAG,MAAA,kBAAkB,CAAC,CAAC,CAAC,mCAAI,gBAAgB,CAAC;QAC5D,IAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,cAAc,GAAG,EAAE,CAAC;QAExB,QAAQ,SAAS,EAAE;YACjB,KAAK,MAAM;gBACT,cAAc,GAAG,WAAI,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAE,CAAC;gBACnD,MAAM;YACR,KAAK,QAAQ;gBACX,cAAc,GAAG,WAAI,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,MAAG,CAAC;gBACpD,MAAM;YACR,KAAK,OAAO;gBACV,cAAc,GAAG,UAAG,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,MAAG,CAAC;gBACnD,MAAM;YACR;gBACE,cAAc,GAAG,UAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAE,CAAC;gBAC9C,MAAM;SACT;QAED,YAAY,IAAI,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,cAAc,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;KACpF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAA4B,EAC5B,gBAAmE,EACnE,kBAAyB,EACzB,OAAe,EACf,eAAuB;IAFvB,mCAAA,EAAA,yBAAyB;IACzB,wBAAA,EAAA,eAAe;IACf,gCAAA,EAAA,uBAAuB;IAEvB,IAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC;IAClD,IAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,UAAC,GAAa,IAAK,OAAA,GAAG,CAAC,MAAM,EAAV,CAAU,CAAC,CAAC;IAC3E,IAAM,cAAc,GAAG,IAAI,CAAC,GAAG,OAAR,IAAI,iBAAK,iBAAiB,GAAK,gBAAgB,SAAC,CAAC;IAExE,IAAM,YAAY,GAAG,kBAAkB;QACrC,CAAC,CAAC,qBAAqB,gBAClB,SAAS,CAAC,MAAM,GAAK,SAAS,CAAC,IAAI,SACpC,cAAc,CACf;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,IAAM,iBAAiB,GAAG,iBAAiB,CACzC,cAAc,EACd,SAAS,CAAC,MAAM,EAChB,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,eAAe,CAChB,CAAC;IACF,IAAM,oBAAoB,GAAG,kBAAkB,CAC7C,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,OAAO,CACR,CAAC;IAEF,IAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI;SACpC,GAAG,CAAC,UAAC,GAAa;QACjB,OAAA,iBAAiB,CACf,cAAc,EACd,GAAG,EACH,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,eAAe,CAChB;IAPD,CAOC,CACF;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,UAAG,iBAAiB,eAAK,oBAAoB,eAAK,gBAAgB,CAAE,CAAC,OAAO,EAAE,CAAC;AACxF,CAAC"}
|
@@ -0,0 +1,65 @@
|
|
1
|
+
// src/validation.ts
|
2
|
+
import { MarkdownTableError } from './errors';
|
3
|
+
/**
|
4
|
+
* Validates the structure of the table data based on the `hasHeader` flag.
|
5
|
+
* Throws an error if validation fails.
|
6
|
+
* @param props - The props to validate.
|
7
|
+
*/
|
8
|
+
export function validateMarkdownTableProps(props) {
|
9
|
+
var data = props.data, _a = props.hasHeader, hasHeader = _a === void 0 ? true : _a, columnAlignments = props.columnAlignments, _b = props.isCompact, isCompact = _b === void 0 ? false : _b, _c = props.hasTabs, hasTabs = _c === void 0 ? false : _c, _d = props.canReplaceNewlines, canReplaceNewlines = _d === void 0 ? false : _d;
|
10
|
+
if (!Array.isArray(data)) {
|
11
|
+
throw new MarkdownTableError("The 'data' prop must be a two-dimensional array.");
|
12
|
+
}
|
13
|
+
if (data.length === 0) {
|
14
|
+
throw new MarkdownTableError("The 'data' array must contain at least one row.");
|
15
|
+
}
|
16
|
+
// If hasHeader is true, ensure the first row exists and is valid
|
17
|
+
if (hasHeader) {
|
18
|
+
var header = data[0];
|
19
|
+
if (!Array.isArray(header) || header.length === 0) {
|
20
|
+
throw new MarkdownTableError("The first row of 'data' must be a non-empty array representing the header.");
|
21
|
+
}
|
22
|
+
// Validate each header cell is a string
|
23
|
+
header.forEach(function (cell, index) {
|
24
|
+
if (typeof cell !== 'string') {
|
25
|
+
throw new MarkdownTableError("Header cell at index ".concat(index, " must be a string."));
|
26
|
+
}
|
27
|
+
});
|
28
|
+
}
|
29
|
+
// Validate each row
|
30
|
+
data.forEach(function (row, rowIndex) {
|
31
|
+
if (!Array.isArray(row)) {
|
32
|
+
throw new MarkdownTableError("Row ".concat(rowIndex + 1, " in 'data' must be an array of strings."));
|
33
|
+
}
|
34
|
+
row.forEach(function (cell, cellIndex) {
|
35
|
+
if (typeof cell !== 'string') {
|
36
|
+
throw new MarkdownTableError("Cell at row ".concat(rowIndex + 1, ", column ").concat(cellIndex + 1, " must be a string."));
|
37
|
+
}
|
38
|
+
});
|
39
|
+
});
|
40
|
+
// Validate columnAlignments if provided
|
41
|
+
if (columnAlignments) {
|
42
|
+
if (!Array.isArray(columnAlignments)) {
|
43
|
+
throw new MarkdownTableError("'columnAlignments' must be an array of alignment strings.");
|
44
|
+
}
|
45
|
+
var validAlignments_1 = ['left', 'center', 'right', 'none'];
|
46
|
+
columnAlignments.forEach(function (alignment, index) {
|
47
|
+
if (!validAlignments_1.includes(alignment)) {
|
48
|
+
throw new MarkdownTableError("Invalid alignment '".concat(alignment, "' at index ").concat(index, ". Valid options are 'left', 'center', 'right', 'none'."));
|
49
|
+
}
|
50
|
+
});
|
51
|
+
}
|
52
|
+
// Validate isCompact
|
53
|
+
if (typeof isCompact !== 'boolean') {
|
54
|
+
throw new MarkdownTableError("'isCompact' must be a boolean.");
|
55
|
+
}
|
56
|
+
// Validate hasTabs
|
57
|
+
if (typeof hasTabs !== 'boolean') {
|
58
|
+
throw new MarkdownTableError("'hasTabs' must be a boolean.");
|
59
|
+
}
|
60
|
+
// Validate canReplaceNewlines
|
61
|
+
if (typeof canReplaceNewlines !== 'boolean') {
|
62
|
+
throw new MarkdownTableError("'canReplaceNewlines' must be a boolean.");
|
63
|
+
}
|
64
|
+
}
|
65
|
+
//# sourceMappingURL=validation.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,oBAAoB;AAGpB,OAAO,EAAC,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAE5C;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAyB;IAEhE,IAAA,IAAI,GAMF,KAAK,KANH,EACJ,KAKE,KAAK,UALS,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,gBAAgB,GAId,KAAK,iBAJS,EAChB,KAGE,KAAK,UAHU,EAAjB,SAAS,mBAAG,KAAK,KAAA,EACjB,KAEE,KAAK,QAFQ,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,KACE,KAAK,mBADmB,EAA1B,kBAAkB,mBAAG,KAAK,KAAA,CAClB;IAEV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxB,MAAM,IAAI,kBAAkB,CAC1B,kDAAkD,CACnD,CAAC;KACH;IAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,MAAM,IAAI,kBAAkB,CAC1B,iDAAiD,CAClD,CAAC;KACH;IAED,iEAAiE;IACjE,IAAI,SAAS,EAAE;QACb,IAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACjD,MAAM,IAAI,kBAAkB,CAC1B,4EAA4E,CAC7E,CAAC;SACH;QAED,wCAAwC;QACxC,MAAM,CAAC,OAAO,CAAC,UAAC,IAAI,EAAE,KAAK;YACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,MAAM,IAAI,kBAAkB,CAC1B,+BAAwB,KAAK,uBAAoB,CAClD,CAAC;aACH;QACH,CAAC,CAAC,CAAC;KACJ;IAED,oBAAoB;IACpB,IAAI,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,QAAQ;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACvB,MAAM,IAAI,kBAAkB,CAC1B,cAAO,QAAQ,GAAG,CAAC,4CAAyC,CAC7D,CAAC;SACH;QAED,GAAG,CAAC,OAAO,CAAC,UAAC,IAAI,EAAE,SAAS;YAC1B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,MAAM,IAAI,kBAAkB,CAC1B,sBAAe,QAAQ,GAAG,CAAC,sBAAY,SAAS,GAAG,CAAC,uBAAoB,CACzE,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,wCAAwC;IACxC,IAAI,gBAAgB,EAAE;QACpB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;YACpC,MAAM,IAAI,kBAAkB,CAC1B,2DAA2D,CAC5D,CAAC;SACH;QAED,IAAM,iBAAe,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5D,gBAAgB,CAAC,OAAO,CAAC,UAAC,SAAS,EAAE,KAAK;YACxC,IAAI,CAAC,iBAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBACxC,MAAM,IAAI,kBAAkB,CAC1B,6BAAsB,SAAS,wBAAc,KAAK,2DAAwD,CAC3G,CAAC;aACH;QACH,CAAC,CAAC,CAAC;KACJ;IAED,qBAAqB;IACrB,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;QAClC,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;KAChE;IAED,mBAAmB;IACnB,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;QAChC,MAAM,IAAI,kBAAkB,CAAC,8BAA8B,CAAC,CAAC;KAC9D;IAED,8BAA8B;IAC9B,IAAI,OAAO,kBAAkB,KAAK,SAAS,EAAE;QAC3C,MAAM,IAAI,kBAAkB,CAAC,yCAAyC,CAAC,CAAC;KACzE;AACH,CAAC"}
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "react-markdown-table-ts",
|
3
|
-
"version": "0.
|
3
|
+
"version": "0.3.1",
|
4
4
|
"description": "A React component that converts structured data into Markdown table syntax and displays it within a `<pre>` tag.",
|
5
5
|
"main": "dist/index.cjs.js",
|
6
6
|
"module": "dist/index.esm.js",
|
@@ -56,6 +56,7 @@
|
|
56
56
|
"@types/react": "^18.3.8",
|
57
57
|
"@types/react-dom": "^18.3.0",
|
58
58
|
"gts": "^5.3.1",
|
59
|
+
"identity-obj-proxy": "^3.0.0",
|
59
60
|
"jest": "^29.7.0",
|
60
61
|
"jest-environment-jsdom": "^29.7.0",
|
61
62
|
"react": "^18.2.0",
|