checkpoint: render templates

This commit is contained in:
Dan Anglin 2024-09-10 13:51:37 +01:00
parent 125c31e78e
commit bb3e0e730c
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
13 changed files with 236 additions and 598 deletions

View file

@ -269,60 +269,53 @@ entries_per_page = 20
[theme]
# Atom One Dark theme ported to Amfora
# by Serge Tymoshenko <serge@tymo.name>
# Link: https://github.com/makeworld-the-better-one/amfora/blob/master/contrib/themes/one_dark.toml
# Tokyo Night
bg = "#282c34"
fg = "#abb2bf"
tab_num = "#abb2bf"
tab_divider = "#abb2bf"
bottombar_bg = "#abb2bf"
bottombar_text = "#282c34"
bottombar_label = "#282c34"
bg = "#1a1b26"
fg = "#a9b1d6"
tab_num = "#565f89"
tab_divider = "#3b4261"
bottombar_label = "#7aa2f7"
bottombar_text = "#7aa2f7"
bottombar_bg = "#1f2335"
scrollbar = "#565f89"
hdg_1 = "#e06c75"
hdg_2 = "#c678dd"
hdg_3 = "#c678dd"
amfora_link = "#61afef"
foreign_link = "#56b6c2"
link_number = "#abb2bf"
regular_text = "#abb2bf"
quote_text = "#98c379"
preformatted_text = "#e5c07b"
list_text = "#abb2bf"
hdg_1 = "#f7768e"
hdg_2 = "#7dcfff"
hdg_3 = "#bb9af7"
amfora_link = "#73daca"
foreign_link = "#b4f9f8"
link_number = "#ff9e64"
regular_text = "#a9b1d6"
quote_text = "#e0af68"
preformatted_text = "#2ac3de"
list_text = "#a9b1d6"
btn_bg = "#282c34"
btn_text = "#abb2bf"
btn_bg = "#414868"
btn_text = "#7aa2f7"
dl_choice_modal_bg = "#98c379"
dl_choice_modal_text = "#282c34"
dl_choice_modal_bg = "#414868"
dl_choice_modal_text = "#c0caf5"
dl_modal_bg = "#414868"
dl_modal_text = "#c0caf5"
info_modal_bg = "#414868"
info_modal_text = "#c0caf5"
error_modal_bg = "#414868"
error_modal_text = "#f7768e"
yesno_modal_bg = "#414868"
yesno_modal_text = "#e0af68"
tofu_modal_bg = "#414868"
tofu_modal_text = "#2ac3de"
subscription_modal_bg = "#414868"
subscription_modal_text = "#bb9af7"
dl_modal_bg = "#98c379"
dl_modal_text = "#282c34"
input_modal_bg = "#414868"
input_modal_text = "#c0caf5"
input_modal_field_bg = "#33467c"
input_modal_field_text = "#a9b1d6"
info_modal_bg = "#98c379"
info_modal_text = "#282c34"
error_modal_bg = "#e06c75"
error_modal_text = "#282c34"
yesno_modal_bg = "#e5c07b"
yesno_modal_text = "#282c34"
tofu_modal_bg = "#e5c07b"
tofu_modal_text = "#282c34"
input_modal_bg = "#98c379"
input_modal_text = "#282c34"
input_modal_field_bg = "#282c34"
input_modal_field_text = "#abb2bf"
bkmk_modal_bg = "#98c379"
bkmk_modal_text = "#282c34"
bkmk_modal_label = "#282c34"
bkmk_modal_field_bg = "#282c34"
bkmk_modal_field_text = "#abb2bf"
subscription_modal_bg = "#c678dd"
subscription_modal_text = "#282c34"
bkmk_modal_bg = "#414868"
bkmk_modal_text = "#c0caf5"
bkmk_modal_label = "#c0caf5"
bkmk_modal_field_bg = "#33467c"
bkmk_modal_field_text = "#a9b1d6"

View file

@ -1,3 +1,4 @@
#set-option -g default-terminal "tmux-256color"
set-option -g default-terminal "$TERM"
set-option -ag terminal-overrides ",$TERM:Tc"
set-option -g default-shell /usr/bin/bash

