react-markdown-table-ts 1.3.0 → 1.3.2

package/src/types.ts

@@ -1,138 +0,0 @@
-/**
- * @fileoverview Type definitions for the MarkdownTable component including props,
- * alignment options, and table configuration.
- */
-
-export interface InputData {
-  inputDataHeader: string[];
-  inputDataBody: readonly string[][];
-}
-
-export interface MarkdownTableProps {
-  /**
-   * The entire table data as a two-dimensional array.
-   * If `hasHeader` is true, the first row is treated as the header.
-   * @default null
-   */
-  inputData?: string[][] | null;
-
-  /**
-   * Optional array specifying the alignment for each column.
-   * Acceptable values are 'left', 'center', 'right', or 'none'.
-   * @default []
-   */
-  columnAlignments?: readonly Alignment[];
-
-  /**
-   * Disables column width alignment to provide a more compact markdown table string.
-   * @default false
-   */
-  isCompact?: boolean;
-
-  /**
-   * Optional flag to add a single space around cell content in the markdown table.
-   * When true, one space is added before and after the content in each cell.
-   * @default true
-   */
-  hasPadding?: boolean;
-
-  /**
-   * Optional flag to add tabs as additional padding between column pipes.
-   * When true, adds a tab character after each | and before the content.
-   * @default false
-   */
-  hasTabs?: boolean;
-  /**
-   * Indicates whether the first row of `data` is a header.
-   * @default true
-   */
-  hasHeader?: boolean;
-
-  /**
-   * Optional flag to replace newlines with <br> tags in table cells.
-   * @default false
-   */
-  convertLineBreaks?: boolean;
-
-  /**
-   * Optional theme for the Markdown table.
-   * Acceptable values are 'light' or 'dark'.
-   * @default 'light'
-   */
-  theme?: 'light' | 'dark'
-
-  /**
-   * Optional CSS class for styling the rendered Markdown table.
-   * This class will be applied to the <pre> element containing the table.
-   * It will be combined with built-in classes for syntax highlighting.
-   * @default undefined
-   * @example
-   * <MarkdownTable
-   *   inputData={data}
-   *   className="custom-table-style"
-   * />
-   */
-  className?: string;
-
-  /**
-   * Optional CSS properties to apply to the pre element containing the Markdown table.
-   * Allows direct styling of the table container using React's style prop.
-   * @default undefined
-   * @example
-   * <MarkdownTable
-   *   inputData={data}
-   *   preStyle={{
-   *     maxHeight: '300px',
-   *     overflow: 'auto',
-   *     backgroundColor: '#f5f5f5'
-   *   }}
-   * />
-   */
-  preStyle?: React.CSSProperties;
-
-  /**
-   * Optional callback function to receive the generated Markdown table string.
-   */
-  onGenerate?: (markdownTableString: string) => void;
-
-  /**
-   * Optional top padding for the pre element.
-   * @default 0
-   */
-  topPadding?: number;
-
-  /**
-   * Optional minimum width in pixels for the pre element containing the Markdown table.
-   * @default undefined
-   * @example
-   * <MarkdownTable
-   *   inputData={data}
-   *   minWidth={300}
-   * />
-   */
-  minWidth?: number;
-
-  /**
-   * Optional flag to show or hide line numbers in the Prism syntax highlighting.
-   * When true, line numbers are displayed on the left side of the code block.
-   * @default true
-   * @example
-   * <MarkdownTable
-   *   inputData={data}
-   *   showLineNumbers={false}
-   * />
-   */
-  showLineNumbers?: boolean;
-
-}
-
-export type Alignment = 'left' | 'right' | 'center' | 'none';
-
-export interface TableConfig {
-  columnCount: number;
-  columnAlignments: readonly Alignment[];
-  columnWidths?: readonly number[];
-  useTabs: boolean;
-  replaceNewlines: boolean;
-  hasPadding: boolean;
-}

package/src/utils.ts

