react-markdown-table-ts 0.3.5 → 0.3.7
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/dist/index.cjs.js +39 -34
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +39 -34
- package/dist/index.esm.js.map +1 -1
- package/dist/jest.setup.d.ts +2 -0
- package/dist/jest.setup.js +3 -0
- package/dist/jest.setup.js.map +1 -0
- package/dist/src/index.d.ts +5 -0
- package/dist/src/index.js +62 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/types.d.ts +56 -0
- package/dist/src/types.js +3 -0
- package/dist/src/types.js.map +1 -0
- package/dist/src/utils.d.ts +58 -0
- package/dist/src/utils.js +179 -0
- package/dist/src/utils.js.map +1 -0
- package/dist/src/validation.d.ts +13 -0
- package/dist/src/validation.js +93 -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/utils.test.d.ts +1 -0
- package/dist/test/utils.test.js +238 -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 +86 -0
- package/dist/test/validation.test.js.map +1 -0
- package/dist/types.d.ts +6 -6
- package/dist/utils.d.ts +7 -12
- package/package.json +4 -4
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["../jest.setup.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,wBAAwB,CAAC"}
|
@@ -0,0 +1,62 @@
|
|
1
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
2
|
+
// src/index.tsx
|
3
|
+
import { useEffect, useMemo, useRef } from 'react';
|
4
|
+
import Prism from 'prismjs';
|
5
|
+
import 'prismjs/components/prism-markdown';
|
6
|
+
import 'prismjs/plugins/line-numbers/prism-line-numbers';
|
7
|
+
import { MarkdownTableError } from './validation';
|
8
|
+
import { generateMarkdownTableString, generateAlphabetHeaders } from './utils';
|
9
|
+
// CSS styles
|
10
|
+
var PRISM_CSS = "\ncode[class*=language-],pre[class*=language-]{color:#000;background:0 0;text-shadow:0 1px #fff;font-family:Consolas,Monaco,\"Andale Mono\",\"Ubuntu Mono\",monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}code[class*=language-] ::-moz-selection,code[class*=language-]::-moz-selection,pre[class*=language-] ::-moz-selection,pre[class*=language-]::-moz-selection{text-shadow:none;background:#b3d4fc}code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}@media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}pre[class*=language-].line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}pre[class*=language-].line-numbers>code{position:relative;white-space:inherit}.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}\n";
|
11
|
+
export var MarkdownTable = function (_a) {
|
12
|
+
var _b = _a.inputData, inputData = _b === void 0 ? null : _b, _c = _a.hasHeader, hasHeader = _c === void 0 ? true : _c, _d = _a.columnAlignments, columnAlignments = _d === void 0 ? [] : _d, _e = _a.isCompact, isCompact = _e === void 0 ? false : _e, _f = _a.hasTabs, hasTabs = _f === void 0 ? false : _f, _g = _a.canReplaceNewlines, canReplaceNewlines = _g === void 0 ? false : _g, className = _a.className, onTableCreate = _a.onTableCreate;
|
13
|
+
var adjustColumnWidths = !isCompact;
|
14
|
+
var preElementRef = useRef(null);
|
15
|
+
var markdownTableSyntax = useMemo(function () {
|
16
|
+
if (inputData === null) {
|
17
|
+
return 'Error: No data provided for the table.';
|
18
|
+
}
|
19
|
+
try {
|
20
|
+
if (!Array.isArray(inputData) || inputData.length === 0) {
|
21
|
+
throw new MarkdownTableError("The 'data' prop must be a non-empty two-dimensional array.");
|
22
|
+
}
|
23
|
+
var tableData = hasHeader
|
24
|
+
? {
|
25
|
+
inputTableHeader: inputData[0],
|
26
|
+
inputTableBody: inputData.slice(1),
|
27
|
+
}
|
28
|
+
: {
|
29
|
+
inputTableHeader: generateAlphabetHeaders(inputData[0].length),
|
30
|
+
inputTableBody: inputData,
|
31
|
+
};
|
32
|
+
return generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, hasTabs, canReplaceNewlines);
|
33
|
+
}
|
34
|
+
catch (error) {
|
35
|
+
if (error instanceof MarkdownTableError) {
|
36
|
+
return "Error: ".concat(error.message);
|
37
|
+
}
|
38
|
+
else {
|
39
|
+
throw error;
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}, [
|
43
|
+
inputData,
|
44
|
+
hasHeader,
|
45
|
+
columnAlignments,
|
46
|
+
isCompact,
|
47
|
+
hasTabs,
|
48
|
+
canReplaceNewlines,
|
49
|
+
]);
|
50
|
+
useEffect(function () {
|
51
|
+
if (onTableCreate) {
|
52
|
+
onTableCreate(markdownTableSyntax);
|
53
|
+
}
|
54
|
+
}, [markdownTableSyntax, onTableCreate]);
|
55
|
+
useEffect(function () {
|
56
|
+
if (preElementRef.current) {
|
57
|
+
Prism.highlightElement(preElementRef.current.querySelector('code'));
|
58
|
+
}
|
59
|
+
}, [markdownTableSyntax]);
|
60
|
+
return (_jsxs(_Fragment, { children: [_jsx("style", { children: PRISM_CSS }), _jsx("pre", { ref: preElementRef, className: "".concat(className, " language-markdown line-numbers"), children: _jsx("code", { className: "language-markdown", role: "code", children: markdownTableSyntax }) })] }));
|
61
|
+
};
|
62
|
+
//# sourceMappingURL=index.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":";AAAA,gBAAgB;AAEhB,OAAc,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,mCAAmC,CAAC;AAC3C,OAAO,iDAAiD,CAAC;AAEzD,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAChD,OAAO,EAAC,2BAA2B,EAAE,uBAAuB,EAAC,MAAM,SAAS,CAAC;AAC7E,aAAa;AACb,IAAM,SAAS,GAAG,koDAEjB,CAAC;AAEF,MAAM,CAAC,IAAM,aAAa,GAAiC,UAAC,EAS3D;QARC,iBAAgB,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,iBAAgB,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,wBAAqB,EAArB,gBAAgB,mBAAG,EAAE,KAAA,EACrB,iBAAiB,EAAjB,SAAS,mBAAG,KAAK,KAAA,EACjB,eAAe,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,0BAA0B,EAA1B,kBAAkB,mBAAG,KAAK,KAAA,EAC1B,SAAS,eAAA,EACT,aAAa,mBAAA;IAEb,IAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC;IACtC,IAAM,aAAa,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAEnD,IAAM,mBAAmB,GAAG,OAAO,CAAC;QAClC,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,OAAO,wCAAwC,CAAC;SACjD;QACD,IAAI;YACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvD,MAAM,IAAI,kBAAkB,CAC1B,4DAA4D,CAC7D,CAAC;aACH;YAED,IAAM,SAAS,GAAG,SAAS;gBACzB,CAAC,CAAC;oBACE,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC;oBAC9B,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;iBACnC;gBACH,CAAC,CAAC;oBACE,gBAAgB,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBAC9D,cAAc,EAAE,SAAS;iBAC1B,CAAC;YAEN,OAAO,2BAA2B,CAChC,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,kBAAkB,CACnB,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,kBAAkB,EAAE;gBACvC,OAAO,iBAAU,KAAK,CAAC,OAAO,CAAE,CAAC;aAClC;iBAAM;gBACL,MAAM,KAAK,CAAC;aACb;SACF;IACH,CAAC,EAAE;QACD,SAAS;QACT,SAAS;QACT,gBAAgB;QAChB,SAAS;QACT,OAAO;QACP,kBAAkB;KACnB,CAAC,CAAC;IAEH,SAAS,CAAC;QACR,IAAI,aAAa,EAAE;YACjB,aAAa,CAAC,mBAAmB,CAAC,CAAC;SACpC;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;IAEzC,SAAS,CAAC;QACR,IAAI,aAAa,CAAC,OAAO,EAAE;YACzB,KAAK,CAAC,gBAAgB,CACpB,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAgB,CAC3D,CAAC;SACH;IACH,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE1B,OAAO,CACL,8BACE,0BAAQ,SAAS,GAAS,EAC1B,cACE,GAAG,EAAE,aAAa,EAClB,SAAS,EAAE,UAAG,SAAS,oCAAiC,YAExD,eAAM,SAAS,EAAC,mBAAmB,EAAC,IAAI,EAAC,MAAM,YAC5C,mBAAmB,GACf,GACH,IACL,CACJ,CAAC;AACJ,CAAC,CAAC"}
|
@@ -0,0 +1,56 @@
|
|
1
|
+
/**
|
2
|
+
* Represents a single row of data in the input table, consisting of cells.
|
3
|
+
*/
|
4
|
+
export type InputTableRowData = readonly string[];
|
5
|
+
/**
|
6
|
+
* Represents the structure of the input table.
|
7
|
+
*/
|
8
|
+
export interface InputTableData {
|
9
|
+
inputTableHeader: string[];
|
10
|
+
inputTableBody: readonly string[][];
|
11
|
+
}
|
12
|
+
/**
|
13
|
+
* Props for the MarkdownTable component.
|
14
|
+
*/
|
15
|
+
export interface MarkdownTableProps {
|
16
|
+
/**
|
17
|
+
* The entire table data as a two-dimensional array.
|
18
|
+
* If `hasHeader` is true, the first row is treated as the header.
|
19
|
+
* @default null
|
20
|
+
*/
|
21
|
+
inputData?: string[][] | null;
|
22
|
+
/**
|
23
|
+
* Indicates whether the first row of `data` is a header.
|
24
|
+
* @default true
|
25
|
+
*/
|
26
|
+
hasHeader?: boolean;
|
27
|
+
/**
|
28
|
+
* Optional array specifying the alignment for each column.
|
29
|
+
* Acceptable values are 'left', 'center', 'right', or 'none'.
|
30
|
+
*/
|
31
|
+
columnAlignments?: readonly ('left' | 'center' | 'right' | 'none')[];
|
32
|
+
/**
|
33
|
+
* Optional flag to provide a compact version of the table with minimal column widths.
|
34
|
+
* When `true`, column widths are not adjusted based on content.
|
35
|
+
* @default false
|
36
|
+
*/
|
37
|
+
isCompact?: boolean;
|
38
|
+
/**
|
39
|
+
* Optional flag to add tabs between columns in the Markdown table.
|
40
|
+
* @default false
|
41
|
+
*/
|
42
|
+
hasTabs?: boolean;
|
43
|
+
/**
|
44
|
+
* Optional CSS class for styling the rendered Markdown table.
|
45
|
+
*/
|
46
|
+
className?: string;
|
47
|
+
/**
|
48
|
+
* Optional flag to replace newlines with <br> tags in table cells.
|
49
|
+
* @default false
|
50
|
+
*/
|
51
|
+
canReplaceNewlines?: boolean;
|
52
|
+
/**
|
53
|
+
* Optional callback function to receive the generated Markdown table string.
|
54
|
+
*/
|
55
|
+
onTableCreate?: (markdownTableString: string) => void;
|
56
|
+
}
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,eAAe"}
|
@@ -0,0 +1,58 @@
|
|
1
|
+
import { InputTableData, InputTableRowData } from './types';
|
2
|
+
/**
|
3
|
+
* Calculates the maximum width for each column based on the content.
|
4
|
+
* @param inputDataRows - All rows (header and body) of the input table.
|
5
|
+
* @param maxColumnCount - The maximum number of columns in the input table.
|
6
|
+
* @param minWidth - The minimum width for each column. Defaults to 3.
|
7
|
+
* @returns An array of maximum widths for each column.
|
8
|
+
*/
|
9
|
+
export declare function calculateColumnWidths(inputDataRows: readonly InputTableRowData[], maxColumnCount: number, minWidth?: number): number[];
|
10
|
+
/**
|
11
|
+
* Formats a single row into a Markdown-formatted string.
|
12
|
+
* @param columnCount - The number of columns in the table.
|
13
|
+
* @param currentRow - The data of the current row.
|
14
|
+
* @param columnAlignments - Alignment settings for each column.
|
15
|
+
* @param columnWidths - Widths of each column.
|
16
|
+
* @param useTabs - Flag to use tabs between columns.
|
17
|
+
* @param canReplaceNewlines - Flag to replace newlines with <br> tags.
|
18
|
+
* @returns The Markdown string for the row.
|
19
|
+
*/
|
20
|
+
export declare function formatMarkdownRow(columnCount: number, currentRow: InputTableRowData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, canReplaceNewlines?: boolean): string;
|
21
|
+
/**
|
22
|
+
* Generates the alignment row for the Markdown table syntax.
|
23
|
+
* @param columnCount - The number of columns in the table.
|
24
|
+
* @param columnAlignments - Alignment settings for each column.
|
25
|
+
* @param columnWidths - Widths of each column.
|
26
|
+
* @param useTabs - Flag to use tabs between columns.
|
27
|
+
* @returns The Markdown string for the alignment row.
|
28
|
+
*/
|
29
|
+
export declare function formatAlignmentRow(columnCount: number, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean): string;
|
30
|
+
/**
|
31
|
+
* Generates a complete Markdown table string from the provided data.
|
32
|
+
* @param inputData - The table data including headers and rows.
|
33
|
+
* @param columnAlignments - Alignment settings for each column.
|
34
|
+
* @param canAdjustColumnWidths - Flag to adjust column widths based on content.
|
35
|
+
* @param useTabs - Flag to use tabs between columns.
|
36
|
+
* @param replaceNewlines - Flag to replace newlines with <br> tags.
|
37
|
+
* @returns The complete Markdown table string.
|
38
|
+
*/
|
39
|
+
export declare function generateMarkdownTableString(inputData: InputTableData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean): string;
|
40
|
+
/**
|
41
|
+
* Replaces newline characters in a string with <br> tags.
|
42
|
+
* @param cell - The cell content to process.
|
43
|
+
* @returns The processed cell content with newlines replaced.
|
44
|
+
*/
|
45
|
+
export declare function replaceNewlinesInCell(cell: string): string;
|
46
|
+
/**
|
47
|
+
* Converts a zero-based column index to its corresponding Excel-style column name.
|
48
|
+
* For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.
|
49
|
+
* @param index - The zero-based column index.
|
50
|
+
* @returns The corresponding column name.
|
51
|
+
*/
|
52
|
+
export declare function getColumnName(index: number): string;
|
53
|
+
/**
|
54
|
+
* Generates an array of alphabetic headers based on the specified column count.
|
55
|
+
* @param columnCount - The number of columns.
|
56
|
+
* @returns An array of column header names.
|
57
|
+
*/
|
58
|
+
export declare function generateAlphabetHeaders(columnCount: number): string[];
|
@@ -0,0 +1,179 @@
|
|
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 inputDataRows - All rows (header and body) of the input table.
|
14
|
+
* @param maxColumnCount - The maximum number of columns in the input table.
|
15
|
+
* @param minWidth - The minimum width for each column. Defaults to 3.
|
16
|
+
* @returns An array of maximum widths for each column.
|
17
|
+
*/
|
18
|
+
export function calculateColumnWidths(inputDataRows, maxColumnCount, minWidth) {
|
19
|
+
if (minWidth === void 0) { minWidth = 3; }
|
20
|
+
// Initialize column widths with the minimum width.
|
21
|
+
var columnWidths = Array.from({ length: maxColumnCount }, function () { return minWidth; });
|
22
|
+
// Iterate over each row in the input data.
|
23
|
+
for (var _i = 0, inputDataRows_1 = inputDataRows; _i < inputDataRows_1.length; _i++) {
|
24
|
+
var currentRow = inputDataRows_1[_i];
|
25
|
+
// Iterate over each column index up to maxColumnCount.
|
26
|
+
for (var columnIndex = 0; columnIndex < maxColumnCount; columnIndex++) {
|
27
|
+
// Retrieve the cell value; default to an empty string if undefined or null.
|
28
|
+
var cellValue = currentRow[columnIndex];
|
29
|
+
var cellString = cellValue !== null && cellValue !== undefined ? String(cellValue) : '';
|
30
|
+
// Update the column width if the current cell's length is greater.
|
31
|
+
if (cellString.length > columnWidths[columnIndex]) {
|
32
|
+
columnWidths[columnIndex] = cellString.length;
|
33
|
+
}
|
34
|
+
}
|
35
|
+
}
|
36
|
+
return columnWidths;
|
37
|
+
}
|
38
|
+
/**
|
39
|
+
* Formats a single row into a Markdown-formatted string.
|
40
|
+
* @param columnCount - The number of columns in the table.
|
41
|
+
* @param currentRow - The data of the current row.
|
42
|
+
* @param columnAlignments - Alignment settings for each column.
|
43
|
+
* @param columnWidths - Widths of each column.
|
44
|
+
* @param useTabs - Flag to use tabs between columns.
|
45
|
+
* @param canReplaceNewlines - Flag to replace newlines with <br> tags.
|
46
|
+
* @returns The Markdown string for the row.
|
47
|
+
*/
|
48
|
+
export function formatMarkdownRow(columnCount, currentRow, columnAlignments, columnWidths, useTabs, canReplaceNewlines) {
|
49
|
+
var _a, _b;
|
50
|
+
if (useTabs === void 0) { useTabs = false; }
|
51
|
+
if (canReplaceNewlines === void 0) { canReplaceNewlines = false; }
|
52
|
+
var defaultAlignment = 'left';
|
53
|
+
var adjustedAlignments = columnAlignments.length < columnCount
|
54
|
+
? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
|
55
|
+
var markdownRow = '|';
|
56
|
+
for (var i = 0; i < columnCount; i++) {
|
57
|
+
var cell = (_a = currentRow[i]) !== null && _a !== void 0 ? _a : '';
|
58
|
+
if (canReplaceNewlines) {
|
59
|
+
cell = replaceNewlinesInCell(cell);
|
60
|
+
}
|
61
|
+
var alignment = (_b = adjustedAlignments[i]) !== null && _b !== void 0 ? _b : defaultAlignment;
|
62
|
+
var targetWidth = columnWidths ? columnWidths[i] : cell.length;
|
63
|
+
if (alignment === 'right') {
|
64
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padStart(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
|
65
|
+
}
|
66
|
+
else if (alignment === 'center') {
|
67
|
+
var totalPadding = targetWidth - cell.length;
|
68
|
+
var paddingLeft = Math.floor(totalPadding / 2);
|
69
|
+
var paddingRight = totalPadding - paddingLeft;
|
70
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(' '.repeat(paddingLeft)).concat(cell).concat(' '.repeat(paddingRight)).concat(useTabs ? '\t' : ' ', "|");
|
71
|
+
}
|
72
|
+
else {
|
73
|
+
// Left alignment or default
|
74
|
+
markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padEnd(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
|
75
|
+
}
|
76
|
+
}
|
77
|
+
return markdownRow;
|
78
|
+
}
|
79
|
+
/**
|
80
|
+
* Generates the alignment row for the Markdown table syntax.
|
81
|
+
* @param columnCount - The number of columns in the table.
|
82
|
+
* @param columnAlignments - Alignment settings for each column.
|
83
|
+
* @param columnWidths - Widths of each column.
|
84
|
+
* @param useTabs - Flag to use tabs between columns.
|
85
|
+
* @returns The Markdown string for the alignment row.
|
86
|
+
*/
|
87
|
+
export function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs) {
|
88
|
+
var _a;
|
89
|
+
if (useTabs === void 0) { useTabs = false; }
|
90
|
+
var defaultAlignment = 'left';
|
91
|
+
var adjustedAlignments = columnAlignments.length < columnCount
|
92
|
+
? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
|
93
|
+
var alignmentRow = '|';
|
94
|
+
for (var i = 0; i < columnCount; i++) {
|
95
|
+
var alignment = (_a = adjustedAlignments[i]) !== null && _a !== void 0 ? _a : defaultAlignment;
|
96
|
+
var targetWidth = columnWidths ? columnWidths[i] : 3;
|
97
|
+
var alignIndicator = '';
|
98
|
+
switch (alignment) {
|
99
|
+
case 'left':
|
100
|
+
alignIndicator = ":".concat('-'.repeat(targetWidth - 1));
|
101
|
+
break;
|
102
|
+
case 'center':
|
103
|
+
alignIndicator = ":".concat('-'.repeat(targetWidth - 2), ":");
|
104
|
+
break;
|
105
|
+
case 'right':
|
106
|
+
alignIndicator = "".concat('-'.repeat(targetWidth - 1), ":");
|
107
|
+
break;
|
108
|
+
default:
|
109
|
+
alignIndicator = "".concat('-'.repeat(targetWidth));
|
110
|
+
break;
|
111
|
+
}
|
112
|
+
alignmentRow += "".concat(useTabs ? '\t' : ' ').concat(alignIndicator).concat(useTabs ? '\t' : ' ', "|");
|
113
|
+
}
|
114
|
+
return alignmentRow;
|
115
|
+
}
|
116
|
+
/**
|
117
|
+
* Generates a complete Markdown table string from the provided data.
|
118
|
+
* @param inputData - The table data including headers and rows.
|
119
|
+
* @param columnAlignments - Alignment settings for each column.
|
120
|
+
* @param canAdjustColumnWidths - Flag to adjust column widths based on content.
|
121
|
+
* @param useTabs - Flag to use tabs between columns.
|
122
|
+
* @param replaceNewlines - Flag to replace newlines with <br> tags.
|
123
|
+
* @returns The complete Markdown table string.
|
124
|
+
*/
|
125
|
+
export function generateMarkdownTableString(inputData, columnAlignments, canAdjustColumnWidths, useTabs, replaceNewlines) {
|
126
|
+
if (canAdjustColumnWidths === void 0) { canAdjustColumnWidths = true; }
|
127
|
+
if (useTabs === void 0) { useTabs = false; }
|
128
|
+
if (replaceNewlines === void 0) { replaceNewlines = false; }
|
129
|
+
var headerColumnCount = inputData.inputTableHeader.length;
|
130
|
+
var bodyColumnCounts = inputData.inputTableBody.map(function (currentRow) { return currentRow.length; });
|
131
|
+
var maxColumnCount = Math.max.apply(Math, __spreadArray([headerColumnCount], bodyColumnCounts, false));
|
132
|
+
var columnWidths = canAdjustColumnWidths
|
133
|
+
? calculateColumnWidths(__spreadArray([inputData.inputTableHeader], inputData.inputTableBody, true), maxColumnCount)
|
134
|
+
: undefined;
|
135
|
+
var markdownHeaderRow = formatMarkdownRow(maxColumnCount, inputData.inputTableHeader, columnAlignments, columnWidths, useTabs, replaceNewlines);
|
136
|
+
var markdownAlignmentRow = formatAlignmentRow(maxColumnCount, columnAlignments, columnWidths, useTabs);
|
137
|
+
var markdownBodyRows = inputData.inputTableBody
|
138
|
+
.map(function (currentRow) {
|
139
|
+
return formatMarkdownRow(maxColumnCount, currentRow, columnAlignments, columnWidths, useTabs, replaceNewlines);
|
140
|
+
})
|
141
|
+
.join('\n');
|
142
|
+
return "".concat(markdownHeaderRow, "\n").concat(markdownAlignmentRow, "\n").concat(markdownBodyRows).trimEnd();
|
143
|
+
}
|
144
|
+
/**
|
145
|
+
* Replaces newline characters in a string with <br> tags.
|
146
|
+
* @param cell - The cell content to process.
|
147
|
+
* @returns The processed cell content with newlines replaced.
|
148
|
+
*/
|
149
|
+
export function replaceNewlinesInCell(cell) {
|
150
|
+
return cell.replace(/\n/g, '<br>');
|
151
|
+
}
|
152
|
+
/**
|
153
|
+
* Converts a zero-based column index to its corresponding Excel-style column name.
|
154
|
+
* For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.
|
155
|
+
* @param index - The zero-based column index.
|
156
|
+
* @returns The corresponding column name.
|
157
|
+
*/
|
158
|
+
export function getColumnName(index) {
|
159
|
+
var columnName = '';
|
160
|
+
var currentIndex = index;
|
161
|
+
while (currentIndex >= 0) {
|
162
|
+
columnName = String.fromCharCode((currentIndex % 26) + 65) + columnName;
|
163
|
+
currentIndex = Math.floor(currentIndex / 26) - 1;
|
164
|
+
}
|
165
|
+
return columnName;
|
166
|
+
}
|
167
|
+
/**
|
168
|
+
* Generates an array of alphabetic headers based on the specified column count.
|
169
|
+
* @param columnCount - The number of columns.
|
170
|
+
* @returns An array of column header names.
|
171
|
+
*/
|
172
|
+
export function generateAlphabetHeaders(columnCount) {
|
173
|
+
var alphabetHeaders = [];
|
174
|
+
for (var i = 0; i < columnCount; i++) {
|
175
|
+
alphabetHeaders.push(getColumnName(i));
|
176
|
+
}
|
177
|
+
return alphabetHeaders;
|
178
|
+
}
|
179
|
+
//# sourceMappingURL=utils.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAe;;;;;;;;;;AAIf;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,aAA2C,EAC3C,cAAsB,EACtB,QAAY;IAAZ,yBAAA,EAAA,YAAY;IAEZ,mDAAmD;IACnD,IAAM,YAAY,GAAa,KAAK,CAAC,IAAI,CACvC,EAAC,MAAM,EAAE,cAAc,EAAC,EACxB,cAAM,OAAA,QAAQ,EAAR,CAAQ,CACf,CAAC;IAEF,2CAA2C;IAC3C,KAAyB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE;QAAnC,IAAM,UAAU,sBAAA;QACnB,uDAAuD;QACvD,KAAK,IAAI,WAAW,GAAG,CAAC,EAAE,WAAW,GAAG,cAAc,EAAE,WAAW,EAAE,EAAE;YACrE,4EAA4E;YAC5E,IAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;YAC1C,IAAM,UAAU,GACd,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEzE,mEAAmE;YACnE,IAAI,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE;gBACjD,YAAY,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC;aAC/C;SACF;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,UAA6B,EAC7B,gBAAmE,EACnE,YAAgC,EAChC,OAAe,EACf,kBAA0B;;IAD1B,wBAAA,EAAA,eAAe;IACf,mCAAA,EAAA,0BAA0B;IAE1B,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,UAAU,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC/B,IAAI,kBAAkB,EAAE;YACtB,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,SAAyB,EACzB,gBAAmE,EACnE,qBAA4B,EAC5B,OAAe,EACf,eAAuB;IAFvB,sCAAA,EAAA,4BAA4B;IAC5B,wBAAA,EAAA,eAAe;IACf,gCAAA,EAAA,uBAAuB;IAEvB,IAAM,iBAAiB,GAAG,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;IAC5D,IAAM,gBAAgB,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CACnD,UAAC,UAA6B,IAAK,OAAA,UAAU,CAAC,MAAM,EAAjB,CAAiB,CACrD,CAAC;IACF,IAAM,cAAc,GAAG,IAAI,CAAC,GAAG,OAAR,IAAI,iBAAK,iBAAiB,GAAK,gBAAgB,SAAC,CAAC;IAExE,IAAM,YAAY,GAAG,qBAAqB;QACxC,CAAC,CAAC,qBAAqB,gBAClB,SAAS,CAAC,gBAAgB,GAAK,SAAS,CAAC,cAAc,SACxD,cAAc,CACf;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,IAAM,iBAAiB,GAAG,iBAAiB,CACzC,cAAc,EACd,SAAS,CAAC,gBAAgB,EAC1B,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,cAAc;SAC9C,GAAG,CAAC,UAAC,UAA6B;QACjC,OAAA,iBAAiB,CACf,cAAc,EACd,UAAU,EACV,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;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,OAAO,YAAY,IAAI,CAAC,EAAE;QACxB,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC;QACxE,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;KAClD;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,WAAmB;IACzD,IAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;KACxC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}
|
@@ -0,0 +1,13 @@
|
|
1
|
+
import { MarkdownTableProps } from './types';
|
2
|
+
/**
|
3
|
+
* Custom error class for handling Markdown table generation errors.
|
4
|
+
*/
|
5
|
+
export declare class MarkdownTableError extends Error {
|
6
|
+
constructor(message: string);
|
7
|
+
}
|
8
|
+
/**
|
9
|
+
* Validates the structure of the table data based on the `hasHeader` flag.
|
10
|
+
* Throws an error if validation fails.
|
11
|
+
* @param markdownTableProps - The props to validate.
|
12
|
+
*/
|
13
|
+
export declare function validateMarkdownTableProps(markdownTableProps: MarkdownTableProps): void;
|
@@ -0,0 +1,93 @@
|
|
1
|
+
// src/validation.ts
|
2
|
+
var __extends = (this && this.__extends) || (function () {
|
3
|
+
var extendStatics = function (d, b) {
|
4
|
+
extendStatics = Object.setPrototypeOf ||
|
5
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
6
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
7
|
+
return extendStatics(d, b);
|
8
|
+
};
|
9
|
+
return function (d, b) {
|
10
|
+
if (typeof b !== "function" && b !== null)
|
11
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
12
|
+
extendStatics(d, b);
|
13
|
+
function __() { this.constructor = d; }
|
14
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
15
|
+
};
|
16
|
+
})();
|
17
|
+
/**
|
18
|
+
* Custom error class for handling Markdown table generation errors.
|
19
|
+
*/
|
20
|
+
var MarkdownTableError = /** @class */ (function (_super) {
|
21
|
+
__extends(MarkdownTableError, _super);
|
22
|
+
function MarkdownTableError(message) {
|
23
|
+
var _this = _super.call(this, message) || this;
|
24
|
+
_this.name = 'MarkdownTableError';
|
25
|
+
Object.setPrototypeOf(_this, MarkdownTableError.prototype);
|
26
|
+
return _this;
|
27
|
+
}
|
28
|
+
return MarkdownTableError;
|
29
|
+
}(Error));
|
30
|
+
export { MarkdownTableError };
|
31
|
+
/**
|
32
|
+
* Validates the structure of the table data based on the `hasHeader` flag.
|
33
|
+
* Throws an error if validation fails.
|
34
|
+
* @param markdownTableProps - The props to validate.
|
35
|
+
*/
|
36
|
+
export function validateMarkdownTableProps(markdownTableProps) {
|
37
|
+
var inputData = markdownTableProps.inputData, _a = markdownTableProps.hasHeader, hasHeader = _a === void 0 ? true : _a, columnAlignments = markdownTableProps.columnAlignments, _b = markdownTableProps.isCompact, isCompact = _b === void 0 ? false : _b, _c = markdownTableProps.hasTabs, hasTabs = _c === void 0 ? false : _c, _d = markdownTableProps.canReplaceNewlines, canReplaceNewlines = _d === void 0 ? false : _d;
|
38
|
+
if (!Array.isArray(inputData)) {
|
39
|
+
throw new MarkdownTableError("The 'data' prop must be a two-dimensional array.");
|
40
|
+
}
|
41
|
+
if (inputData.length === 0) {
|
42
|
+
throw new MarkdownTableError("The 'data' array must contain at least one row.");
|
43
|
+
}
|
44
|
+
// If hasHeader is true, ensure the first row exists and is valid
|
45
|
+
if (hasHeader) {
|
46
|
+
var header = inputData[0];
|
47
|
+
if (!Array.isArray(header) || header.length === 0) {
|
48
|
+
throw new MarkdownTableError("The first row of 'data' must be a non-empty array representing the header.");
|
49
|
+
}
|
50
|
+
// Validate each header cell is a string
|
51
|
+
header.forEach(function (cell, index) {
|
52
|
+
if (typeof cell !== 'string') {
|
53
|
+
throw new MarkdownTableError("Header cell at index ".concat(index, " must be a string."));
|
54
|
+
}
|
55
|
+
});
|
56
|
+
}
|
57
|
+
// Validate each row
|
58
|
+
inputData.forEach(function (row, rowIndex) {
|
59
|
+
if (!Array.isArray(row)) {
|
60
|
+
throw new MarkdownTableError("Row ".concat(rowIndex + 1, " in 'data' must be an array of strings."));
|
61
|
+
}
|
62
|
+
row.forEach(function (cell, cellIndex) {
|
63
|
+
if (typeof cell !== 'string') {
|
64
|
+
throw new MarkdownTableError("Cell at row ".concat(rowIndex + 1, ", column ").concat(cellIndex + 1, " must be a string."));
|
65
|
+
}
|
66
|
+
});
|
67
|
+
});
|
68
|
+
// Validate columnAlignments if provided
|
69
|
+
if (columnAlignments) {
|
70
|
+
if (!Array.isArray(columnAlignments)) {
|
71
|
+
throw new MarkdownTableError("'columnAlignments' must be an array of alignment strings.");
|
72
|
+
}
|
73
|
+
var validAlignments_1 = ['left', 'center', 'right', 'none'];
|
74
|
+
columnAlignments.forEach(function (alignment, index) {
|
75
|
+
if (!validAlignments_1.includes(alignment)) {
|
76
|
+
throw new MarkdownTableError("Invalid alignment '".concat(alignment, "' at index ").concat(index, ". Valid options are 'left', 'center', 'right', 'none'."));
|
77
|
+
}
|
78
|
+
});
|
79
|
+
}
|
80
|
+
// Validate isCompact
|
81
|
+
if (typeof isCompact !== 'boolean') {
|
82
|
+
throw new MarkdownTableError("'isCompact' must be a boolean.");
|
83
|
+
}
|
84
|
+
// Validate hasTabs
|
85
|
+
if (typeof hasTabs !== 'boolean') {
|
86
|
+
throw new MarkdownTableError("'hasTabs' must be a boolean.");
|
87
|
+
}
|
88
|
+
// Validate canReplaceNewlines
|
89
|
+
if (typeof canReplaceNewlines !== 'boolean') {
|
90
|
+
throw new MarkdownTableError("'canReplaceNewlines' must be a boolean.");
|
91
|
+
}
|
92
|
+
}
|
93
|
+
//# sourceMappingURL=validation.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAAA,oBAAoB;;;;;;;;;;;;;;;;AAIpB;;GAEG;AACH;IAAwC,sCAAK;IAC3C,4BAAY,OAAe;QAA3B,YACE,kBAAM,OAAO,CAAC,SAGf;QAFC,KAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;;IAC5D,CAAC;IACH,yBAAC;AAAD,CAAC,AAND,CAAwC,KAAK,GAM5C;;AACD;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,kBAAsC;IAGpC,IAAA,SAAS,GAMP,kBAAkB,UANX,EACT,KAKE,kBAAkB,UALJ,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,gBAAgB,GAId,kBAAkB,iBAJJ,EAChB,KAGE,kBAAkB,UAHH,EAAjB,SAAS,mBAAG,KAAK,KAAA,EACjB,KAEE,kBAAkB,QAFL,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,KACE,kBAAkB,mBADM,EAA1B,kBAAkB,mBAAG,KAAK,KAAA,CACL;IAEvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,kDAAkD,CACnD,CAAC;KACH;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,MAAM,IAAI,kBAAkB,CAC1B,iDAAiD,CAClD,CAAC;KACH;IAED,iEAAiE;IACjE,IAAI,SAAS,EAAE;QACb,IAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,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,SAAS,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,QAAQ;QAC9B,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"}
|
@@ -0,0 +1 @@
|
|
1
|
+
import '@testing-library/jest-dom';
|
@@ -0,0 +1,91 @@
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
2
|
+
import { render, screen } from '@testing-library/react';
|
3
|
+
import { MarkdownTable } from '../src';
|
4
|
+
import '@testing-library/jest-dom';
|
5
|
+
describe('MarkdownTable', function () {
|
6
|
+
var sampleData = [
|
7
|
+
['Header 1', 'Header 2', 'Header 3'],
|
8
|
+
['Row 1, Col 1', 'Row 1, Col 2', 'Row 1, Col 3'],
|
9
|
+
['Row 2, Col 1', 'Row 2, Col 2', 'Row 2, Col 3'],
|
10
|
+
];
|
11
|
+
it('renders a compact table', function () {
|
12
|
+
render(_jsx(MarkdownTable, { inputData: sampleData, isCompact: true }));
|
13
|
+
var preElement = screen.getByText(/\| Header 1/);
|
14
|
+
expect(preElement).toBeInTheDocument();
|
15
|
+
expect(preElement.textContent).toContain('| Header 1 | Header 2 | Header 3 |');
|
16
|
+
expect(preElement.textContent).toContain('| :-- | :-- | :-- |');
|
17
|
+
expect(preElement.textContent).toContain('| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |');
|
18
|
+
expect(preElement.textContent).toContain('| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |');
|
19
|
+
});
|
20
|
+
it('replaces newlines with <br> tags when canReplaceNewlines is true', function () {
|
21
|
+
var dataWithNewlines = [
|
22
|
+
['Header 1', 'Header 2'],
|
23
|
+
['Line 1\nLine 2', 'Single line'],
|
24
|
+
['Single line', 'Line 1\nLine 2\nLine 3'],
|
25
|
+
];
|
26
|
+
render(_jsx(MarkdownTable, { inputData: dataWithNewlines, canReplaceNewlines: true }));
|
27
|
+
var preElement = screen.getByRole('code');
|
28
|
+
expect(preElement).toBeInTheDocument();
|
29
|
+
expect(preElement).toHaveTextContent('Header 1');
|
30
|
+
expect(preElement).toHaveTextContent('Header 2');
|
31
|
+
expect(preElement).toHaveTextContent('Line 1<br>Line 2');
|
32
|
+
expect(preElement).toHaveTextContent('Line 1<br>Line 2<br>Line 3');
|
33
|
+
});
|
34
|
+
it('calls onTableCreate with the correct Markdown string', function () {
|
35
|
+
var sampleData = [
|
36
|
+
['Header 1', 'Header 2'],
|
37
|
+
['Row 1, Col 1', 'Row 1, Col 2'],
|
38
|
+
['Row 2, Col 1', 'Row 2, Col 2'],
|
39
|
+
];
|
40
|
+
var mockOnTableCreate = jest.fn();
|
41
|
+
render(_jsx(MarkdownTable, { inputData: sampleData, onTableCreate: mockOnTableCreate }));
|
42
|
+
var codeElement = screen.getByRole('code');
|
43
|
+
expect(codeElement).toBeInTheDocument();
|
44
|
+
// Check if onTableCreate was called
|
45
|
+
expect(mockOnTableCreate).toHaveBeenCalledTimes(1);
|
46
|
+
// Check if onTableCreate was called with the correct Markdown string
|
47
|
+
var expectedMarkdown = "| Header 1 | Header 2 |\n| :----------- | :----------- |\n| Row 1, Col 1 | Row 1, Col 2 |\n| Row 2, Col 1 | Row 2, Col 2 |";
|
48
|
+
expect(mockOnTableCreate).toHaveBeenCalledWith(expectedMarkdown);
|
49
|
+
// Check the rendered content
|
50
|
+
expect(codeElement).toHaveTextContent('Header 1');
|
51
|
+
expect(codeElement).toHaveTextContent('Header 2');
|
52
|
+
expect(codeElement).toHaveTextContent('Row 1, Col 1');
|
53
|
+
expect(codeElement).toHaveTextContent('Row 1, Col 2');
|
54
|
+
expect(codeElement).toHaveTextContent('Row 2, Col 1');
|
55
|
+
expect(codeElement).toHaveTextContent('Row 2, Col 2');
|
56
|
+
});
|
57
|
+
it('calls onTableCreate when props change', function () {
|
58
|
+
var sampleData = [
|
59
|
+
['Header 1', 'Header 2'],
|
60
|
+
['Row 1, Col 1', 'Row 1, Col 2'],
|
61
|
+
];
|
62
|
+
var mockOnTableCreate = jest.fn();
|
63
|
+
var rerender = render(_jsx(MarkdownTable, { inputData: sampleData, onTableCreate: mockOnTableCreate })).rerender;
|
64
|
+
expect(mockOnTableCreate).toHaveBeenCalledTimes(1);
|
65
|
+
// Change a prop and re-render
|
66
|
+
var newData = [
|
67
|
+
['New Header 1', 'New Header 2'],
|
68
|
+
['New Row 1, Col 1', 'New Row 1, Col 2'],
|
69
|
+
];
|
70
|
+
rerender(_jsx(MarkdownTable, { inputData: newData, onTableCreate: mockOnTableCreate }));
|
71
|
+
// Check if onTableCreate was called again
|
72
|
+
expect(mockOnTableCreate).toHaveBeenCalledTimes(2);
|
73
|
+
// Check if onTableCreate was called with the new Markdown string
|
74
|
+
var expectedNewMarkdown = "| New Header 1 | New Header 2 |\n| :--------------- | :--------------- |\n| New Row 1, Col 1 | New Row 1, Col 2 |";
|
75
|
+
expect(mockOnTableCreate).toHaveBeenLastCalledWith(expectedNewMarkdown);
|
76
|
+
});
|
77
|
+
it('renders the table with correct markdown syntax', function () {
|
78
|
+
render(_jsx(MarkdownTable, { inputData: sampleData }));
|
79
|
+
var codeElement = screen.getByRole('code');
|
80
|
+
expect(codeElement).toHaveTextContent('Header 1');
|
81
|
+
expect(codeElement).toHaveTextContent('Header 2');
|
82
|
+
expect(codeElement).toHaveTextContent('Header 3');
|
83
|
+
expect(codeElement).toHaveTextContent('Row 1, Col 1');
|
84
|
+
expect(codeElement).toHaveTextContent('Row 1, Col 2');
|
85
|
+
expect(codeElement).toHaveTextContent('Row 1, Col 3');
|
86
|
+
expect(codeElement).toHaveTextContent('Row 2, Col 1');
|
87
|
+
expect(codeElement).toHaveTextContent('Row 2, Col 2');
|
88
|
+
expect(codeElement).toHaveTextContent('Row 2, Col 3');
|
89
|
+
});
|
90
|
+
});
|
91
|
+
//# sourceMappingURL=MarkdownTable.test.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"MarkdownTable.test.js","sourceRoot":"","sources":["../../test/MarkdownTable.test.tsx"],"names":[],"mappings":";AACA,OAAO,EAAC,MAAM,EAAE,MAAM,EAAC,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAC;AACrC,OAAO,2BAA2B,CAAC;AAEnC,QAAQ,CAAC,eAAe,EAAE;IACxB,IAAM,UAAU,GAAG;QACjB,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,yBAAyB,EAAE;QAC5B,MAAM,CAAC,KAAC,aAAa,IAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,GAAI,CAAC,CAAC;QAClE,IAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACnD,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,SAAS,CACtC,oCAAoC,CACrC,CAAC;QACF,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAChE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,SAAS,CACtC,gDAAgD,CACjD,CAAC;QACF,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,SAAS,CACtC,gDAAgD,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE;QACrE,IAAM,gBAAgB,GAAG;YACvB,CAAC,UAAU,EAAE,UAAU,CAAC;YACxB,CAAC,gBAAgB,EAAE,aAAa,CAAC;YACjC,CAAC,aAAa,EAAE,wBAAwB,CAAC;SAC1C,CAAC;QAEF,MAAM,CACJ,KAAC,aAAa,IAAC,SAAS,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,IAAI,GAAI,CACzE,CAAC;QAEF,IAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE;QACzD,IAAM,UAAU,GAAG;YACjB,CAAC,UAAU,EAAE,UAAU,CAAC;YACxB,CAAC,cAAc,EAAE,cAAc,CAAC;YAChC,CAAC,cAAc,EAAE,cAAc,CAAC;SACjC,CAAC;QAEF,IAAM,iBAAiB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAEpC,MAAM,CACJ,KAAC,aAAa,IAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,iBAAiB,GAAI,CAC3E,CAAC;QAEF,IAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAExC,oCAAoC;QACpC,MAAM,CAAC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAEnD,qEAAqE;QACrE,IAAM,gBAAgB,GAAG,oIAGG,CAAC;QAE7B,MAAM,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;QAEjE,6BAA6B;QAC7B,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE;QAC1C,IAAM,UAAU,GAAG;YACjB,CAAC,UAAU,EAAE,UAAU,CAAC;YACxB,CAAC,cAAc,EAAE,cAAc,CAAC;SACjC,CAAC;QAEF,IAAM,iBAAiB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAE7B,IAAA,QAAQ,GAAI,MAAM,CACvB,KAAC,aAAa,IAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,iBAAiB,GAAI,CAC3E,SAFc,CAEb;QAEF,MAAM,CAAC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAEnD,8BAA8B;QAC9B,IAAM,OAAO,GAAG;YACd,CAAC,cAAc,EAAE,cAAc,CAAC;YAChC,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;SACzC,CAAC;QAEF,QAAQ,CACN,KAAC,aAAa,IAAC,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,iBAAiB,GAAI,CACxE,CAAC;QAEF,0CAA0C;QAC1C,MAAM,CAAC,iBAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAEnD,iEAAiE;QACjE,IAAM,mBAAmB,GAAG,2HAEQ,CAAC;QAErC,MAAM,CAAC,iBAAiB,CAAC,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE;QACnD,MAAM,CAAC,KAAC,aAAa,IAAC,SAAS,EAAE,UAAU,GAAI,CAAC,CAAC;QAEjD,IAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
@@ -0,0 +1 @@
|
|
1
|
+
export {};
|