View file

@ -7,6 +7,7 @@ import (
"fmt"
"io/fs"
"os"
"path/filepath"
)
const (
@ -47,3 +48,74 @@ func ensureDirectory(path string) error {
return nil
}
func ensureSymlink(source, dest string) error {
absolutePathErrorMessageFormat := "unable to get the absolute path to %s: %w"
absoluteSourcePath, err := filepath.Abs(source)
if err != nil {
return fmt.Errorf(absolutePathErrorMessageFormat, source, err)
}
absoluteDestPath, err := filepath.Abs(dest)
if err != nil {
return fmt.Errorf(absolutePathErrorMessageFormat, dest, err)
}
destInfo, err := os.Lstat(absoluteDestPath)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
fmt.Printf("Linking %s to %s\n", absoluteDestPath, absoluteSourcePath)
if err := os.Symlink(absoluteSourcePath, absoluteDestPath); err != nil {
return fmt.Errorf(
"unable to symlink %s to %s: %w",
absoluteDestPath,
absoluteSourcePath,
err,
)
}
return nil
}
return fmt.Errorf("unable to get the file info for %s: %w", absoluteDestPath, err)
}
if destInfo.Mode().Type() != fs.ModeSymlink {
return fmt.Errorf("the path %s exists but it is not a symlink", absoluteDestPath)
}
destLinksTo, err := filepath.EvalSymlinks(absoluteDestPath)
if err != nil {
return fmt.Errorf("unable to evaluate the symlink %s: %w", absoluteDestPath, err)
}
if destLinksTo == absoluteSourcePath {
return nil
}
fmt.Printf(
"%s should link back to %s but instead links back to %s\n",
absoluteDestPath,
absoluteSourcePath,
destLinksTo,
)
fmt.Println("Recreating:", absoluteDestPath)
if err := os.Remove(absoluteDestPath); err != nil {
return fmt.Errorf("unable to remove %s: %w", absoluteDestPath, err)
}
if err := os.Symlink(absoluteSourcePath, absoluteDestPath); err != nil {
return fmt.Errorf(
"unable to symlink %s to %s: %w",
absoluteDestPath,
absoluteSourcePath,
err,
)
}
return nil
}

View file

@ -28,7 +28,7 @@ type configGit struct {
type configGitUser struct {
Email string `json:"email"`
User string `json:"user"`
Name string `json:"name"`
SigningKey string `json:"signingKey"`
}
@ -81,7 +81,7 @@ func defaultConfig() config {
GpgSign: false,
User: configGitUser{
Email: "",
User: "",
Name: "",
SigningKey: "",
},
},

View file

@ -3,7 +3,6 @@
package main
import (
"errors"
"fmt"
"io/fs"
"os"
@ -68,74 +67,3 @@ func manageFilesFunc(homeConfigDirectory string) fs.WalkDirFunc {
return nil
}
}
func ensureSymlink(source, dest string) error {
absolutePathErrorMessageFormat := "unable to get the absolute path to %s: %w"
absoluteSourcePath, err := filepath.Abs(source)
if err != nil {
return fmt.Errorf(absolutePathErrorMessageFormat, source, err)
}
absoluteDestPath, err := filepath.Abs(dest)
if err != nil {
return fmt.Errorf(absolutePathErrorMessageFormat, dest, err)
}
destInfo, err := os.Lstat(absoluteDestPath)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
fmt.Printf("Linking %s to %s\n", absoluteDestPath, absoluteSourcePath)
if err := os.Symlink(absoluteSourcePath, absoluteDestPath); err != nil {
return fmt.Errorf(
"unable to symlink %s to %s: %w",
absoluteDestPath,
absoluteSourcePath,
err,
)
}
return nil
}
return fmt.Errorf("unable to get the file info for %s: %w", absoluteDestPath, err)
}
if destInfo.Mode().Type() != fs.ModeSymlink {
return fmt.Errorf("the path %s exists but it is not a symlink", absoluteDestPath)
}
destLinksTo, err := filepath.EvalSymlinks(absoluteDestPath)
if err != nil {
return fmt.Errorf("unable to evaluate the symlink %s: %w", absoluteDestPath, err)
}
if destLinksTo == absoluteSourcePath {
return nil
}
fmt.Printf(
"%s should link back to %s but instead links back to %s\n",
absoluteDestPath,
absoluteSourcePath,
destLinksTo,
)
fmt.Println("Recreating:", absoluteDestPath)
if err := os.Remove(absoluteDestPath); err != nil {
return fmt.Errorf("unable to remove %s: %w", absoluteDestPath, err)
}
if err := os.Symlink(absoluteSourcePath, absoluteDestPath); err != nil {
return fmt.Errorf(
"unable to symlink %s to %s: %w",
absoluteDestPath,
absoluteSourcePath,
err,
)
}
return nil
}

