JBang Catalog Document Generator

///usr/bin/env jbang "$0" "$@" ; exit $?

import static java.lang.System.out;

public class hello {

    public static void main(String... args) {
        out.println("Hello World");
    }
}

jbang hello.java
[jbang] Building jar...
Hello World

name: update-catalog
on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  update-catalog-documentation:
    runs-on: ubuntu-latest
    name: Update catalog documentation
    if: startsWith(github.event.head_commit.message, 'Updating jbang-catalog documentation') != true
    steps:
      - uses: actions/checkout@v3
      - uses: rodnansol/jbang-catalog-document-generator-action@v0.1.0 (1)
        name: Generate catalog document
        with:
          version: early-access (2)
          arguments: generate jbang-catalog.json -o README.adoc --custom-header=header.adoc --include-generation-date=true (3)
      - name: Commit document changes
        shell: bash
        run: |
          git add README.adoc (4)
          git config --global user.email "${{ secrets.COMMITTER_EMAIL }}"
          git config --global user.name "${{ secrets.COMMITTER_NAME }}"
          git commit -m "Updating jbang-catalog documentation" (5)
          git push origin main

java -jar jbang-catalog-document-generator-cli/target/jbang-catalog-document-generator-cli-999-SNAPSHOT.jar generate
Usage: <main class> generate [-g] [-cc] [-cus] [-hfdr] [-toc]
                             [-cf=<customFooterFilePath>]
                             [-ch=<customHeaderFilePath>] [-o=<outputFile>]
                             [-pcn=<preferredCatalogName>]
                             [-t=<customTemplatePath>] [-toc-l=<tocLevels>]
                             [-toc-p=<tocPlacement>] [-toc-t=<tocTitle>]
                             [-tt=<templateType>] <inputFile>
Generates a documentation for a given jbang-catalog.json file
      <inputFile>   The input JSON file to convert.
      -cc, --check-checksum
                    Defines if the checksum check should be running or not.
                      Checksum check is enabled by default.
      -cf, --custom-footer=<customFooterFilePath>
                    Path to a custom footer.
      -ch, --custom-header=<customHeaderFilePath>
                    Path to a custom header.
      -cus, --collapsible-usage-section
                    Defines if the usage section should be collapsible or not
  -g, --include-generation-date
                    Defines if the generation date should be put into the
                      document or not.
      -hfdr, --header-footer-direct-render
                    Defines if the header and footer should be directly
                      rendered into the document or not. In case of AsciiDoc it
                      will not use the `include` directive.
  -o, --output=<outputFile>
                    The output AsciiDoc file name. Defaults to 'jbang-catalog.
                      adoc'
      -pcn, --preferred-catalog-name=<preferredCatalogName>
                    Defines the preferred catalog name.
  -t, --template=<customTemplatePath>
                    Custom template path.
      -toc, --table-of-contents
                    Enable the table of contents or not
      -toc-l, --table-of-contents-levels=<tocLevels>
                    Levels of the table of contents (In case of AsciiDoc)
      -toc-p, --table-of-contents-placement=<tocPlacement>
                    Placement of the table of contents (In case of AsciiDoc)
      -toc-t, --table-of-contents-title=<tocTitle>
                    Title of the table of contents
      -tt, --template-type=<templateType>
                    Template type.

docker run -v $(pwd):/resources ghcr.io/rodnansol/jbang-catalog-document-generator:<version> generate /resources/jbang-catalog.json -o /resources/jbang-catalog.adoc

{
  "aliases": {
    "hello": {
      "script-ref": "hello.java",
      "description": "Script that says hello back for each argument"
    }
  }
}

This is a usage file, that will be rendered below the `hello` alias entry.

!%$&@ So you want to use this script? !%$&@

< Let me show you how you can use it. >

jbang hello <scriptOrFile>

This is a usage file, that will be rendered below the `hello` alias entry.

!%$&@ So you want to use this script? !%$&@

< Let me show you how you can use it. >

java -Dapp.document.current-working-directory=new-working/directory -jar jbang-catalog-document-generator-cli.jar generate jbang-catalog.json