core/scripts/renew_copyright_header.sh

# Copyright (C) 2024 - 2024:
# The Trinitrix Project <bpeetz@b-peetz.de, antifallobst@systemausfall.org>
# SPDX-License-Identifier: MIT
#
# This file is part of Trinitrix.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the “Software”), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

#! /usr/bin/env sh

# NOTE: This is the line length of the .licensure.yml header template **plus** the extra
# line after the template comment.
TEMPLATE_LINE_LENGTH=20
LATEX_TEMPLATE_LINE_LENGTH=9

PROJECT_ROOT="$(git rev-parse --show-toplevel)"

remove() {
    extension="$1"
    file="$2"

    # We need to differentiate, when removing the old copyright header, as some
    # formatters do weird things to the file
    case "$extension" in
    # normal '#' comments (these are $TEMPLATE_LINE_LENGTH lines long)
    "Makefile" | "toml" | "envrc" | "yml" | "gitignore" | "awk")
        sed --in-place "1,${TEMPLATE_LINE_LENGTH}d" "$file"
        ;;
    # LaTeX files (or TeX files in general) have a different license, use the
    # $LATEX_TEMPLATE_LINE_LENGTH variable.
    "tex")
        sed --in-place "1,${LATEX_TEMPLATE_LINE_LENGTH}d" "$file"
        ;;
    # normal '/* ... */' like comments (these are $TEMPLATE_LINE_LENGTH + 2 lines long)
    "c" | "h" | "md" | "rs")
        length="$((TEMPLATE_LINE_LENGTH + 2))"
        sed --in-place "1,${length}d;" "$file"
        ;;
    # alejandra (the nix formatter) removes the blank line after the comment,
    # thus only $TEMPLATE_LINE_LENGTH - 1 lines
    "nix")
        length="$((TEMPLATE_LINE_LENGTH - 1))"
        sed --in-place "1,${length}d;" "$file"
        ;;
    # Shell needs a shebang on the first line, only after the first line can we
    # remove the $TEMPLATE_LINE_LENGTH lines
    "sh")
        sed --in-place "2,${TEMPLATE_LINE_LENGTH}d;" "$file"
        licensure --in-place "$file"

        TEMPLATE_LINE_LENGTH_NEW="$(($(yq --raw-output '.licenses | map(.template) | join("")' "$PROJECT_ROOT/.licensure.yml" | wc -l) + $(yq '.comments | last | .commenter.trailing_lines' "$PROJECT_ROOT/.licensure.yml")))"

        # delete the current shebang
        to="$((TEMPLATE_LINE_LENGTH_NEW + 1))"
        sed --in-place "${TEMPLATE_LINE_LENGTH_NEW},${to}d;" "$file"

        # add a new one
        sed --in-place "1i#! /usr/bin/env sh" "$file"
        ;;
    *)
        echo "File '$file' with extension '$extension' is not know yet, please add it!"
        ;;
    esac
}

list() {
    echo "$extension -> $file"
}

if [ -f "$1" ]; then
    file="$(realpath "$1")"
    filename="$(basename -- "$file")"
    extension="${filename##*.}"
    filename="${filename%.*}"

    if [ -n "$DRY_RUN" ]; then
        list "$extension" "$file"
    else
        remove "$extension" "$file"
    fi
else
    fd --type file --hidden . | while read -r file; do
        if grep --quiet 'SPDX-License-Identifier' "$file"; then
            filename="$(basename -- "$file")"
            extension="${filename##*.}"
            filename="${filename%.*}"

            if [ -n "$DRY_RUN" ]; then
                list "$extension" "$file"
            else
                remove "$extension" "$file"
            fi
        fi
    done

    if [ -z "$DRY_RUN" ]; then
        licensure --in-place --project
        nix fmt
    fi
fi