Chore(lint): markdownlint config changes, tweak

.editorconfig

@@ -8,6 +8,9 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
+[*.php]
+indent_size = 4
+
 [.git{ignore,modules}]
 indent_style = tab
 indent_size = 1

.gitignore

@@ -7,3 +7,5 @@ Brewfile.lock.json
 config/fzf
 config/cheat/cheatsheets/pure-bash-bible/*
 config/cheat/cheatsheets/tldr/*
+!.gitkeep
+

.gitmodules

@@ -1,16 +1,16 @@
 # vim: set expandtab:
 [submodule "dotbot"]
-	path = dotbot
+	path = tools/dotbot
 	url = https://github.com/anishathalye/dotbot.git
 	ignore = dirty
 
 [submodule "dotbot-brew"]
-	path = dotbot-brew
+	path = tools/dotbot-brew
 	url = https://github.com/wren/dotbot-brew.git
 	ignore = dirty
 
 [submodule "dotbot-include"]
-	path = dotbot-include
+	path = tools/dotbot-include
 	url = https://gitlab.com/gnfzdz/dotbot-include.git
 	ignore = dirty
 

.markdownlint.json

@@ -0,0 +1,19 @@
+{
+  "extends": "markdownlint/style/prettier",
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "heading-style": {
+    "style": "atx"
+  },
+  "no-duplicate-heading": {
+    "siblings_only": true
+  },
+  "required-headings": false,
+  "ul-style": {
+    "style": "dash"
+  }
+}

.markdownlintignore

@@ -0,0 +1,5 @@
+config/cheat/cheatsheets/community/
+config/tmux/
+config/nvim/
+tools/
+

add-submodules.sh

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 
-git submodule add --name dotbot-brew -f https://github.com/wren/dotbot-brew.git dotbot-brew
-git submodule add --name dotbot-include -f https://gitlab.com/gnfzdz/dotbot-include.git dotbot-include
+git submodule add --name dotbot -f https://github.com/anishathalye/dotbot.git tools/dotbot
+git submodule add --name dotbot-brew -f https://github.com/wren/dotbot-brew.git tools/dotbot-brew
+git submodule add --name dotbot-include -f https://gitlab.com/gnfzdz/dotbot-include.git tools/dotbot-include
 git submodule add --name cheat-community -f https://github.com/cheat/cheatsheets.git config/cheat/cheatsheets/community
 git submodule add --name tmux/tpm -f https://github.com/tmux-plugins/tpm.git config/tmux/plugins/tpm
 

base/nbrc

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+###############################################################################
+# .nbrc
+#
+# Configuration file for `nb`, a command line note-taking, bookmarking,
+# and knowledge base application with encryption, search, Git-backed syncing,
+# and more in a single portable script.
+#
+# Edit this file manually or manage settings using the `nb settings`
+# subcommand. Configuration options are set as environment variables, eg:
+#   export NB_ENCRYPTION_TOOL=gpg
+#
+# https://github.com/xwmx/nb
+###############################################################################
+
+export NB_DIR="${NB_DIR:-$HOME/.local/state/nb}" # Set by `nb` • Mon May  8 15:25:12 EEST 2023
+
+export NB_COLOR_THEME="${NB_COLOR_THEME:-unicorn}" # Set by `nb` • Mon May  8 15:41:22 EEST 2023

base/zshrc

@@ -5,6 +5,10 @@ autoload -U colors zsh/terminfo
 colors
 setopt correct
 
+# Add completion scripts to zsh path
+fpath=(~/.config/zsh/completion $fpath)
+autoload -Uz compinit && compinit -i
+
 # Defaults
 export DOTFILES="$HOME/.dotfiles"
 # shellcheck source=shared.sh
@@ -43,4 +47,6 @@ have antigen && {
 # starship is present
 have starship && eval "$(starship init zsh)"
 
-[ -f "${XDG_CONFIG_HOME:-$HOME/.config}"/fzf/fzf.zsh ] && source "${XDG_CONFIG_HOME:-$HOME/.config}"/fzf/fzf.zsh
+[ -f "${XDG_CONFIG_HOME:-$HOME/.config}"/fzf/fzf.zsh ] \
+  && source "${XDG_CONFIG_HOME:-$HOME/.config}"/fzf/fzf.zsh
+

config/astronvim/lua/user/plugins/community.lua

@@ -31,9 +31,14 @@ return {                      -- Add the community repository of plugin specific
   { import = "astrocommunity.editing-support.todo-comments-nvim" },
   { import = "astrocommunity.indent.mini-indentscope" },
   { import = "astrocommunity.markdown-and-latex.glow-nvim" },
+  { import = "astrocommunity.motion.harpoon" },
   { import = "astrocommunity.pack.php" },
   { import = "astrocommunity.pack.typescript" },
   { import = "astrocommunity.project.neoconf-nvim" },
+  { import = "astrocommunity.project.nvim-spectre" },
+  { import = "astrocommunity.project.project-nvim" },
   { import = "astrocommunity.test.neotest" },
   { import = "astrocommunity.utility.neodim" },
+  { import = "astrocommunity.utility.transparent-nvim" },
 }
+

config/exports-apps

@@ -72,6 +72,12 @@ have irssi && {
   x-dc "$IRSSI_CONFIG_HOME"
 }
 
+# nb, https://xwmx.github.io/nb/
+have nb && {
+  export NB_DIR="$XDG_STATE_HOME/nb"
+  x-dc "$NB_DIR"
+}
+
 # nvm, the node version manager
 export NVM_LAZY_LOAD=true
 export NVM_COMPLETION=true
@@ -80,6 +86,12 @@ export NVM_DIR="$XDG_CONFIG_HOME/nvm"
 [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"                   # This loads nvm
 [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion
 
+# Add npm packages to path
+have node && {
+  NVM_NODE_BIN_DIR="$(dirname "$(which node)")"
+  path_append "$NVM_NODE_BIN_DIR"
+}
+
 # op (1Password cli) is present
 have op && {
   export OP_CACHE="$XDG_STATE_HOME/1password"
@@ -111,3 +123,5 @@ export GNUPGHOME="$XDG_DATA_HOME/gnupg"
 export SCREENRC="$XDG_CONFIG_HOME/misc/screenrc"
 export TMUX_CONF="$DOTFILES/config/tmux/tmux.conf"
 export BAT_THEME="ansi"
+export CHEAT_USE_FZF=true
+

config/iterm2/com.googlecode.iterm2.plist

@@ -1230,6 +1230,8 @@
 			<string>kNextWindowPointerAction</string>
 		</dict>
 	</dict>
+	<key>PromptOnQuit</key>
+	<false/>
 	<key>SmartPlacement</key>
 	<true/>
 	<key>SoundForEsc</key>

config/zsh/completion/_nb

@@ -0,0 +1,174 @@
+#compdef nb
+###############################################################################
+# __          _
+# \ \   _ __ | |__
+#  \ \ | '_ \| '_ \
+#  / / | | | | |_) |
+# /_/  |_| |_|_.__/
+#
+# [nb] Command line and local web note-taking, bookmarking, and archiving with
+# plain text data storage, encryption, filtering and search, pinning, #tagging,
+# Git-backed versioning and syncing, Pandoc-backed conversion, global and local
+# notebooks, customizable color themes, [[wiki-style linking]], plugins, and
+# more in a single portable, user-friendly script.
+#
+# https://github.com/xwmx/nb
+###############################################################################
+_nb_subcommands() {
+  # _nb_cache_completions()
+  #
+  # Usage:
+  #   _nb_cache_completions <path>
+  #
+  # Description:
+  #   Cache completions for `nb`. Generating completions can be slow and
+  #   native shell caching doesn't appear to help.
+  _nb_cache_completions() {
+    local _cache_path="${1:-}"
+
+    [[ -z "${_cache_path:-}" ]] && return 0
+
+    # Remove outdated cache files.
+
+    local _base_cache_path="${_cache_path%-*}"
+
+    local __suffix=
+    for   __suffix in "zsh" "v1"
+    do
+      if [[ -e "${_base_cache_path:?}-${__suffix:?}" ]]
+      then
+        rm -f  "${_base_cache_path:?}-${__suffix:?}"
+      fi
+    done
+
+    # Rebuild completion cache.
+
+    local _commands=
+    IFS=$'\n' _commands=($(nb subcommands))
+
+    local _notebooks=
+    IFS=$'\n' _notebooks=($(nb notebooks --names --no-color --unarchived))
+
+    local _completions=()
+    IFS=$'\n' _completions=(${_commands[@]})
+
+    local _commands_cached=
+    local _notebooks_cached=
+
+    if [[ -e "${_cache_path}"       ]]
+    then
+      local _counter=0
+
+      local               __line=
+      while IFS= read -r  __line
+      do
+        _counter=$((_counter+1))
+
+        if [[   "${_counter}" == 1  ]]
+        then
+          _commands_cached="${__line}"
+        elif [[ "${_counter}" == 2  ]]
+        then
+          _notebooks_cached="${__line}"
+        else
+          break
+        fi
+      done < "${_cache_path}"
+    fi
+
+    if [[ "${_commands_cached}"  != "${_commands[*]:-}"   ]] ||
+       [[ "${_notebooks_cached}" != "${_notebooks[*]:-}"  ]]
+    then
+      # Construct <notebook>:<subcommand> completions.
+      local __notebook=
+      for   __notebook in "${_notebooks[@]}"
+      do
+        local __command=
+        for   __command in "${_commands[@]}"
+        do
+          if [[ -n "${__notebook:-}"  ]] &&
+             [[ -n "${__command:-}"   ]]
+          then
+            _completions+=("${__notebook}:${__command}")
+          fi
+        done
+      done
+
+      local _directory_path=
+      _directory_path="$(dirname "${_cache_path}")"
+
+      mkdir -p "${_directory_path}"
+
+      if [[ -f "${_cache_path:?}" ]]
+      then
+        rm -f "${_cache_path:?}"
+      fi
+
+      touch "${_cache_path:?}"
+
+      {
+        (IFS=$' '; printf "%s\\n" "${_commands[*]}")
+        (IFS=$' '; printf "%s\\n" "${_notebooks[*]}")
+        printf "%s\\n" "${_completions[@]}"
+      } >> "${_cache_path}"
+    fi
+  }
+
+  local _nb_dir=
+  _nb_dir="$(nb env | grep 'NB_DIR' | cut -d = -f 2)"
+
+  if [[ -z "${_nb_dir:?}" ]] ||
+     [[ ! -e "${_nb_dir}" ]]
+  then
+    return 0
+  elif [[ -L "${_nb_dir}" ]]
+  then
+    if hash "realpath" 2>/dev/null
+    then
+      _nb_dir="$(realpath "${_nb_dir}")"
+    else
+      _nb_dir="$(readlink "${_nb_dir}")"
+    fi
+  fi
+
+  if [[ ! -d "${_nb_dir}" ]]
+  then
+    return 0
+  fi
+
+  local _cache_path="${_nb_dir:?}/.cache/nb-completion-cache-v2"
+  local _completions_cached=()
+
+  if [[ ! -e "${_cache_path}" ]]
+  then
+    _nb_cache_completions "${_cache_path}"
+  fi
+
+  if [[ -e "${_cache_path}"   ]]
+  then
+    local _counter=0
+
+    local               __line=
+    while IFS= read -r  __line
+    do
+      _counter=$((_counter+1))
+
+      if [[ "${_counter}" -gt 2 ]]
+      then
+        _completions_cached+=("${__line}")
+      fi
+    done < "${_cache_path}"
+
+    (_nb_cache_completions "${_cache_path}" &)
+  fi
+
+  if [[ "${?}" -eq 0            ]]
+  then
+    compadd -- "${_completions_cached[@]}"
+    return 0
+  else
+    return 1
+  fi
+}
+
+_nb_subcommands "$@"

hosts/air/install.conf.yaml

@@ -1,4 +1,4 @@
-- include: 'hosts/defaults.yaml'
+- include: "tools/dotbot-defaults.yaml"
 - shell:
     - echo "Configuring air"
 - brewfile:

hosts/lakka/install.conf.yaml

@@ -1,4 +1,4 @@
-- include: 'hosts/defaults.yaml'
+- include: "tools/dotbot-defaults.yaml"
 - shell:
     - echo "Configuring lakka"
 - link:

hosts/tunkki/install.conf.yaml

@@ -1,4 +1,4 @@
-- include: 'hosts/defaults.yaml'
+- include: "tools/dotbot-defaults.yaml"
 - shell:
     - echo "Configuring tunkki"
 - link:

hosts/v/install.conf.yaml

@@ -1,4 +1,4 @@
-- include: 'hosts/defaults.yaml'
+- include: "tools/dotbot-defaults.yaml"
 - shell:
     - echo "Configuring v"
 - brewfile:

install

@@ -3,12 +3,12 @@
 set -e
 
 CONFIG="install.conf.yaml"
-DOTBOT_DIR="dotbot"
+DOTBOT_DIR="tools/dotbot"
 
 DOTBOT_BIN="bin/dotbot"
 BASEDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 DOTBOT_BIN_PATH="${BASEDIR}/${DOTBOT_DIR}/${DOTBOT_BIN}"
-DOTBOT_HOST="$(hostname -s)" || ''
+DOTBOT_HOST="$(hostname -s)"
 
 cd "$BASEDIR"
 git submodule sync --quiet --recursive
@@ -16,8 +16,8 @@ git submodule update --init --recursive
 
 "${DOTBOT_BIN_PATH}" \
   -d "${BASEDIR}" \
-  --plugin-dir=dotbot-brew \
-  --plugin-dir=dotbot-include \
+  --plugin-dir=tools/dotbot-brew \
+  --plugin-dir=tools/dotbot-include \
   -c "${CONFIG}" \
   "${@}"
 
@@ -28,8 +28,8 @@ if [ "${DOTBOT_HOST}" != "" ]; then
     && echo "(!) Found $DOTBOT_HOST_CONFIG" \
     && "$DOTBOT_BIN_PATH" \
       -d "$BASEDIR" \
-      --plugin-dir=dotbot-brew \
-      --plugin-dir=dotbot-include \
+      --plugin-dir=tools/dotbot-brew \
+      --plugin-dir=tools/dotbot-include \
       -c "$DOTBOT_HOST_CONFIG" \
       "${@}"
 fi

install.conf.yaml

@@ -1,4 +1,4 @@
-- include: "hosts/defaults.yaml"
+- include: "tools/dotbot-defaults.yaml"
 - clean:
     ~/:
     ~/.config:

local/bin/dfm

@@ -28,6 +28,7 @@ function section_install
   MENU=(
     "all:Installs everything in the correct order"
     "antigen:Updates the antigen.zsh file"
+    "cheat-databases:Install cheat external cheatsheet databases"
     "composer:Install composer"
     "dotenv:Install dotenv-linter"
     "gh:Install GitHub CLI Extensions"
@@ -53,6 +54,7 @@ function section_install
       $0 install fzf
       $0 install gh
       $0 install go
+      $0 install cheat-databases
       $0 install imagick
       $0 install neofetch
       $0 install nvm
@@ -64,6 +66,12 @@ function section_install
       curl -sSfL git.io/antigen -o "$DOTFILES/local/bin/antigen.zsh" \
         && msg_yay "New antigen installed!"
       ;;
+    cheat-databases)
+      for database in "$DOTFILES"/scripts/install-cheat-*; do
+        bash "$database" \
+          && msg_yay "Cheat: $database run"
+      done
+      ;;
     composer)
       bash "$DOTFILES/scripts/install-composer.sh" \
         && msg_yay "composer installed!"

local/bin/x-quota-usage.php

@@ -8,24 +8,16 @@ $quota = '';
 $output = [];
 $fsCharLenght = 0;
 
-if ($debug) {
-    $quota = "Disk quotas for user viir (uid 2913):
-         Filesystem  blocks   quota   limit   grace   files   quota   limit   grace
-    10.0.0.89:/www/webroots/2 8277615  52428800 52428800               0       0       0
-    10.0.0.179:/users1/users/2 1999431  52428800 52428800               0       0       0
-    10.0.0.90:/siilo/2 24835106  524288000 524288000               0       0       0";
-} else {
-    // $quota = system("quota -w");
-    $quota = shell_exec("quota -w");
-}
+$quota = shell_exec("quota -w");
 
-function pad($i, $n = 3, $p = ' ') {
+function pad($i, $n = 3, $p = ' ')
+{
     return str_pad($i, $n, $p, STR_PAD_LEFT);
 }
 
 if (empty($quota)) {
-   var_dump($quota);
-   die("quota was empty\n");
+    var_dump($quota);
+    die("quota was empty\n");
 }
 
 $quota = explode("\n", $quota);
@@ -41,34 +33,34 @@ foreach ($quota as $lineNum => $line) {
     if (count($values) != 4) {
         continue;
     }
-    
+
     $result = array_combine(['fs', 'used', 'quota', 'limit'], $values);
-    
+
     $result['used_percentage'] = round($result['used'] / $result['quota'] * 100, 3);
     $result['used_gb'] = round($result['used'] / 1024 / 1024, 2);
     $result['quota_gb'] = round($result['quota'] / 1024 / 1024, 2);
-    
+
     $char = strlen($result['fs']);
     if ($char > $fsCharLenght) {
         $fsCharLenght = $char;
     }
-    
+
     $output[] = $result;
 }
 
 if (!empty($output)) {
-    
-    $header = sprintf("%s | %s | %s | %s",
+    $header = sprintf(
+        "%s | %s | %s | %s",
         str_pad("Mount", $fsCharLenght),
         'Usage%',
         'Used/Total',
         'Bar'
     );
     $headerWidth = strlen($header);
-    
+
     echo "\n" . $header . "\n";
     echo str_repeat('-', $headerWidth + 24) . "\n";
-    
+
     foreach ($output as $i) {
         $barUsed = round($i['used_percentage']) / 4;
         echo sprintf(
@@ -82,4 +74,3 @@ if (!empty($output)) {
 
     echo "\n\n";
 }
-

phpcs.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+  <description>PHP_CodeSniffer configuration</description>
+  <rule ref="PSR12">
+    <exclude name="PSR12.Operators.OperatorSpacing"/>
+    <exclude name="PSR1.Files.SideEffects.FoundWithSymbols"/>
+  </rule>
+</ruleset>

scripts/install-cheat-purebashbible.sh

@@ -18,7 +18,9 @@ PBB_TEMP_DIR="/tmp/pbb-$(rnd)"
 
 # If there's no .git, clone the folder
 if [ ! -d "$PBB_TEMP_DIR/.git" ]; then
-  git clone "$PBB_GIT" "$PBB_TEMP_DIR"
+  msg_run "Starting to clone $PBB_GIT"
+  git clone --depth 1 --single-branch -q "$PBB_GIT" "$PBB_TEMP_DIR" \
+    && msg_yay "Cloned $PBB_GIT"
 fi
 
 PBB_CHAPTERS=$(ls -1v "$PBB_TEMP_DIR"/manuscript/chapter*)
@@ -32,10 +34,9 @@ for f in ${PBB_CHAPTERS[@]}; do
   # get all headers, take the first one, strip the # and return the first word in lowercase
   HEADER=$(grep -e '^[#] ' "$f" | head -1 | awk '{print tolower($2)}')
   CHEAT_FILE="$CHEAT_DEST/${HEADER}"
-  echo "(*) $CHEAT_FILE"
 
   if [ ! -f "$CHEAT_FILE" ]; then
-    cp "$f" "$CHEAT_FILE"
+    cp "$f" "$CHEAT_FILE" && msg_run "$CHEAT_FILE"
   fi
 
   LC_ALL=C perl -pi.bak -e 's/\<\!-- CHAPTER END --\>//' "$CHEAT_FILE"

scripts/install-cheat-tldr.sh

@@ -11,20 +11,23 @@ done
 TLDR_GIT="https://github.com/tldr-pages/tldr.git"
 TLDR_SOURCE="source: $TLDR_GIT"
 TLDR_SYNTAX="syntax: markdown"
-TLDR_TAGS="tags: [bash]"
 
 TLDR_TEMP_PREFIX=$(basename "$0")
 TLDR_TEMP_DIR="/tmp/cheat-tldr-$(rnd)"
 
 # If there's no .git, clone the folder
 if [ ! -d "$TLDR_TEMP_DIR/.git" ]; then
-  git clone "$TLDR_GIT" "$TLDR_TEMP_DIR"
+  msg_run "Starting to clone $TLDR_GIT"
+  git clone --depth 1 --single-branch -q "$TLDR_GIT" "$TLDR_TEMP_DIR" \
+    && msg_done "Cloned $TLDR_GIT"
 fi
 
 # Fetch the destination directory from cheat defined directories.
 TLDR_CHEAT_DEST="$(cheat -d | grep tldr | head -1 | awk '{print $2}')"
 
-[ "$TLDR_CHEAT_DEST" = "" ] && msg_err "cheat doesn't know about the destination" && exit 1
+[ "$TLDR_CHEAT_DEST" = "" ] \
+  && msg_err "cheat doesn't know about the destination" \
+  && exit 1
 
 if [ ! -d "$TLDR_CHEAT_DEST" ]; then
   mkdir -p "$TLDR_CHEAT_DEST"
@@ -34,16 +37,8 @@ for d in "$TLDR_TEMP_DIR"/pages/*; do
   DIRNAME=$(basename "$d")
   # echo "-> $DIRNAME ($d)"
 
-  case "$DIRNAME" in
-    *common)
-      SECTION_DIR="${TLDR_CHEAT_DEST}"
-      TLDR_TAGS="tags: [common]"
-      ;;
-    *)
-      SECTION_DIR="${TLDR_CHEAT_DEST}/$DIRNAME"
-      TLDR_TAGS="tags: [$DIRNAME]"
-      ;;
-  esac
+  SECTION_DIR="${TLDR_CHEAT_DEST}/$DIRNAME"
+  TLDR_TAGS="tags: [$DIRNAME]"
 
   if [ ! -d "$SECTION_DIR" ]; then
     mkdir -p "$SECTION_DIR"
@@ -57,7 +52,7 @@ for d in "$TLDR_TEMP_DIR"/pages/*; do
     # echo "-> dest: $TLDR_FILE"
 
     if [ ! -f "$TLDR_FILE" ]; then
-      cp "$FILE" "$TLDR_FILE"
+      cp "$FILE" "$TLDR_FILE" && msg_run "$TLDR_FILE"
     fi
 
     if [ -f "$TLDR_FILE" ] && [ '---' != "$(head -1 < "$TLDR_FILE")" ]; then

scripts/install-npm-packages.sh

@@ -15,6 +15,10 @@ have npm && {
     "prettier"
     "corepack"
     "standardjs"
+    # CLI and local web plain text note‑taking, bookmarking, and archiving
+    # with linking, tagging, filtering, search, Git versioning & syncing,
+    # Pandoc conversion, + more, in a single portable script.
+    "nb.sh"
   )
 
   for pkg in "${packages[@]}"; do

tools/dotbot-defaults.yaml

@@ -4,6 +4,6 @@
     link:
       create: true
       relink: true
-      exclude: ["*.md", "*renovate*"]
+      exclude: [ "*.md", "*renovate*", "LICENSE" ]
     shell:
       stdout: true