J

Simple data wrapper that attempts to wrap SheetJS libraries to provide a uniform
way to access data from Excel and other spreadsheet files:

- JS-XLS: xlsjs on npm
- JS-XLSX: xlsx on npm
- JS-HARB: harb on npm

Excel files are parsed based on the content (not by filename). For example, CSV
files can be renamed to .XLS and excel will do the right thing.

Supported Formats:

| Format | Read | Write |
|:-------------------------------------------------------------|:-----:|:-----:|
| Excel Worksheet/Workbook Formats |:-----:|:-----:|
| Excel 2007+ XML Formats (XLSX/XLSM) | :o: | :o: |
| Excel 2007+ Binary Format (XLSB BIFF12) | :o: | :o: |
| Excel 2003-2004 XML Format (XML "SpreadsheetML") | :o: | |
| Excel 97-2004 (XLS BIFF8) | :o: | |
| Excel 5.0/95 (XLS BIFF5) | :o: | |
| Excel 4.0 (XLS/XLW BIFF4) | :o: | |
| Excel 3.0 (XLS BIFF3) | :o: | |
| Excel 2.0/2.1 (XLS BIFF2) | :o: | :o: |
| Excel Supported Text Formats |:-----:|:-----:|
| Delimiter-Separated Values (CSV/TSV/DSV) | :o: | :o: |
| Data Interchange Format (DIF) | :o: | :o: |
| Symbolic Link (SYLK/SLK) | :o: | :o: |
| Space-Delimited Text (PRN) | :o: | |
| UTF-16 Unicode Text (TXT) | :o: | |
| Other Workbook/Worksheet Formats |:-----:|:-----:|
| OpenDocument Spreadsheet (ODS) | :o: | :o: |
| Flat XML ODF Spreadsheet (FODS) | :o: | :o: |
| Uniform Office Format Spreadsheet (标文通 UOS1/UOS2) | :o: | |
| dBASE II/III/IV / Visual FoxPro (DBF) | :o: | |
| Other Common Spreadsheet Output Formats |:-----:|:-----:|
| HTML Tables | :o: | :o: |
| Markdown Tables | | :o: |
| Other Output Formats |:-----:|:-----:|
| XML Data (XML) | | :o: |
| SocialCalc | :o: | :o: |

!circo graph of format support

Installation

``bash
$ npm install -g j
`

Node Library

`js
var J = require('j');
`

J.readFile(filename) opens the file specified by filename and returns an array
whose first object is the parsing object (XLS or XLSX) and whose second object
is the parsed file.

J.utils has various helpers that expect an array like those from readFile:

| Format | util helper |
|:---------------------------------------------------------|:------------------|
| Excel 2007+ XML Formats (XLSX/XLSM) | to_xlsx/to_xlsm |
| Excel 2007+ Binary Format (XLSB BIFF12) | to_xlsb |
| Excel 2.0/2.1 (XLS BIFF2) | to_biff2 |
| Delimiter-Separated Values (CSV/TSV/DSV) | to_csv/to_dsv |
| Data Interchange Format (DIF) | to_dif |
| Symbolic Link (SYLK/SLK) | to_sylk |
| OpenDocument Spreadsheet (ODS) | to_ods |
| Flat XML ODF Spreadsheet (FODS) | to_fods |
| HTML Tables | to_html |
| Markdown Tables | to_md |
| XML Data (XML) | to_xml |
| SocialCalc | to_socialcalc |
| JSON Row Objects | to_json |
| List of Formulae | to_formulae |

CLI Tool

The node module ships with a binary j which has a help message:

`
$ j --help

Usage: j.njs [options] [sheetname]

Options:

-h, --help output usage information
-V, --version output the version number
-f, --file use specified file (- for stdin)
-s, --sheet print specified sheet (default first sheet)
-N, --sheet-index use specified sheet index (0-based)
-p, --password if file is encrypted, try with specified pw
-l, --list-sheets list sheet names and exit
-o, --output output to specified file
-B, --xlsb emit XLSB to or .xlsb
-M, --xlsm emit XLSM to or .xlsm
-X, --xlsx emit XLSX to or .xlsx
-Y, --ods emit ODS to or .ods
-2, --biff2 emit XLS to or .xls (BIFF2)
-T, --fods emit FODS to or .fods (Flat ODS)
-S, --formulae print formulae
-j, --json emit formatted JSON (all fields text)
-J, --raw-js emit raw JS object (raw numbers)
-A, --arrays emit rows as JS objects (raw numbers)
-x, --xml emit XML
-H, --html emit HTML
-m, --markdown emit markdown table
-D, --dif emit data interchange format (dif)
-K, --sylk emit symbolic link (sylk)
-E, --socialcalc emit socialcalc
-F, --field-sep CSV field separator
-R, --row-sep CSV row separator
-n, --sheet-rows Number of rows to process (0=all rows)
--sst generate shared string table for XLS* formats
--compress use compression when writing XLSX/M/B and ODS
--perf do not generate output
--all parse everything
--dev development mode
--read read but do not print out contents
-q, --quiet quiet mode
`




License

Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 license are reserved by the Original Author.

![Build Status](https://travis-ci.org/SheetJS/j)

![Coverage Status](https://coveralls.io/r/SheetJS/j?branch=master)

![NPM Downloads](https://npmjs.org/package/j)

![Dependencies Status](https://david-dm.org/sheetjs/j)

![ghit.me](https://ghit.me/repo/sheetjs/js-xlsx)

![Analytics](https://github.com/SheetJS/j)

Using J for diffing XLS/XLSB/XLSM/XLSX files

Using git textconv, you can use J to generate more meaningful diffs!

One-time configuration (misc/gitdiff.sh):

`
#!/bin/bash

Define a sheetjs diff type that uses j

git config --global diff.sheetjs.textconv "j"

Configure a user .gitattributes file that maps the xls{,x,m} files

touch ~/.gitattributes
cat <>~/.gitattributes
*.xls diff=sheetjs
*.xlsb diff=sheetjs
*.xlsm diff=sheetjs
*.xlsx diff=sheetjs
*.XLS diff=sheetjs
*.XLSB diff=sheetjs
*.XLSM diff=sheetjs
*.XLSX diff=sheetjs
EOF

Set the .gitattributes to be used for all repos on the system:

git config --global core.attributesfile '~/.gitattributes'
`

If you just want to compare formulae (for example, in a sheet using NOW):

`
git config --global diff.sheetjs.textconv "j -S"
`


NOTE: There are some known issues regarding global modules in Windows. The best
bet is to npm install j` in your git directory before diffing.