cip-108-markdown.sh

#!/bin/bash

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=lib/messages.sh
source "$SCRIPT_DIR/lib/messages.sh"

# Usage message
usage() {
    printf '%s%sCreate a human-readable Markdown representation of JSON-LD metadata%s\n\n' "$UNDERLINE" "$BOLD" "$NC"
    printf 'Syntax:%s %s %s<file|directory>%s\n' "$BOLD" "$0" "$GREEN" "$NC"
    print_usage_option "<file|directory>" "Path to JSON-LD file or directory"
    print_usage_option "-h, --help"       "Show this help message and exit"
    exit 1
}

# Function to extract fields from the JSON-LD file
extract_jsonld_data() {
    local jsonld_file=$1

    # Extract the data fields using jq
    local title=$(jq -r '.body.title // empty' "$jsonld_file")
    local abstract=$(jq -r '.body.abstract // empty' "$jsonld_file")
    local motivation=$(jq -r '.body.motivation // empty' "$jsonld_file")
    local rationale=$(jq -r '.body.rationale // empty' "$jsonld_file")
    local authors=$(jq '.authors[] // empty' "$jsonld_file")
    local onchain=$(jq '.body.onChain // empty' "$jsonld_file")

    # Extract the references and format them
    local references=$(jq -r '.body.references[] | "- [\(.label)](\(.uri))" // empty' "$jsonld_file")

    # Output to a markdown file
    local output_file="${jsonld_file}.md"

    # Create markdown content
    cat > "$output_file" <<EOF
# Markdown Representation of $(basename "$jsonld_file")

## Title

$title

## Abstract

$abstract

## Motivation

$motivation

## Rationale

$rationale

## References

$references

## Authors

$authors

## Onchain

$onchain
EOF

    print_pass "Markdown file generated at $(fmt_path "$output_file")"
}

# Check if a file or directory is passed as an argument
if [ $# -eq 0 ]; then
    usage
fi

# Handle help flag
if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
    usage
fi

# If the argument is a directory, process each JSON-LD file (including subdirectories)
if [ -d "$1" ]; then
    # Get all .jsonld files in the directory and subdirectories
    jsonld_files=()
    while IFS= read -r -d '' file; do
        jsonld_files+=("$file")
    done < <(find "$1" -type f -name "*.jsonld" -print0)

    # Check if any .jsonld files were found
    if [ ${#jsonld_files[@]} -eq 0 ]; then
        print_fail "No .jsonld files found in directory (including subdirectories): $(fmt_path "$1")"
        exit 1
    fi

    print_info "Found ${#jsonld_files[@]} .jsonld files to process"

    # Process each .jsonld file
    for jsonld_file in "${jsonld_files[@]}"; do
        extract_jsonld_data "$jsonld_file"
    done
elif [ -f "$1" ]; then
    # If it's a single file, process it
    extract_jsonld_data "$1"
else
    print_fail "Invalid input. $(fmt_path "$1") is not a valid file or directory."
    exit 1
fi