aboutsummaryrefslogtreecommitdiffstats
path: root/templates/latex
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-04-02 14:26:11 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-04-02 14:26:11 +0200
commitaabba688f54323f1cd4451ec068598152b67d9e0 (patch)
treeb733baef48cd1b3bee997f73b6d5d181f4da1e84 /templates/latex
parentchore(common/treefmt.nix): Ignore the pre-generation markdown file (diff)
downloadflake-templates-aabba688f54323f1cd4451ec068598152b67d9e0.zip
chore(templates): Update common files
Diffstat (limited to 'templates/latex')
-rw-r--r--templates/latex/.licensure.yml14
-rwxr-xr-xtemplates/latex/init53
-rw-r--r--templates/latex/treefmt.nix1
3 files changed, 47 insertions, 21 deletions
diff --git a/templates/latex/.licensure.yml b/templates/latex/.licensure.yml
index 942a96f..60ef45c 100644
--- a/templates/latex/.licensure.yml
+++ b/templates/latex/.licensure.yml
@@ -22,10 +22,10 @@ licenses:
email: "%INIT_AUTHOR_EMAIL"
template: |
- TODO 2024 - [year] (C) by [name of author]
+ %INIT_APPLIACATION_NAME_STYLIZED %INIT_YEAR - [year] (C) by [name of author]
SPDX-License-Identifier: CC-BY-SA-4.0
- TODO is licensed under a
+ %INIT_APPLIACATION_NAME_STYLIZED is licensed under a
Creative Commons Attribution-ShareAlike 4.0 International License.
You should have received a copy of the license along with this
@@ -51,9 +51,9 @@ licenses:
# A list of authors who hold copyright over these files
authors:
# Provide either your full name or company name for copyright purposes
- - name: Benedikt Peetz
+ - name: "%INIT_AUTHOR_NAME"
# Optionally provide email for copyright purposes
- email: "benedikt.peetz@b-peetz.de"
+ email: "%INIT_AUTHOR_EMAIL"
# The template that will be rendered to generate the header before
# comment characters are applied. Available variables are:
@@ -63,13 +63,13 @@ licenses:
# Name <email@example.com>. If multiple authors are provided the
# list is concatenated together with commas.
template: |
- Copyright (C) 2023 - [year]:
+ Copyright (C) %INIT_YEAR - [year]:
[name of author]
SPDX-License-Identifier: GPL-3.0-or-later
- This file is part of the TODO.
+ This file is part of %INIT_APPLICATION_NAME_STYLIZED.
- TODO is free software: you can redistribute it and/or modify
+ %INIT_APPLICATION_NAME_STYLIZED is free software: you can redistribute it and/or modify
it under the terms of the Lesser GNU General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
diff --git a/templates/latex/init b/templates/latex/init
index 787b663..df0b4c5 100755
--- a/templates/latex/init
+++ b/templates/latex/init
@@ -5,33 +5,40 @@
replacement_file="$(mktemp)"
trap cleanup INT
-trap "cleanup; remove" EXIT
+trap "cleanup; remove_self" EXIT
cleanup() {
rm "$replacement_file"
}
-remove() {
+remove_self() {
rm "$(realpath "$0")"
rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh"
- git add .
}
-# Prompt the user for a specific variable. The variable is the first
-# input, the second is an optional description.
-# The third argument can be a suggested answer, already pre populated.
+# Prompt the user for a specific variable.
+# ## Args:
+# [1]: Name of the variable to populate the answer to
+# [2]: An optional description
+# [3]: An optionally suggested answer
+# [4]: If this is set, the user is not even asked.
prompt() {
pr_variable_upper="$(echo "$1" | sed 's/\([a-z]\)/\U\1/')"
pr_description="$2"
pr_suggested_answer="$3"
+ pr_ask="$4"
- printf "\033[94;1mEnter %s\033[0m" "$pr_variable_upper"
- if [ -n "$pr_description" ];then
- printf " (\033[93;1m%s\033[0m):\n" "$pr_description"
+ if [ -n "$pr_ask" ]; then
+ REPLY="$pr_suggested_answer";
else
- printf ":\n"
- fi
+ printf "\033[94;1mEnter %s\033[0m" "$pr_variable_upper"
+ if [ -n "$pr_description" ];then
+ printf " (\033[93;1m%s\033[0m):\n" "$pr_description"
+ else
+ printf ":\n"
+ fi
- # LE "> " 0 " " "$pr_suggested_answer" "yes_please_produce_debug_output"
- LE "> " 0 " " "$pr_suggested_answer" ""
+ # LE "> " 0 " " "$pr_suggested_answer" "yes_please_produce_debug_output"
+ LE "> " 0 " " "$pr_suggested_answer" ""
+ fi
pr_new_variable="$(printf '%s="%s"' "$pr_variable_upper" "$REPLY")"
@@ -43,7 +50,10 @@ git init
# necessary meta data
prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")"
-prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(basename "$PWD" | sed 's/\([a-z]\)/\u\1/')"
+prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/\([a-z]\)/\u\1/')"
+prompt APPLICATION_NAME_CAPITALIZED_MAN_PART "The capitalized name of the application (for documentation also with a man section part)" "$(echo "$APPLICATION_NAME" | sed 's/\([a-z]\)/\U\1(1)/')" "dont_ask"
+prompt APPLICATION_VERSION "The version of this program, without the prefix" "0.1.0"
+
prompt AUTHOR_NAME "The name of the author (or authors)" "$(git config --get user.name)"
prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get user.email)"
@@ -54,6 +64,8 @@ prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME"
# nice meta data
prompt DESCRIPTION "The description of this project" "[can be empty]"
+prompt CURRENT_DATE "The stylized version of the current date" "$(date +'%b %Y')"
+prompt YEAR "The year the work on this has begun (for copyright reasons)" "$(date +'%Y')"
# LICENSE.spdx data (source: https://github.com/david-a-wheeler/spdx-tutorial)
prompt APPLICATION_ORIGINATOR "The person or organization from whom the package originally came" "$AUTHOR_NAME"
@@ -67,5 +79,18 @@ while read -r var; do
var_value="${var_value%\"}"
fd . --hidden --type file --exec sed --in-place "s|%\bINIT_$var_name\b|$var_value|"
+
+ # Replace the variable in file paths
+ fd "%INIT_$var_name" . --hidden | while read -r file_path; do
+ new_file_path="$(echo "$file_path" | sed "s|%INIT_$var_name|$var_value|")";
+ mv "$file_path" "$new_file_path"
+ done
done < "$replacement_file"
+
+# HACK: Re-add the executable permissions to files, which the nix template has somehow
+# removed <2024-04-02>
+chmod +x scripts/*
+chmod +x update.sh
+[ -f ./build.sh ] && chmod +x build.sh
+
# vim: ft=sh
diff --git a/templates/latex/treefmt.nix b/templates/latex/treefmt.nix
index 1cbab40..540a6ca 100644
--- a/templates/latex/treefmt.nix
+++ b/templates/latex/treefmt.nix
@@ -59,6 +59,7 @@ treefmt-nix.lib.evalModule pkgs (
global.excludes = [
"CHANGELOG.md"
"NEWS.md"
+ "%INIT_APPLICATION_NAME.1.md"
];
formatter = {
clang-format = {