https://github.com/fugerit-org/fj-tool-helper

Simple project with utilities for stand alone tool
https://github.com/fugerit-org/fj-tool-helper

Last synced: 13 days ago
JSON representation

Simple project with utilities for stand alone tool

• Host: GitHub
• URL: https://github.com/fugerit-org/fj-tool-helper
• Owner: fugerit-org
• License: apache-2.0
• Created: 2023-09-27T19:46:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-18T10:26:23.000Z (11 months ago)
• Last Synced: 2024-11-06T01:10:16.625Z (2 months ago)
• Language: Java
• Size: 39.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# fj-tool-helper

Simple project with utilities for stand alone tool.

[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 

[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-tool-helper.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-tool-helper) 

[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0) 

[![code of conduct](https://img.shields.io/badge/conduct-Contributor%20Covenant-purple.svg)](https://github.com/fugerit-org/fj-universe/blob/main/CODE_OF_CONDUCT.md)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-tool-helper&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-tool-helper)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-tool-helper&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-tool-helper)

[![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white)](https://universe.fugerit.org/src/docs/versions/java11.html)

[![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)](https://universe.fugerit.org/src/docs/versions/java11.html)

[![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)](https://universe.fugerit.org/src/docs/versions/maven3_9.html)

[![Fugerit Github Project Conventions](https://img.shields.io/badge/Fugerit%20Org-Project%20Conventions-1A36C7?style=for-the-badge&logo=Onlinect%20Playground&logoColor=white)](https://universe.fugerit.org/src/docs/conventions/index.html)

## Quickstart

build : 

`mvn clean install -P singlepackage`

run : 

``` 

Example : java -jar target/dist-fj-tool-helper-*.jar \

 --tool-help-config-path src/main/resources/tool/tool-help-config.xml \

 --output-file target/help.md \

 --output-format md  

```

 

## **parameter help**  

| **name** | **required** | **default** | **description** | **since** | **info**  |

|---------------|---------------|---------------|---------------|---------------|---------------|

| `tool-help-config-path` | `true` | none | Path to tool-help-config xml file. | 0.1.0 | By default the path will be looked on file system, to search in classpath prefix with cl://  |

| `output-file` | `true` | none | Path to the the file to create. | 0.1.0 | Must be a physical file  |

| `output-format` | `true` | none | Output format, currently accepted formats are md (markdown), html, pdf, txt. | 0.1.0 | The output will be generated via Venus Fugerit document generation framework (https://github.com/fugerit-org/fj-doc).  |

| `exclude-info` | `false` | `false` | If set to `true`, the 'info' columns of tool parameters will be ignored. | 0.1.0 | The output will be generated via Venus Fugerit document generation framework (https://github.com/fugerit-org/fj-doc).  |

| `help` | `false` | none | Print help about the tool. | 0.1.0 | In case of errors the help will be printed too.  |