cip-108-create-human-readable.sh

#!/bin/bash

# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[0;33m'
BLUE='\033[0;34m'
CYAN='\033[0;36m'
BRIGHTWHITE='\033[0;37;1m'
NC='\033[0m'
UNDERLINE='\033[4m'
BOLD='\033[1m'
GRAY='\033[0;90m'

# Usage message
usage() {
    local col=50
    echo -e "${UNDERLINE}${BOLD}Create a human-readable Markdown representation of JSON-LD metadata${NC}"
    echo -e "\n"
    echo -e "Syntax:${BOLD} $0 ${GREEN}<file|directory>${NC}"
    printf "Params: ${GREEN}%-*s${GRAY}%s${NC}\n" $((col-8)) "<file|directory>" "- Path to JSON-LD file or directory"
    printf "        ${GREEN}%-*s${GRAY}%s${NC}\n" $((col-8)) "-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

    echo "Markdown file generated: $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
        echo "Error: No .jsonld files found in directory (including subdirectories): $1"
        exit 1
    fi
    
    echo "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
    echo "Invalid input. Please provide a valid file or directory."
    exit 1
fi