1.0.1
JSON2Batch was developed for a project during our first and second semester of university. It generates batch files from JSON files, which can spawn terminals or applications, that run under certain parameters specified within the JSON file.
The project was carried out by Elena Schwarzbach, Max Rodler, Simon Blum, Sonia Sinaci.
git clone -b release https://github.com/DHBWProjectsIT23/JSON2Bat/
cd JSON2Bat
cmake -S . -B build
cmake --build buildThe project has been tested with GCC version 10.5+ and Clang version 14+.
The project has been tested on windows using MinGW and Ninja.
MinGW can be installed by following Steps 1 through 7 in this tutorial
git clone -b release https://github.com/DHBWProjectsIT23/JSON2Bat/
cd JSON2Bat
cmake -S . -B build -G "MinGW Makefiles"
cmake --build buildThe project was tested using MinGW with the above mentioned installation and using this GitHub Action.
The Ninja binary can be found here. Alternatively Ninja can be build from source.
git clone -b release https://github.com/DHBWProjectsIT23/JSON2Bat/
cd JSON2Bat
cmake -S . -B build -G "Ninja"
cmake --build buildThe project was tested using Ninja v1.12.0 on a local machine and using v1.10 using this GitHub Action.
If the doxygen executable is installed local documentation can be generated using:
git clone -b release https://github.com/DHBWProjectsIT23/JSON2Bat/
cd JSON2Bat
cmake -S . -B build
cmake --build build --target doxygen_generateThe documentation generated by doxygen for this project can be found here. A PDF version can be found here and a short man page can be found here. After building the project the man page can be accessed by:
man assets/man/json2batch.troffThe project directory is structured as follows:
- assets > Includes files, not directly related to the code
- conf > Includes files which will be configured by CMake
- include > Includes header files for external libraries
- lib > Includes source/binary files for external libraries
- src > Includes the source code for the project
- sources > Includes all ".cpp" files
- include > Includes all ".hpp" files
- main.cpp
The easylogging++ library is used for logging within the application. The configuration for the library is done via a logging file which can be found in conf/easylogging.in.conf. Cmake configures this file into the binary directory upon building. If the configuration file is removed, the application will no longer run.
While easylogging++ is used for the logging back--end within the code there are little remains apart from the configuration. The logging and output of the application is done over a self written wrapper. Altough it is self written, due to it beeing not part of the project we consider it an external libraries. The wrapper is used to simplify parallel output to stdout and the logfile and also enables increased output to stdout for the verbose mode. A few macros are defined for use within the application:
- OUTPUT > Outputs to stdout and the logfile
- LOG_INFO > By default only outputs to the logfile
- LOG_WARNING > Formats text and outputs to stdout and the logfile
- LOG_ERROR > Same as LOG_WARNING but in red and bold
The macros can be used with streaming in the same way as std::cout would be used. Furthermore, some rudimentary performance tests showed, that the use of the wrapper, does not affect performance in comparison to using both std::cout and easylogging itself.
For parsing the JSON files, the jsoncpp library is used. On UNIX system this library can simply be installed using the systems package manager (tested with WSL/Ubuntu and Arch). For Windows system a prebuild version is included.
The project is published under the Apache License V2.0. Check the license file for more information!