xlsx-to-markdown 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Options for XLSX to Markdown conversion
+ */
+export interface ConvertOptions {
+    /**
+     * Sheets to include by name or index (0-based).
+     * Default: all sheets
+     */
+    sheets?: (string | number)[];
+    /**
+     * Add "## Sheet Name" heading before each sheet's content.
+     * Default: true when the workbook has multiple sheets
+     */
+    sheetHeadings?: boolean;
+    /**
+     * Treat the first row of each detected table as a header row.
+     * Default: true
+     */
+    headerRow?: boolean;
+    /**
+     * Table detection thresholds.
+     */
+    tableDetection?: {
+        /**
+         * Minimum number of columns for a region to be treated as a table.
+         * Default: 2
+         */
+        minColumns?: number;
+        /**
+         * Minimum number of rows for a region to be treated as a table.
+         * Default: 2
+         */
+        minRows?: number;
+        /**
+         * Use cell borders as a hint when classifying regions.
+         * Default: true
+         */
+        useBorders?: boolean;
+    };
+    /**
+     * Preserve rich-text formatting (bold → **, italic → _, etc.)
+     * Default: true
+     */
+    richText?: boolean;
+    /**
+     * Placeholder text for empty table cells.
+     * Default: "" (empty string)
+     */
+    emptyCell?: string;
+    /**
+     * Format string for dates.
+     * Uses simple tokens: YYYY MM DD HH mm ss
+     * Default: ISO 8601 (YYYY-MM-DD)
+     */
+    dateFormat?: string;
+    /**
+     * Number of blank lines to insert between regions.
+     * Default: 1
+     */
+    blankLinesBetweenRegions?: number;
+}
+/**
+ * Resolved options with all defaults filled in.
+ */
+export interface ResolvedOptions {
+    sheets?: (string | number)[];
+    sheetHeadings: boolean | "auto";
+    headerRow: boolean;
+    tableDetection: {
+        minColumns: number;
+        minRows: number;
+        useBorders: boolean;
+    };
+    richText: boolean;
+    emptyCell: string;
+    dateFormat: string;
+    blankLinesBetweenRegions: number;
+}
+/**
+ * Type of a detected region within a sheet.
+ */
+export type RegionType = "table" | "paragraph" | "heading";
+/**
+ * A detected content region in a sheet.
+ */
+export interface Region {
+    type: RegionType;
+    /** Inclusive 0-based row index where this region starts */
+    startRow: number;
+    /** Inclusive 0-based row index where this region ends */
+    endRow: number;
+    /** Inclusive 0-based column index where this region starts */
+    startCol: number;
+    /** Inclusive 0-based column index where this region ends */
+    endCol: number;
+    /** The rendered Markdown for this region */
+    markdown: string;
+}
+/**
+ * Conversion result for a single sheet.
+ */
+export interface SheetResult {
+    name: string;
+    index: number;
+    markdown: string;
+    regions: Region[];
+}
+/**
+ * Full conversion result.
+ */
+export interface ConvertResult {
+    /** Combined Markdown for all sheets */
+    markdown: string;
+    sheets: SheetResult[];
+}
+/**
+ * Represents a single parsed cell value (after formatting).
+ */
+export interface CellData {
+    /**
+     * Plain text value with no inline formatting applied.
+     * Used by renderers that handle their own markup (e.g. HTML table renderer).
+     */
+    rawValue: string;
+    /**
+     * Markdown-formatted value (bold → **, italic → _, hyperlink → [text](url)).
+     * Used by the paragraph renderer.
+     */
+    value: string;
+    /** Whether the cell has a bold format */
+    bold: boolean;
+    /** Whether the cell has an italic format */
+    italic: boolean;
+    /** Hyperlink URL, if any */
+    hyperlink?: string;
+    /** Horizontal alignment */
+    alignment?: "left" | "center" | "right";
+    /** True when this cell is part of a merge but is not the top-left "master" cell */
+    isMergedChild: boolean;
+    /** True when this cell has any border (used for table detection) */
+    hasBorder: boolean;
+    /**
+     * Pre-built HTML string for inline rich-text runs (bold/italic applied per run).
+     * Set when cell.r XML was parsed successfully; undefined for plain cells.
+     * Used by the HTML table renderer instead of rawValue + cell-level bold/italic.
+     */
+    richTextHtml?: string;
+}
+/**
+ * Internal row data used during region detection.
+ */
+export interface RowInfo {
+    /** 0-based row index */
+    index: number;
+    /** Columns with content, as a Set of 0-based column indices */
+    filledCols: Set<number>;
+    /** Min filled column index (-1 if empty row) */
+    minCol: number;
+    /** Max filled column index (-1 if empty row) */
+    maxCol: number;
+    /** Number of filled (non-child-merge) cells */
+    filledCount: number;
+    /** True when at least one cell in this row has any border */
+    hasBorder: boolean;
+    /**
+     * True when at least one cell in this row has a vertical border (left or right).
+     * Vertical borders indicate column structure and are the primary signal for
+     * table-boundary detection when `useBorders` is enabled.
+     */
+    hasVerticalBorder: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE;QACf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7B,aAAa,EAAE,OAAO,GAAG,MAAM,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,4CAA4C;IAC5C,MAAM,EAAE,OAAO,CAAC;IAChB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACxC,mFAAmF;IACnF,aAAa,EAAE,OAAO,CAAC;IACvB,oEAAoE;IACpE,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;CAC5B"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "xlsx-to-markdown",
+  "version": "0.1.1",
+  "description": "Convert XLSX files to Markdown, handling mixed content (tables and paragraphs)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/khatada/xlsx-to-markdown.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "oxlint src/",
+    "lint:fix": "oxlint src/ --fix",
+    "fmt": "oxfmt src/",
+    "fmt:check": "oxfmt src/ --check",
+    "secretlint": "secretlint \"**/*\"",
+    "prepublishOnly": "npm run build",
+    "prepare": "husky"
+  },
+  "keywords": [
+    "xlsx",
+    "excel",
+    "markdown",
+    "converter"
+  ],
+  "author": "khatada",
+  "license": "MIT",
+  "dependencies": {
+    "xlsx": "^0.18.5"
+  },
+  "devDependencies": {
+    "@secretlint/secretlint-rule-preset-recommend": "^11.4.1",
+    "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
+    "husky": "^9.1.7",
+    "oxfmt": "^0.43.0",
+    "oxlint": "^1.58.0",
+    "secretlint": "^11.4.1",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  }
+}