@@ -1,180 +0,0 @@
-/**
- * @fileoverview Utility functions and classes for generating formatted markdown
- * table strings with alignment, padding, and column width adjustments.
- */
-
-import type { InputData, Alignment, TableConfig } from './types';
-
-type TableRow = readonly string[];
-
-function calculatePadding(config: TableConfig): string {
-  return config.useTabs ? '\t' : (config.hasPadding ? ' ' : '');
-}
-
-class CellFormatter {
-  private readonly padding: string;
-
-  constructor(config: TableConfig) {
-    this.padding = calculatePadding(config);
-  }
-
-  formatCell(content: string, alignment: Alignment, width: number): string {
-    const totalWidth = width;
-
-    switch (alignment) {
-      case 'right':
-        return `${this.padding}${content.padStart(totalWidth)}${this.padding}`;
-      case 'center': {
-        const totalPadding = totalWidth - content.length;
-        const paddingLeft = Math.floor(totalPadding / 2);
-        const paddingRight = totalPadding - paddingLeft;
-        return `${this.padding}${' '.repeat(paddingLeft)}${content}${' '.repeat(paddingRight)}${this.padding}`;
-      }
-      default: // left or none
-        return `${this.padding}${content.padEnd(totalWidth)}${this.padding}`;
-    }
-  }
-}
-
-class AlignmentFormatter {
-  private static readonly indicators = {
-    left: (width: number) => `:${'-'.repeat(width - 1)}`,
-    right: (width: number) => `${'-'.repeat(width - 1)}:`,
-    center: (width: number) => `:${'-'.repeat(width - 2)}:`,
-    none: (width: number) => '-'.repeat(width)
-  };
-
-  static formatIndicator(alignment: Alignment, width: number): string {
-    return this.indicators[alignment](width);
-  }
-}
-
-class TableFormatter {
-  private readonly config: TableConfig;
-  private readonly cellFormatter: CellFormatter;
-  private readonly adjustedAlignments: Alignment[];
-
-  constructor(config: TableConfig) {
-    this.config = config;
-    this.cellFormatter = new CellFormatter(config);
-    this.adjustedAlignments = this.getAdjustedAlignments();
-  }
-
-  private getAdjustedAlignments(): Alignment[] {
-    const defaultAlignment: Alignment = 'none';
-
-    return this.config.columnAlignments.length < this.config.columnCount
-      ? [
-          ...Array.from(this.config.columnAlignments),
-          ...Array(this.config.columnCount - this.config.columnAlignments.length).fill(defaultAlignment),
-        ]
-      : Array.from(this.config.columnAlignments);
-  }
-
-  formatRow(row: TableRow): string {
-    const formattedCells = Array.from({ length: this.config.columnCount }, (_, i) => {
-      let cell = row[i] ?? '';
-      if (this.config.replaceNewlines) {
-        cell = cell.replace(/\n/g, '<br>');
-      }
-      const alignment = this.adjustedAlignments[i];
-      const width = this.config.columnWidths ? this.config.columnWidths[i] : cell.length;
-
-      return this.cellFormatter.formatCell(cell, alignment, width);
-    });
-
-    return `|${formattedCells.join('|')}|`;
-  }
-
-  formatAlignmentRow(): string {
-    const padding = calculatePadding(this.config);
-    const formattedColumns = Array.from({ length: this.config.columnCount }, (_, i) => {
-      const alignment = this.adjustedAlignments[i];
-      const width = this.config.columnWidths ? this.config.columnWidths[i] : 3;
-      const indicator = AlignmentFormatter.formatIndicator(alignment, width);
-      return `${padding}${indicator}${padding}`;
-    });
-
-    return `|${formattedColumns.join('|')}|`;
-  }
-}
-
-function calculateColumnWidths(
-  tableRows: readonly TableRow[],
-  maxColumnCount: number
-): number[] {
-  const widths: number[] = new Array(maxColumnCount).fill(3);
-
-  tableRows.forEach((row: TableRow) => {
-    for (let i = 0; i < maxColumnCount; i++) {
-      const cell = row[i] ?? '';
-      widths[i] = Math.max(widths[i], cell.length);
-    }
-  });
-
-  return widths;
-}
-
-function calculateMaxColumnCount(inputData: InputData): number {
-  const headerColumnCount = inputData.inputDataHeader.length;
-  const bodyColumnCounts = inputData.inputDataBody.map(row => row.length);
-  return Math.max(headerColumnCount, ...bodyColumnCounts);
-}
-
-function getColumnWidths(
-  inputData: InputData,
-  maxColumnCount: number,
-  canAdjustColumnWidths: boolean
-): number[] | undefined {
-  return canAdjustColumnWidths
-    ? calculateColumnWidths(
-        [inputData.inputDataHeader, ...inputData.inputDataBody],
-        maxColumnCount
-      )
-    : undefined;
-}
-
-export function generateMarkdownTableString(
-  inputData: InputData,
-  columnAlignments: readonly Alignment[],
-  canAdjustColumnWidths = true,
-  useTabs = false,
-  replaceNewlines = false,
-  hasPadding = true
-): string {
-  const maxColumnCount = calculateMaxColumnCount(inputData);
-  const columnWidths = getColumnWidths(inputData, maxColumnCount, canAdjustColumnWidths);
-
-  const config: TableConfig = {
-    columnCount: maxColumnCount,
-    columnAlignments,
-    columnWidths,
-    useTabs,
-    replaceNewlines,
-    hasPadding
-  };
-
-  const tableFormatter = new TableFormatter(config);
-
-  const headerRow = tableFormatter.formatRow(inputData.inputDataHeader);
-  const alignmentRow = tableFormatter.formatAlignmentRow();
-  const bodyRows = inputData.inputDataBody
-    .map(row => tableFormatter.formatRow(row))
-    .join('\n');
-
-  return `${headerRow}\n${alignmentRow}\n${bodyRows}`.trimEnd();
-}
-
-function getColumnName(index: number): string {
-  let columnName = '';
-  let currentIndex = index;
-  while (currentIndex >= 0) {
-    columnName = String.fromCharCode((currentIndex % 26) + 65) + columnName;
-    currentIndex = Math.floor(currentIndex / 26) - 1;
-  }
-  return columnName;
-}
-
-export function generateAlphabetHeaders(columnCount: number): string[] {
-  return Array.from({ length: columnCount }, (_, i) => getColumnName(i));
-}

