book_generator/table_des_matieres.sh

#!/bin/bash

# motivation to rewrite a simple alternative to doctoc: How Much Do You Trust That Package? Understanding The Software Supply Chain https://www.youtube.com/watch?v=fnELtqE6mMM
# src https://gist.github.com/meleu/57867f4a01ede1bd730f14b2f018ae89

############
# Generates a Table of Contents getting a markdown file as input.
#
# Inspiration for this script:
# https://medium.com/@acrodriguez/one-liner-to-generate-a-markdown-toc-f5292112fd14
#
# The list of invalid chars is probably incomplete, but is good enough for my
# current needs.
# Got the list from:
# https://github.com/thlorenz/anchor-markdown-header/blob/56f77a232ab1915106ad1746b99333bf83ee32a2/anchor-markdown-header.js#L25
#

PAGE_TOC="sources/99_03_table_des_matieres.md"

INVALID_CHARS="'[]/?!:\`.,()*\";{}+=<>~$|#@&–—"

file_md_to_inspect="build/toutes_les_pages.md"

echo "build a concatenation of all pages..."
rm -rf build/toutes_les_pages.md


for i in source/*.md ; do
#    if [ "sources/99_03_table_des_matières.md" != $i ] ; then
      echo "adding $i"
      cat $i >> build/toutes_les_pages.md
      echo "lignes en tout:"
      cat build/toutes_les_pages.md | wc -l
#    else
#      echo "not adding $i"
#    fi
done

cat build/toutes_les_pages.md |wc -l

echo "OK"


echo "markdown file to inspect: $file_md_to_inspect"


check() {

    # src https://stackoverflow.com/questions/6482377/check-existence-of-input-argument-in-a-bash-shell-script
    if [ -z build/toutes_les_pages.md ]; then
        echo "Error. No argument found. Put as argument a file.md"
        exit 1
    fi

    [[ ! -f build/toutes_les_pages.md ]] && echo "Error. File not found" && exit

}

toc() {

    local line
    local level
    local title
    local anchor
    local output

    while IFS='' read -r line || [[ -n "$line" ]]; do
        level="$(echo "$line" | sed -E 's/^#(#+).*/\1/; s/#/    /g; s/^    //')"
        title="$(echo "$line" | sed -E 's/^#+ //')"
        anchor="$(echo "$title" | tr '[:upper:] ' '[:lower:]-' | tr -d "$INVALID_CHARS")"
        output=$output"$level- [$title](#$anchor)\n"
    done <<< "$(grep -E '^#{2,10} ' $1 | tr -d '\r')"

    echo "$output"

}

insert() {

    local toc_text="$2"
    local appname='doctoc.sh'
    # inspired in doctoc lines
    local start_toc="<!-- START $appname generated TOC please keep comment here to allow auto update -->"
    local info_toc="<!-- DO NOT EDIT THIS SECTION, INSTEAD RE-RUN $appname TO UPDATE -->"
    local end_toc="<!-- END $appname generated TOC please keep comment here to allow auto update -->"

    toc_block="$start_toc\n$info_toc\n**Table of Contents**\n\n$toc_text\n$end_toc"

    # search multiline toc block -> https://stackoverflow.com/questions/2686147/how-to-find-patterns-across-multiple-lines-using-grep/2686705
    if grep -Pzl "(?s)$start_toc.*\n.*$end_toc" build/toutes_les_pages.md &>/dev/null; then
        echo -e "\n  Updated content of $appname block for build/toutes_les_pages.md succesfully\n"
        # src https://askubuntu.com/questions/533221/how-do-i-replace-multiple-lines-with-single-word-in-fileinplace-replace
        sed -i ":a;N;\$!ba;s/$start_toc.*$end_toc/$toc_block/g" build/toutes_les_pages.md
    else
        echo -e "\n  Created $appname block for build/toutes_les_pages.md succesfully\n"
        sed -i 1i"$toc_block" build/toutes_les_pages.md
    fi

}

main() {

    check build/toutes_les_pages.md
    toc_text=$(toc "build/toutes_les_pages.md")
    insert "build/toutes_les_pages.md" "$toc_text"

}

[[ "$0" == "$BASH_SOURCE" ]] && main "$@"