Mockup compiler for mockup loader (js implementation)
MIT License
Converts set of excels in a given directory to a set of tab-delimited text-files and zip them. Generally intended for ABAP Mockup loader and as a faster alternative of ABAP Mockup compiler or devops flows around mockup loader.
*.xlsx
in the given directory.'-'
._contents
sheet with 2 columns. The first is a name of another sheet in the workbook, the second includes the sheet into conversion if not empty. See example test.xlsx
in the test-sample
dir. If found, listed sheets are converted._exclude
sheet is present, then the list of sheets in the first column (except the first line - column name) are excluded from processing. This happens on top of _contents
sheet. See example test.xlsx
in the test-sample
dir.#
at the beginning this row is skipped (it is for comments) and the header is read from B1"-"
prefixed columns at the beginning are ignored, can be used for some meta data (you can also alter the character with skipFieldsStartingWith
config param)zipPath
config param)<excel name in lower case>/<sheet name>.txt
includes
directory explicitly added too.meta
files are created (withMeta
config param) with sha1 hashes of the source filesnpm install -g mockup-compiler-js
Params to specify: source directory, build directory, optionally include directory, optionally path to zip file. Run mockup-compiler --help
for command line opts help. Example:
mockup-compiler -s ./src-dir -d ./dest-dir -i ./static-assets -z ./build.zip
See also mockup-compiler --help
for the full list of options.
The tool can also be run in the watch mode. In this case runs complete build first and then starts watching the source files - if changed, runs conversion on the changed one again and re-archives (if requested)
mockup-compiler ... --watch
The setting can be given in config. By default the programs looks for the config in the current directory in file .mock-config.json
. Optionally can be set with -c
command opt. Example of the file:
{
"sourceDir": ".",
"eol": "lf", // lf or crlf
"destDir": "_dest",
"zipPath": "_dest/build.zip",
"includes": [
"_dest/_inc"
],
"skipFieldsStartingWith": "_",
"withMeta": true,
"cleanDestDirOnStart": false
}
All params are optional except source and destination dirs.
mockup-compiler -c ./my-mock-config.json
zipPath
is not specified, zip file will not be created, just tab-delimited texts.eol
- defines which end-of-line character to use: linux style (LF) or window style (CRLF). We recommend LF.includes
- optionally defines an dir to directly copy files from, in addition to excel processing. Currently support only one include dir.withMeta
instructs the compiler to create .meta/src_files
with SHA1 hashes of source files (for integrity and compatibility with abap version of the tool)cleanDestDirOnStart
deletes the destination dir before file processing. Importantly, it does not cleans the dir in watch mode, so changes are written on top of the existing files structure. Thus, e.g., deleting a sheet in excel will not delete it's already compiled representation.