package/src/validation.ts

@@ -1,31 +0,0 @@
-/**
- * @fileoverview Validation utilities and custom error class for markdown table
- * data validation.
- */
-
-/**
- * Custom error class for handling Markdown table generation errors.
- * Supports ES2022 error chaining via the optional `cause` property.
- */
-export class MarkdownTableError extends Error {
-  constructor(message: string, options?: ErrorOptions) {
-    super(message, options);
-    this.name = 'MarkdownTableError';
-    Object.setPrototypeOf(this, MarkdownTableError.prototype);
-  }
-}
-
-/**
- * Validates that the input data is a non-empty two-dimensional array.
- * @param inputData - The data to validate
- * @throws {MarkdownTableError} If validation fails
- */
-export function validateInputData(inputData: unknown): void {
-  if (inputData === null || !Array.isArray(inputData)) {
-    throw new MarkdownTableError("The 'data' prop must be a two-dimensional array.");
-  }
-
-  if (inputData.length === 0) {
-    throw new MarkdownTableError("The 'data' array must contain at least one row.");
-  }
-}

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
-    "types": ["vite/client", "node"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
-    "noEmit": true,
-    "jsx": "react-jsx",
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
-  },
-  "include": ["src", "vite.config.ts"]
-}

package/vite.config.ts

@@ -1,7 +0,0 @@
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react-swc'
-
-// https://vite.dev/config/
-export default defineConfig({
-  plugins: [react()],
-})