2022-12-16 05:11:16 +01:00
# ABOUT
# - In this Makefile, 'building a file' means:
# - if the file has a '.html' extension: run the html preprocessor on the file and place the output in the output directory
2023-11-19 17:10:16 +01:00
# - elif the file has a '.sass' or '.scss' extension: run the sass compiler on the file and place the output in the output directory
2022-12-16 05:11:16 +01:00
# - else: copy the file to the output directory
# - Folder structure from source directories will be preserved in the output directory
# - Abbreviations:
# - FLS: files
# - DIR: directory
# - SRC: source
# - LANG: language
# - PP: preprocessor
# - DEP: dependency
#
# NORMAL SETTINGS
# change these to fir your project
#
2023-09-29 16:05:51 +02:00
# root dir for the project, all other paths relative to PROJECT_DIR (except for OUT_DIR and DEP_DIR)
PROJECT_DIR = src
2022-12-16 05:11:16 +01:00
# path where final website will be in, this one is not relative to PROJECT_DIR
2023-09-29 16:05:51 +02:00
OUT_DIR = build
2022-12-16 05:11:16 +01:00
# SOURCE FILES:
2023-09-29 16:05:51 +02:00
# all SRC_FLS and all files (recursively) in the SRC_DIRS will be built
# all files in PROJECT_DIR (not recursively) are source files
2023-11-19 17:05:54 +01:00
SRC_DIRS = de en script
2023-09-29 16:05:51 +02:00
SRC_FLS =
2022-12-16 05:11:16 +01:00
2023-11-19 17:05:54 +01:00
# CSS FILES:
# directories which may contain sass and scss to compile sass to a correspondig css in OUT_DIR/CSS_DIR (also css, it will simply be copied)
CSS_DIRS = style
CSS_FILES =
2022-12-16 05:11:16 +01:00
# SOURCE FILES:
# all RESOURCE_FLS and all files in the RESOURCE_DIRS will be copied to OUT_DIR
RESOURCE_DIRS = resources
RESOURCE_FLS =
# MULTI-LANG SOURCE FILES:
# the files in COMMON_DIR will be built for all LANGS:
# foreach html-file in COMMON_DIR:
# foreach lang in LANGS:
# run HTML_PP_CMD with --var lang=lang on file and output to OUT_DIR without the COMMON_DIR prefix, so COMMON_DIR/subdir/file.html -> OUT_DIR/lang/subdir/file.html
# all non-html files will handled the same way, but without the preprocessor being run on them. They are simply copied
2023-09-29 16:05:51 +02:00
# leave COMMON_DIR empty to disable multi-lang feature
COMMON_DIR =
2022-12-16 05:11:16 +01:00
LANGS = de en
# PREPROCESSOR
# path to of the files that should be included
INCLUDE_DIR = include
2023-11-19 17:05:54 +01:00
# additional search paths passed to sass compiler
SASS_INCLUDE_DIRS = include/style
2022-12-16 05:11:16 +01:00
# ADVANCED
# the command to run the html preprocessor
2023-09-29 16:05:51 +02:00
HTML_PP_CMD = python3 html-preprocessor --exit-on light
2023-11-19 17:05:54 +01:00
# command to compile sass and scss files with
# --indented is added for sass and --no-indented for scss
# --source-maps-urls=absolute is appended for generating dependency files
SASS_CMD = sass --color
2022-12-16 05:11:16 +01:00
DEP_DIR = .dependencies
#
# NOT SETTINGS ANYMORE
# DO NOT CHANGE ANYTHING HERE UNLESS YOU KNOW WHAT YOU ARE DOING!
#
# all variables starting with _ are relative to PROJECT_DIR
# make everything relative to PROJECT_DIR
_SRC_DIRS = $( addprefix $( PROJECT_DIR) /, $( SRC_DIRS) )
_SRC_FLS = $( addprefix $( PROJECT_DIR) /, $( SRC_FLS) )
2023-11-19 17:05:54 +01:00
_CSS_FLS = $( addprefix $( PROJECT_DIR) /, $( CSS_FLS) )
_CSS_DIRS = $( addprefix $( PROJECT_DIR) /, $( CSS_DIRS) )
_SASS_INCLUDE_DIRS = $( addprefix $( PROJECT_DIR) /, $( SASS_INCLUDE_DIRS) )
2022-12-16 05:11:16 +01:00
_RES_DIRS = $( addprefix $( PROJECT_DIR) /, $( RESOURCE_DIRS) )
_RES_FLS = $( addprefix $( PROJECT_DIR) /, $( RESOURCE_FLS) )
_COMMON_DIR = $( addprefix $( PROJECT_DIR) /, $( COMMON_DIR) )
_INCLUDE_DIR = $( addprefix $( PROJECT_DIR) /, $( INCLUDE_DIR) )
# NORMAL SRC
2023-11-19 17:05:54 +01:00
# all SRC_DIRS + CSS_DIRS + all subdirs of each srcdir
_SRC_SUB_DIRS = $( foreach srcdir, $( _SRC_DIRS) $( _CSS_DIRS) , $( shell find $( srcdir) / -type d 2>/dev/null) )
2023-09-29 16:05:51 +02:00
# add files in project dir
_SRC_FLS += $( shell find $( PROJECT_DIR) / -maxdepth 1 -type f)
# add files src dirs, recursively
_SRC_FLS += $( foreach srcdir, $( _SRC_DIRS) , $( shell find $( srcdir) / -type f 2>/dev/null) )
2023-11-19 17:05:54 +01:00
_CSS_FLS += $( foreach srcdir, $( _CSS_DIRS) , $( shell find $( srcdir) / -type f 2>/dev/null) )
OUT_DIRS = $( OUT_DIR) / $( patsubst $( PROJECT_DIR) /%, $( OUT_DIR) /%, $( _SRC_SUB_DIRS) )
# path of the (css/sass) source files after being processed
OUT_FLS = $( patsubst $( PROJECT_DIR) /%, $( OUT_DIR) /%, $( _SRC_FLS) )
OUT_FLS += $( patsubst $( PROJECT_DIR) /%, $( OUT_DIR) /%, $( foreach cssfile, $( _CSS_FLS) , $( shell echo $( cssfile) | sed 's/\.s[ac]ss$$/.css/' ) ) )
2022-12-16 05:11:16 +01:00
# RESOURCES
2023-09-29 16:05:51 +02:00
_RES_SUB_DIRS = $( foreach srcdir, $( _RES_DIRS) , $( shell find $( srcdir) / -type d 2>/dev/null) )
_RES_FLS += $( foreach srcdir, $( _RES_DIRS) , $( shell find $( srcdir) / -type f 2>/dev/null) )
2022-12-16 05:11:16 +01:00
RES_OUT_DIRS = $( OUT_DIR) / $( patsubst $( PROJECT_DIR) /%, $( OUT_DIR) /%, $( _RES_SUB_DIRS) )
RES_OUT_FLS = $( patsubst $( PROJECT_DIR) /%, $( OUT_DIR) /%, $( _RES_FLS) )
# MULTILANG
2023-09-29 16:05:51 +02:00
i f d e f C O M M O N _ D I R
2022-12-16 05:11:16 +01:00
_ML_SRC_FLS = $( shell find $( _COMMON_DIR) / -type f)
_ML_SRC_SUB_DIRS = $( shell find $( _COMMON_DIR) / -type d)
# will contain one subdir for each lang, each of which contains every file from ML_SRC_FLS
ML_OUT_DIR = $( OUT_DIR)
ML_OUT_LANG_DIRS = $( foreach lang, $( LANGS) , $( addprefix $( ML_OUT_DIR) /, $( lang) ) )
ML_OUT_DIRS = $( foreach lang, $( LANGS) , $( patsubst $( _COMMON_DIR) /%, $( ML_OUT_DIR) /$( lang) /%, $( _ML_SRC_SUB_DIRS) ) )
ML_OUT_FLS = $( foreach lang, $( LANGS) , $( patsubst $( _COMMON_DIR) /%, $( ML_OUT_DIR) /$( lang) /%, $( _ML_SRC_FLS) ) )
2023-09-29 16:05:51 +02:00
e n d i f
2022-12-16 05:11:16 +01:00
# needed for creating them
2023-09-29 16:05:51 +02:00
_DEP_DIRS = $( sort $( patsubst $( OUT_DIR) /%, $( DEP_DIR) /%, $( OUT_DIRS) $( ML_OUT_DIRS) ) )
2022-12-16 05:11:16 +01:00
# needed for reading
2023-09-29 16:05:51 +02:00
_DEP_FLS = $( shell find $( DEP_DIR) -type f -name '*.d' 2>/dev/null)
2022-12-16 05:11:16 +01:00
2023-11-19 17:05:54 +01:00
# SASS, add load-paths
_SASS_CMD = $( SASS_CMD) $( foreach includedir, $( _SASS_INCLUDE_DIRS) , --load-path= $( includedir) ) --source-map-urls= absolute
2022-12-16 05:11:16 +01:00
# PRINTING
FMT_VAR_SRC = "Variable '\e[1;34m%s\e[0m': \e[0;33m%s\e[0m\n"
FMT_VAR_OUT = "Variable '\e[1;34m%s\e[0m': \e[0;35m%s\e[0m\n"
FMT_DIR = "\e[1;34mMaking directory\e[0m: \e[0;35m%s\e[0m\n"
FMT_OUT_HTML = "\e[1;34mBuilding html\e[0m \e[1;33m%s\e[0m at \e[1;35m%s\e[0m\n"
2023-11-19 17:05:54 +01:00
FMT_OUT_CSS = "\e[1;34mBuilding css\e[0m \e[1;33m%s\e[0m at \e[1;35m%s\e[0m\n"
2022-12-16 05:11:16 +01:00
FMT_OUT_OTHER = "\e[1;34mBuilding\e[0m: \e[1;33m%s\e[0m at \e[1;35m%s\e[0m\n"
FMT_OUT_ML_HTML = "\e[1;34mBuilding html\e[0m in lang \e[1;34m%s\e[0m: \e[1;33m%s\e[0m at \e[1;35m%s\e[0m\n"
FMT_OUT_ML_OTHER = "\e[1;34mBuilding\e[0m in lang \e[1;34m%s\e[0m: \e[1;33m%s\e[0m at \e[1;35m%s\e[0m\n"
.SUFFIXES :
.SUFFIXES : .html .md
.PHONY : default normal multilang resources print start stop clean cleaner
.DEFAULT_GOAL = all
# include all the dependency makefiles
i n c l u d e $( _DEP_FLS )
all : normal multilang resources
normal : $( OUT_FLS )
multilang : $( ML_OUT_FLS )
resources : $( RES_OUT_FLS )
print :
@printf $( FMT_VAR_SRC) "PROJECT_DIR" " $( PROJECT_DIR) "
@printf $( FMT_VAR_OUT) "OUT_DIRS" " $( OUT_DIRS) "
@printf $( FMT_VAR_SRC) "_INCLUDE_DIR" " $( _INCLUDE_DIR) "
@printf $( FMT_VAR_SRC) "_SRC_FLS" " $( _SRC_FLS) "
@printf $( FMT_VAR_OUT) "OUT_FLS" " $( OUT_FLS) "
@printf $( FMT_VAR_SRC) "_RES_FLS" " $( _RES_FLS) "
@printf $( FMT_VAR_OUT) "RES_OUT_FLS" " $( RES_OUT_FLS) "
2023-11-19 17:05:54 +01:00
@printf $( FMT_VAR_OUT) "_CSS_FLS" " $( _CSS_FLS) "
2023-09-29 16:05:51 +02:00
i f d e f C O M M O N _ D I R
2022-12-16 05:11:16 +01:00
@printf $( FMT_VAR_SRC) "_ML_SRC_FLS" " $( _ML_SRC_FLS) "
@printf $( FMT_VAR_OUT) "ML_OUT_FLS" " $( ML_OUT_FLS) "
2023-09-29 16:05:51 +02:00
e n d i f
2022-12-16 05:11:16 +01:00
@printf $( FMT_VAR_SRC) "_DEP_FLS" " $( _DEP_FLS) "
@# @printf $( FMT_VAR_SRC) "y" " $( y) "
2023-09-29 16:05:51 +02:00
# DIRECTORIES
2022-12-16 05:11:16 +01:00
$(sort $(ML_OUT_DIRS) $(_DEP_DIRS) $(RES_OUT_DIRS) $(OUT_DIRS)) :
@printf $( FMT_DIR) " $@ "
@mkdir -p $@
2023-09-29 16:05:51 +02:00
# MULTILANG RULES
i f d e f C O M M O N _ D I R
# $@ is the target to trigger the rule, but all languages have to be built now
2022-12-16 05:11:16 +01:00
$(foreach out_dir, $(ML_OUT_LANG_DIRS), $(out_dir)/%.html) : $( _COMMON_DIR ) /%.html | $( ML_OUT_DIRS ) $( _DEP_DIRS )
2023-09-29 16:05:51 +02:00
@RAW_TARGET= ` echo $@ $( foreach lang, $( LANGS) , | sed 's|$(ML_OUT_DIR)/$(lang)/||' ) ` ; \
for lang in $( LANGS) ; do \
target = $( ML_OUT_DIR) /$$ lang/$$ RAW_TARGET; \
printf $( FMT_OUT_ML_HTML) " $$ lang " " $< " " $$ target " ; \
$( HTML_PP_CMD) --input " $< " --output " $$ target " --var include_dir = $( _INCLUDE_DIR) --var lang = $$ lang --output-deps " `echo $$ {target}.d | sed 's| $( OUT_DIR) /| $( DEP_DIR) /|'` " ; \
done
2022-12-16 05:11:16 +01:00
# rule for all not html files
$(foreach out_dir, $(ML_OUT_LANG_DIRS), $(out_dir)/%) : $( _COMMON_DIR ) /% | $( ML_OUT_DIRS )
@lang= ` echo $( patsubst $( ML_OUT_DIR) /%, %, $@ ) | awk -F "/" '{print $$1}' ` ; \
printf $( FMT_OUT_ML_OTHER) " $$ lang " " $< " " $@ " ; \
cp $< $@
2023-09-29 16:05:51 +02:00
e n d i f
2022-12-16 05:11:16 +01:00
#
# (NORMAL/RE-)SOURCE RULES
#
2023-09-29 16:05:51 +02:00
$(OUT_DIR)/%.html : $( PROJECT_DIR ) /%.html | $( OUT_DIRS ) $( _DEP_DIRS )
2022-12-16 05:11:16 +01:00
@printf $( FMT_OUT_HTML) " $< " " $@ " ;
2023-09-29 16:05:51 +02:00
@$( HTML_PP_CMD) --input " $< " --output " $@ " --var include_dir = $( _INCLUDE_DIR) --output-deps " $( subst $( DEP_DIR) /$( PROJECT_DIR) , $( DEP_DIR) , $( DEP_DIR) /$<.d) " ;
2022-12-16 05:11:16 +01:00
@# remove comments and empty lines. two separate lines bc the substitution might create new empty lines
@#awk -i inplace '{FS="" sub(/<!--.*-->/,"")}1' $@
@#awk -i inplace '{if (NF != 0) print}' $@
2023-11-19 17:05:54 +01:00
$(OUT_DIR)/%.css : $( PROJECT_DIR ) /%.sass | $( OUT_DIRS ) $( _DEP_DIRS )
@printf $( FMT_OUT_CSS) " $< " " $@ " ;
@$( _SASS_CMD) --indented $< $@
@# generate a dependecy file from the source map and delete the map
@depfile= $( patsubst $( OUT_DIR) /%,$( DEP_DIR) /%,$@ ) .d; echo -n " $@ : " > " $$ depfile " ; \
jq -r '.sources | @sh' $@ .map | tr -d \' | sed 's|file://||g' >> " $$ depfile " ; \
rm $@ .map
$(OUT_DIR)/%.css : $( PROJECT_DIR ) /%.scss | $( OUT_DIRS ) $( _DEP_DIRS )
@printf $( FMT_OUT_CSS) " $< " " $@ " ;
@$( _SASS_CMD) --no-indented $< $@
@# generate a dependecy file from the source map and delete the map
@depfile= $( patsubst $( OUT_DIR) /%,$( DEP_DIR) /%,$@ ) .d; echo -n " $@ : " > " $$ depfile " ; \
jq -r '.sources | @sh' $@ .map | tr -d \' | sed 's|file://||g' >> " $$ depfile " ; \
rm $@ .map
2023-09-29 16:05:51 +02:00
$(OUT_DIR)/% : $( PROJECT_DIR ) /% | $( OUT_DIRS ) $( RES_OUT_DIRS )
2022-12-16 05:11:16 +01:00
@printf $( FMT_OUT_OTHER) " $< " " $@ "
@cp -r $< $@
# .DEFAULT:
# @echo "MISSING RULE: $@"
start :
/usr/sbin/nginx -c nginx.conf -p $( shell pwd ) &
firefox http://localhost:8080/
stop :
killall nginx
clean :
2023-11-19 17:05:54 +01:00
-@rm $( OUT_FLS) $( ML_OUT_FLS) 2>/dev/null
-@rm -r $( DEP_DIR) 2>/dev/null
2022-12-16 05:11:16 +01:00
cleaner :
2023-11-19 17:05:54 +01:00
-@rm -r $( OUT_DIR)
-@rm -r $( DEP_DIR) 2>/dev/null