117
magefiles/templates.go Normal file
View file

@ -0,0 +1,117 @@
//go:build mage
package main
import (
"fmt"
"io/fs"
"os"
"path/filepath"
"slices"
"strings"
"text/template"
)
const templateExtension string = ".gotmpl"
func Templates() error {
homeConfigDirectory, err := os.UserConfigDir()
if err != nil {
return fmt.Errorf("unable to get the user's home configuration directory: %w", err)
}
config, err := newConfig()
if err != nil {
return fmt.Errorf("unable to load the configuration: %w", err)
}
if err = filepath.WalkDir(rootTemplateDir, manageTemplatesFunc(homeConfigDirectory, config)); err != nil {
return fmt.Errorf("received an error while processing the templates: %w", err)
}
return nil
}
func manageTemplatesFunc(homeConfigDirectory string, config config) fs.WalkDirFunc {
funcMap := template.FuncMap{
"env": env,
}
return func(templatePath string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
if templatePath == rootTemplateDir {
return nil
}
relativePath := strings.TrimPrefix(templatePath, rootTemplateDir+"/")
if d.IsDir() {
managedDir := filepath.Join(rootManagedDir, relativePath)
configDir := filepath.Join(homeConfigDirectory, relativePath)
dirs := []string{managedDir, configDir}
for _, dir := range slices.All(dirs) {
if err := ensureDirectory(dir); err != nil {
return fmt.Errorf("unable to ensure the existence of the directory %q: %w", dir, err)
}
}
return nil
}
if !strings.HasSuffix(templatePath, templateExtension) {
return fmt.Errorf(
"the template %s does not have the %q file extension",
templatePath,
templateExtension,
)
}
managedPath := filepath.Join(rootManagedDir, strings.TrimSuffix(relativePath, templateExtension))
configPath := filepath.Join(homeConfigDirectory, strings.TrimSuffix(relativePath, templateExtension))
if err := renderTemplate(config, templatePath, managedPath, funcMap); err != nil {
return fmt.Errorf(
"unable to generate %s from template %s: %w",
managedPath,
templatePath,
err,
)
}
if err := ensureSymlink(managedPath, configPath); err != nil {
return err
}
return nil
}
}
func renderTemplate(config config, templatePath, managedPath string, funcMap template.FuncMap) error {
name := filepath.Base(templatePath)
tmpl, err := template.New(name).Funcs(funcMap).ParseFiles(templatePath)
if err != nil {
return fmt.Errorf("unable to create a new template value from %s: %w", templatePath, err)
}
output, err := os.Create(managedPath)
if err != nil {
return fmt.Errorf("unable to create %s: %w", managedPath, err)
}
defer output.Close()
if err := tmpl.Execute(output, config); err != nil {
return fmt.Errorf("unable to render the template to %s: %w", managedPath, err)
}
return nil
}
func env(value string) string {
return os.Getenv(value)
}

View file

