27 lines
1.7 KiB
Markdown
27 lines
1.7 KiB
Markdown
# json2excel
|
|
|
|
This is a basic utility to take json and convert it into an OpenXml format xlsx file, compatible with Excel.
|
|
|
|
It expects that the json input is formatted as an object containing an array of objects. Column names are generated based on the keys in the first nested object.
|
|
|
|
## Command line options
|
|
| Parameter | Default Value | Description |
|
|
|---------------|---------------|---------------------------|
|
|
| inputJson | input.json | File path of the input json to process |
|
|
| outputFilename | output.xlsx | File path of the output file |
|
|
| worksheetName | Sheet1 | Set the name of the worksheet, will be truncated to 31 characters |
|
|
| boldTopRow | true | Sets the top row of the worksheet to bold |
|
|
| freezeTopRow | true | Freezes the first row of the Excel worksheet |
|
|
| autofilter | true | Sets the auto filter on the first row |
|
|
| autowidth | true | Automatically set the column width to fit contents |
|
|
| overwriteFile | false | Overwrite any existing output file instead of modifying in-place |
|
|
|
|
## Advanced configuration
|
|
|
|
Advanced settings can be provided via a top level json key named "config". Here is a table of options that can be set via this config key.
|
|
|
|
| Key | Example Value | Description |
|
|
|---------------|---------------|---------------------------|
|
|
| key-order | "Column3,Column1,Column2"| Comma separated list of column names in the desired order |
|
|
| overwrite-file | true | Boolean indicating whether output file should be overwritten if it already exists |
|
|
| parent-node | "results" | Specify an alternate starting key for the spreadsheet data than just the first non-config key. Useful with json structures with multiple top-level keys | |