xlsmtotext's Introduction

XLSMToText converter

A small Java based utility to turn XLSX and XLSM files into text files suitable for diffing.

For cells only formulas / values are exported. Styling and other meta information is ignored. For XLSM files the VBA projects module code is exported as well.

How to use from the command line

java -Dstdout.encoding=UTF-8 -Dline.separator=$'\n' -jar C:/path/to/XLSMToText-1.0.jar file1.xlsm > file1.txt
java -Dstdout.encoding=UTF-8 -Dline.separator=$'\n' -jar C:/path/to/XLSMToText-1.0.jar file2.xlsm > file2.txt
diff -d -u -F '^\(sheet\|module\) .* {\|\(Private\|Public\|\) \(Function\|Sub\)' file1.txt file2.txt |diff-so-fancy |less -RS

Optionally have a look at diff-so-fancy. To use it, replace |less -RS with |diff-so-fancy |less -RS.

How to use in Git

First add four keys to your Git config:

git config --global diff.xlsm.textconv "java -Dstdout.encoding=UTF-8 -Dline.separator=$'\n' -jar C:/path/to/XLSMToText-1.0.jar"
git config --global diff.xlsm.cachetextconv true
git config --global diff.xlsm.binary true
git config --global diff.xlsm.xfuncname "^((sheet|module) .* \\{|(Private|Public|) (Function|Sub) [^(]+\\([^)]*\\).*)$"

For Java versions < 19 use -Dfile.encoding=UTF-8 instead of -Dstdout.encoding=UTF-8.

Then add the following line to your repos .gitattributes:

*.xls[xm] diff=xlsm

Optionally have a look at diff-so-fancy.

Building

mvn package

License terms

This software is distributed under the Apache License version 2. The full text of the license can be found at https://www.apache.org/licenses/LICENSE-2.0.txt.

This script was modified from the POI XLSX2CSV.java example script. That script is licenced under the Apache license version 2.

Recommend Projects