@ -1,20 +0,0 @@
#!/usr/bin/env bash
[[ -f "${HOME}/.bashrc" ]] && source "${HOME}/.bashrc"
# Start dunst
if [ -x "$( command -v dunst )" ]; then
dunst &
fi
# Load the wallpaper
xwallpaper --stretch ~/.local/config/wallpaper/wallpaper.png &
# Rotate the home logs with logrotate
logrotate \
--state=${XDG_STATE_HOME}/logrotate/status \
--log=${LOG_HOME}/logrotate.log \
${XDG_CONFIG_HOME}/logrotate/logrotate.conf \
&
exec startdwm

View file

@ -1,10 +0,0 @@
[defaults]
nocows = 1
cow_selection = default
interpreter_python = /usr/bin/python3
[persistent_connection]
connect_timeout = 30
command_timeout = 60

View file

@ -1,5 +0,0 @@
---
all:
hosts:
localhost:
ansible_connection: local

View file

@ -1,438 +0,0 @@
# See dunst(5) for all configuration options
[global]
### Display ###
# Which monitor should the notifications be displayed on.
monitor = 0
# Display notification on focused monitor. Possible modes are:
# mouse: follow mouse pointer
# keyboard: follow window with keyboard focus
# none: don't follow anything
#
# "keyboard" needs a window manager that exports the
# _NET_ACTIVE_WINDOW property.
# This should be the case for almost all modern window managers.
#
# If this option is set to mouse or keyboard, the monitor option
# will be ignored.
follow = keyboard
### Geometry ###
# dynamic width from 0 to 300
# width = (0, 300)
# constant width of 300
width = 300
# The maximum height of a single notification, excluding the frame.
height = 300
# Position the notification in the top right corner
origin = top-right
# Offset from the origin
offset = 20x40
# Scale factor. It is auto-detected if value is 0.
scale = 0
# Maximum number of notification (0 means no limit)
notification_limit = 3
### Progress bar ###
# Turn on the progess bar. It appears when a progress hint is passed with
# for example dunstify -h int:value:12
progress_bar = true
# Set the progress bar height. This includes the frame, so make sure
# it's at least twice as big as the frame width.
progress_bar_height = 10
# Set the frame width of the progress bar
progress_bar_frame_width = 1
# Set the minimum width for the progress bar
progress_bar_min_width = 150
# Set the maximum width for the progress bar
progress_bar_max_width = 300
# Show how many messages are currently hidden (because of
# notification_limit).
indicate_hidden = yes
# The transparency of the window. Range: [0; 100].
# This option will only work if a compositing window manager is
# present (e.g. xcompmgr, compiz, etc.). (X11 only)
transparency = 0
# Draw a line of "separator_height" pixel height between two
# notifications.
# Set to 0 to disable.
separator_height = 2
# Padding between text and separator.
padding = 8
# Horizontal padding.
horizontal_padding = 8
# Padding between text and icon.
text_icon_padding = 0
# Defines width in pixels of frame around the notification window.
# Set to 0 to disable.
frame_width = 2
# Defines color of the frame around the notification window.
frame_color = "#bb9af7"
# Define a color for the separator.
# possible values are:
# * auto: dunst tries to find a color fitting to the background;
# * foreground: use the same color as the foreground;
# * frame: use the same color as the frame;
# * anything else will be interpreted as a X color.
separator_color = frame
# Sort messages by urgency.
sort = yes
# Don't remove messages, if the user is idle (no mouse or keyboard input)
# for longer than idle_threshold seconds.
# Set to 0 to disable.
# A client can set the 'transient' hint to bypass this. See the rules
# section for how to disable this if necessary
idle_threshold = 120
### Text ###
font = Source Code Pro 12
# The spacing between lines. If the height is smaller than the
# font height, it will get raised to the font height.
line_height = 0
# Possible values are:
# full: Allow a small subset of html markup in notifications:
# <b>bold</b>
# <i>italic</i>
# <s>strikethrough</s>
# <u>underline</u>
#
# For a complete reference see
# <https://docs.gtk.org/Pango/pango_markup.html>.
#
# strip: This setting is provided for compatibility with some broken
# clients that send markup even though it's not enabled on the
# server. Dunst will try to strip the markup but the parsing is
# simplistic so using this option outside of matching rules for
# specific applications *IS GREATLY DISCOURAGED*.
#
# no: Disable markup parsing, incoming notifications will be treated as
# plain text. Dunst will not advertise that it has the body-markup
# capability if this is set as a global setting.
#
# It's important to note that markup inside the format option will be parsed
# regardless of what this is set to.
markup = full
# The format of the message. Possible variables are:
# %a appname
# %s summary
# %b body
# %i iconname (including its path)
# %I iconname (without its path)
# %p progress value if set ([ 0%] to [100%]) or nothing
# %n progress value if set without any extra characters
# %% Literal %
# Markup is allowed
format = "<b>%s</b>\n%b"
# Alignment of message text.
# Possible values are "left", "center" and "right".
alignment = left
# Vertical alignment of message text and icon.
# Possible values are "top", "center" and "bottom".
vertical_alignment = center
# Show age of message if message is older than show_age_threshold
# seconds.
# Set to -1 to disable.
show_age_threshold = 60
# Specify where to make an ellipsis in long lines.
# Possible values are "start", "middle" and "end".
ellipsize = middle
# Ignore newlines '\n' in notifications.
ignore_newline = no
# Stack together notifications with the same content
stack_duplicates = true
# Hide the count of stacked notifications with the same content
hide_duplicate_count = false
# Display indicators for URLs (U) and actions (A).
show_indicators = yes
### Icons ###
# Align icons left/right/top/off
icon_position = left
# Scale small icons up to this size, set to 0 to disable. Helpful
# for e.g. small files or high-dpi screens. In case of conflict,
# max_icon_size takes precedence over this.
min_icon_size = 0
# Scale larger icons down to this size, set to 0 to disable
max_icon_size = 32
# Paths to default icons.
icon_path = /usr/share/icons/gnome/16x16/status/:/usr/share/icons/gnome/16x16/devices/
### History ###
# Should a notification popped up from history be sticky or timeout
# as if it would normally do.
sticky_history = yes
# Maximum amount of notifications kept in history
history_length = 20
### Misc/Advanced ###
# dmenu path.
dmenu = /usr/bin/dmenu -p dunst:
# Browser for opening urls in context menu.
browser = /usr/bin/xdg-open
# Always run rule-defined scripts, even if the notification is suppressed
always_run_script = true
# Define the title of the windows spawned by dunst
title = Dunst
# Define the class of the windows spawned by dunst
class = Dunst
# Define the corner radius of the notification window
# in pixel size. If the radius is 0, you have no rounded
# corners.
# The radius will be automatically lowered if it exceeds half of the
# notification height to avoid clipping text and/or icons.
corner_radius = 2
# Ignore the dbus closeNotification message.
# Useful to enforce the timeout set by dunst configuration. Without this
# parameter, an application may close the notification sent before the
# user defined timeout.
ignore_dbusclose = false
### Wayland ###
# These settings are Wayland-specific. They have no effect when using X11
# Uncomment this if you want to let notications appear under fullscreen
# applications (default: overlay)
# layer = top
# Set this to true to use X11 output on Wayland.
force_xwayland = false
### Legacy
# Use the Xinerama extension instead of RandR for multi-monitor support.
# This setting is provided for compatibility with older nVidia drivers that
# do not support RandR and using it on systems that support RandR is highly
# discouraged.
#
# By enabling this setting dunst will not be able to detect when a monitor
# is connected or disconnected which might break follow mode if the screen
# layout changes.
force_xinerama = false
### mouse
# Defines list of actions for each mouse event
# Possible values are:
# * none: Don't do anything.
# * do_action: Invoke the action determined by the action_name rule. If there is no
# such action, open the context menu.
# * open_url: If the notification has exactly one url, open it. If there are multiple
# ones, open the context menu.
# * close_current: Close current notification.
# * close_all: Close all notifications.
# * context: Open context menu for the notification.
# * context_all: Open context menu for all notifications.
# These values can be strung together for each mouse event, and
# will be executed in sequence.
mouse_left_click = close_current
mouse_middle_click = do_action, close_current
mouse_right_click = close_all
# Experimental features that may or may not work correctly. Do not expect them
# to have a consistent behaviour across releases.
[experimental]
# Calculate the dpi to use on a per-monitor basis.
# If this setting is enabled the Xft.dpi value will be ignored and instead
# dunst will attempt to calculate an appropriate dpi value for each monitor
# using the resolution and physical size. This might be useful in setups
# where there are multiple screens with very different dpi values.
per_monitor_dpi = false
[urgency_low]
# IMPORTANT: colors have to be defined in quotation marks.
# Otherwise the "#" and following would be interpreted as a comment.
background = "#222222"
foreground = "#888888"
timeout = 10
# Icon for notifications with low urgency, uncomment to enable
#default_icon = /path/to/icon
[urgency_normal]
background = "#285577"
foreground = "#ffffff"
timeout = 10
# Icon for notifications with normal urgency, uncomment to enable
#default_icon = /path/to/icon
[urgency_critical]
background = "#900000"
foreground = "#ffffff"
frame_color = "#ff0000"
timeout = 0
# Icon for notifications with critical urgency, uncomment to enable
#default_icon = /path/to/icon
# Every section that isn't one of the above is interpreted as a rules to
# override settings for certain messages.
#
# Messages can be matched by
# appname (discouraged, see desktop_entry)
# body
# category
# desktop_entry
# icon
# match_transient
# msg_urgency
# stack_tag
# summary
#
# and you can override the
# background
# foreground
# format
# frame_color
# fullscreen
# new_icon
# set_stack_tag
# set_transient
# set_category
# timeout
# urgency
# icon_position
# skip_display
# history_ignore
# action_name
# word_wrap
# ellipsize
# alignment
# hide_text
#
# Shell-like globbing will get expanded.
#
# Instead of the appname filter, it's recommended to use the desktop_entry filter.
# GLib based applications export their desktop-entry name. In comparison to the appname,
# the desktop-entry won't get localized.
#
# SCRIPTING
# You can specify a script that gets run when the rule matches by
# setting the "script" option.
# The script will be called as follows:
# script appname summary body icon urgency
# where urgency can be "LOW", "NORMAL" or "CRITICAL".
#
# NOTE: It might be helpful to run dunst -print in a terminal in order
# to find fitting options for rules.
# Disable the transient hint so that idle_threshold cannot be bypassed from the
# client
#[transient_disable]
# match_transient = yes
# set_transient = no
#
# Make the handling of transient notifications more strict by making them not
# be placed in history.
#[transient_history_ignore]
# match_transient = yes
# history_ignore = yes
# fullscreen values
# show: show the notifications, regardless if there is a fullscreen window opened
# delay: displays the new notification, if there is no fullscreen window active
# If the notification is already drawn, it won't get undrawn.
# pushback: same as delay, but when switching into fullscreen, the notification will get
# withdrawn from screen again and will get delayed like a new notification
#[fullscreen_delay_everything]
# fullscreen = delay
#[fullscreen_show_critical]
# msg_urgency = critical
# fullscreen = show
#[espeak]
# summary = "*"
# script = dunst_espeak.sh
#[script-test]
# summary = "*script*"
# script = dunst_test.sh
#[ignore]
# # This notification will not be displayed
# summary = "foobar"
# skip_display = true
#[history-ignore]
# # This notification will not be saved in history
# summary = "foobar"
# history_ignore = yes
#[skip-display]
# # This notification will not be displayed, but will be included in the history
# summary = "foobar"
# skip_display = yes
#[signed_on]
# appname = Pidgin
# summary = "*signed on*"
# urgency = low
#
#[signed_off]
# appname = Pidgin
# summary = *signed off*
# urgency = low
#
#[says]
# appname = Pidgin
# summary = *says*
# urgency = critical
#
#[twitter]
# appname = Pidgin
# summary = *twitter.com*
# urgency = normal
#
#[stack-volumes]
# appname = "some_volume_notifiers"
# set_stack_tag = "volume"
#
# vim: ft=cfg