nvim: update user config

README.md

@@ -1,8 +1,9 @@
 # .dotfiles
 
-Welcome to [ivuorinen](https://github.com/ivuorinen)'s .dotfiles repository. It's a hodgepodge of scripts
-and configurations, tests and mistakes I'm not aware of yet. As I find more interesting tools, configs and
-other stuff, this repository will live accordingly.
+Welcome to [ivuorinen](https://github.com/ivuorinen)'s .dotfiles repository.
+It's a hodgepodge of scripts and configurations, tests and mistakes I'm not
+aware of yet. As I find more interesting tools, configs and other stuff,
+this repository will live accordingly.
 
 Please for the love of everything good do not use these 1:1 as your own dotfiles,
 fork or download the repo as a zip and go from there with your own configs.
@@ -16,27 +17,28 @@ fork or download the repo as a zip and go from there with your own configs.
 3. ???
 4. Profit
 
-Note: there's a bit chicken/egg situation, because settler assumes you don't have git,
+Note: there's a bit chicken/egg situation,
+because settler assumes you don't have git,
 and you need git to clone the repo. This will change soon™.
 
 ## Interesting files and locations
 
-### Special folders
+### Interesting folders
 
-| Path               | Description                                                                         |
-|--------------------|-------------------------------------------------------------------------------------|
-| `.github`          | GitHub Repository configuration files. Not part of the dotfiles per se.             |
-| `host-{hostname}/` | Host specific dotfiles. Configurations that should apply to that host only.         |
-| `local/bin`        | Helper scripts that I've collected or wrote to make life easier.                    |
-| `scripts`          | Setup scripts. Some can be run many times, some are meant only for the first round. |
+| Path               | Description                                         |
+| ------------------ | --------------------------------------------------- |
+| `.github`          | GitHub Repository configuration files.              |
+| `host-{hostname}/` | Configurations that should apply to that host only. |
+| `local/bin`        | Helper scripts that I've collected or wrote.        |
+| `scripts`          | Setup scripts.                                      |
 
 ### dotfile folders
 
-| Repo      | Destination | Description                                                      |
-|-----------|-------------|------------------------------------------------------------------|
-| `config/` | `.config/`  | Configurations for applications.                                 |
-| `local/`  | `.local/`   | XDG Base folder, contains `bin`, `share` and `state` for example |
-| `ssh/`    | `.ssh/`     | SSH Configurations.                                              |
+| Repo      | Destination | Description                                 |
+| --------- | ----------- | ------------------------------------------- |
+| `config/` | `.config/`  | Configurations for applications.            |
+| `local/`  | `.local/`   | XDG Base folder: `bin`, `share` and `state` |
+| `ssh/`    | `.ssh/`     | SSH Configurations.                         |
 
 ### dfm - the dotfiles manager
 
@@ -44,7 +46,8 @@ and you need git to clone the repo. This will change soon™.
 
 ### `scripts/install-dotfiles.sh` - dotfiles linker
 
-The `scripts/install-dotfiles.sh` is a `rcm` generated shell script that does all the necessary linking.
+The `scripts/install-dotfiles.sh` is a `rcm` generated shell script
+that does all the necessary linking.
 
 To refresh the file, you can run `dfm dotfiles update`
 
@@ -55,7 +58,7 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi
 ### XDG Variables
 
 | Var                | Default              |
-|--------------------|----------------------|
+| ------------------ | -------------------- |
 | Executables        | `$HOME/.local/bin`   |
 | `$XDG_DATA_HOME`   | `$HOME/.local/share` |
 | `$XDG_STATE_HOME`  | `$HOME/.local/state` |
@@ -67,17 +70,24 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi
 - `$XDG_CONFIG_HOME` defines the base directory relative to which user-specific configuration
   files should be stored. If `$XDG_CONFIG_HOME` is either not set or empty,
   a default equal to `$HOME/.config` should be used.
-- `$XDG_STATE_HOME` defines the base directory relative to which user-specific state files should be stored.
-  If `$XDG_STATE_HOME` is either not set or empty, a default equal to `$HOME/.local/state` should be used.
-- The `$XDG_STATE_HOME` contains state data that should persist between (application) restarts,
-  but that is not important or portable enough to the user that it should be stored in `$XDG_DATA_HOME`.
+- `$XDG_STATE_HOME` defines the base directory relative
+  to which user-specific state files should be stored.
+  If `$XDG_STATE_HOME` is either not set or empty, a default
+  equal to `$HOME/.local/state` should be used.
+- The `$XDG_STATE_HOME` contains state data that should persist
+  between (application) restarts,
+  but that is not important or portable enough to the user that
+  it should be stored in `$XDG_DATA_HOME`.
   It may contain:
-    - actions history (logs, history, recently used files, …)
-    - current state of the application that can be reused on a restart (view, layout, open files, undo history, …)
-- User-specific executable files may be stored in `$HOME/.local/bin`. Distributions should ensure this
-  directory shows up in the UNIX `$PATH` environment variable, at an appropriate place.
-- `$XDG_DATA_DIRS` defines the preference-ordered set of base directories to search for data files in addition
-  to the `$XDG_DATA_HOME` base directory. The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'.
+  - actions history (logs, history, recently used files, …)
+  - current state of the application that can be reused
+    on a restart (view, layout, open files, undo history, …)
+- User-specific executable files may be stored in `$HOME/.local/bin`.
+  Distributions should ensure this directory shows up in the UNIX `$PATH`
+  environment variable, at an appropriate place.
+- `$XDG_DATA_DIRS` defines the preference-ordered set of base directories
+  to search for data files in addition to the `$XDG_DATA_HOME` base directory.
+  The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'.
 
 [xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
@@ -85,12 +95,9 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi
 
 ### Interesting dotfiles repos
 
-- https://dotfiles.github.io/inspiration/
-- https://github.com/frdmn/dotfiles - Ansible-based dotfile setup for macOS
-- https://github.com/mvdan/dotfiles - Here be dragons
-- https://github.com/vsouza/dotfiles - 🏡 My dotfiles
-- https://github.com/freekmurze/dotfiles - My personal dotfiles
-
-### Interesting dotfiles tools
-
-- https://github.com/zero-sh/zero.sh - Radically simple personal bootstrapping tool for macOS.
+- [https://dotfiles.github.io/inspiration/](dotfiles.github.io/inspiration)
+- [https://github.com/frdmn/dotfiles](github.com/frdmn/dotfiles) - Ansible-based
+  dotfile setup for macOS
+- [https://github.com/mvdan/dotfiles](mvdan/dotfiles) - Here be dragons
+- [https://github.com/vsouza/dotfiles](vsouza/dotfiles) - 🏡 My dotfiles
+- [https://github.com/freekmurze/dotfiles](freekmurze/dotfiles) - My personal dotfiles

local/bin/iterm2_shell_integration.zsh

@@ -0,0 +1,178 @@
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+if [[ -o interactive ]]; then
+  if [ "${ITERM_ENABLE_SHELL_INTEGRATION_WITH_TMUX-}""$TERM" != "tmux-256color" -a "${ITERM_ENABLE_SHELL_INTEGRATION_WITH_TMUX-}""$TERM" != "screen" -a "${ITERM_SHELL_INTEGRATION_INSTALLED-}" = "" -a "$TERM" != linux -a "$TERM" != dumb ]; then
+    ITERM_SHELL_INTEGRATION_INSTALLED=Yes
+    ITERM2_SHOULD_DECORATE_PROMPT="1"
+    # Indicates start of command output. Runs just before command executes.
+    iterm2_before_cmd_executes() {
+      if [ "$TERM_PROGRAM" = "iTerm.app" ]; then
+        printf "\033]133;C;\r\007"
+      else
+        printf "\033]133;C;\007"
+      fi
+    }
+
+    iterm2_set_user_var() {
+      printf "\033]1337;SetUserVar=%s=%s\007" "$1" $(printf "%s" "$2" | base64 | tr -d '\n')
+    }
+
+    # Users can write their own version of this method. It should call
+    # iterm2_set_user_var but not produce any other output.
+    # e.g., iterm2_set_user_var currentDirectory $PWD
+    # Accessible in iTerm2 (in a badge now, elsewhere in the future) as
+    # \(user.currentDirectory).
+    whence -v iterm2_print_user_vars > /dev/null 2>&1
+    if [ $? -ne 0 ]; then
+      iterm2_print_user_vars() {
+          true
+      }
+    fi
+
+    iterm2_print_state_data() {
+      local _iterm2_hostname="${iterm2_hostname-}"
+      if [ -z "${iterm2_hostname:-}" ]; then
+        _iterm2_hostname=$(hostname -f 2>/dev/null)
+      fi
+      printf "\033]1337;RemoteHost=%s@%s\007" "$USER" "${_iterm2_hostname-}"
+      printf "\033]1337;CurrentDir=%s\007" "$PWD"
+      iterm2_print_user_vars
+    }
+
+    # Report return code of command; runs after command finishes but before prompt
+    iterm2_after_cmd_executes() {
+      printf "\033]133;D;%s\007" "$STATUS"
+      iterm2_print_state_data
+    }
+
+    # Mark start of prompt
+    iterm2_prompt_mark() {
+      printf "\033]133;A\007"
+    }
+
+    # Mark end of prompt
+    iterm2_prompt_end() {
+      printf "\033]133;B\007"
+    }
+
+    # There are three possible paths in life.
+    #
+    # 1) A command is entered at the prompt and you press return.
+    #    The following steps happen:
+    #    * iterm2_preexec is invoked
+    #      * PS1 is set to ITERM2_PRECMD_PS1
+    #      * ITERM2_SHOULD_DECORATE_PROMPT is set to 1
+    #    * The command executes (possibly reading or modifying PS1)
+    #    * iterm2_precmd is invoked
+    #      * ITERM2_PRECMD_PS1 is set to PS1 (as modified by command execution)
+    #      * PS1 gets our escape sequences added to it
+    #    * zsh displays your prompt
+    #    * You start entering a command
+    #
+    # 2) You press ^C while entering a command at the prompt.
+    #    The following steps happen:
+    #    * (iterm2_preexec is NOT invoked)
+    #    * iterm2_precmd is invoked
+    #      * iterm2_before_cmd_executes is called since we detected that iterm2_preexec was not run
+    #      * (ITERM2_PRECMD_PS1 and PS1 are not messed with, since PS1 already has our escape
+    #        sequences and ITERM2_PRECMD_PS1 already has PS1's original value)
+    #    * zsh displays your prompt
+    #    * You start entering a command
+    #
+    # 3) A new shell is born.
+    #    * PS1 has some initial value, either zsh's default or a value set before this script is sourced.
+    #    * iterm2_precmd is invoked
+    #      * ITERM2_SHOULD_DECORATE_PROMPT is initialized to 1
+    #      * ITERM2_PRECMD_PS1 is set to the initial value of PS1
+    #      * PS1 gets our escape sequences added to it
+    #    * Your prompt is shown and you may begin entering a command.
+    #
+    # Invariants:
+    # * ITERM2_SHOULD_DECORATE_PROMPT is 1 during and just after command execution, and "" while the prompt is
+    #   shown and until you enter a command and press return.
+    # * PS1 does not have our escape sequences during command execution
+    # * After the command executes but before a new one begins, PS1 has escape sequences and
+    #   ITERM2_PRECMD_PS1 has PS1's original value.
+    iterm2_decorate_prompt() {
+      # This should be a raw PS1 without iTerm2's stuff. It could be changed during command
+      # execution.
+      ITERM2_PRECMD_PS1="$PS1"
+      ITERM2_SHOULD_DECORATE_PROMPT=""
+
+      # Add our escape sequences just before the prompt is shown.
+      # Use ITERM2_SQUELCH_MARK for people who can't mdoify PS1 directly, like powerlevel9k users.
+      # This is gross but I had a heck of a time writing a correct if statetment for zsh 5.0.2.
+      local PREFIX=""
+      if [[ $PS1 == *"$(iterm2_prompt_mark)"* ]]; then
+        PREFIX=""
+      elif [[ "${ITERM2_SQUELCH_MARK-}" != "" ]]; then
+        PREFIX=""
+      else
+        PREFIX="%{$(iterm2_prompt_mark)%}"
+      fi
+      PS1="$PREFIX$PS1%{$(iterm2_prompt_end)%}"
+      ITERM2_DECORATED_PS1="$PS1"
+    }
+
+    iterm2_precmd() {
+      local STATUS="$?"
+      if [ -z "${ITERM2_SHOULD_DECORATE_PROMPT-}" ]; then
+        # You pressed ^C while entering a command (iterm2_preexec did not run)
+        iterm2_before_cmd_executes
+        if [ "$PS1" != "${ITERM2_DECORATED_PS1-}" ]; then
+          # PS1 changed, perhaps in another precmd. See issue 9938.
+          ITERM2_SHOULD_DECORATE_PROMPT="1"
+        fi
+      fi
+
+      iterm2_after_cmd_executes "$STATUS"
+
+      if [ -n "$ITERM2_SHOULD_DECORATE_PROMPT" ]; then
+        iterm2_decorate_prompt
+      fi
+    }
+
+    # This is not run if you press ^C while entering a command.
+    iterm2_preexec() {
+      # Set PS1 back to its raw value prior to executing the command.
+      PS1="$ITERM2_PRECMD_PS1"
+      ITERM2_SHOULD_DECORATE_PROMPT="1"
+      iterm2_before_cmd_executes
+    }
+
+    # If hostname -f is slow on your system set iterm2_hostname prior to
+    # sourcing this script. We know it is fast on macOS so we don't cache
+    # it. That lets us handle the hostname changing like when you attach
+    # to a VPN.
+    if [ -z "${iterm2_hostname-}" ]; then
+      if [ "$(uname)" != "Darwin" ]; then
+        iterm2_hostname=`hostname -f 2>/dev/null`
+        # Some flavors of BSD (i.e. NetBSD and OpenBSD) don't have the -f option.
+        if [ $? -ne 0 ]; then
+          iterm2_hostname=`hostname`
+        fi
+      fi
+    fi
+
+    [[ -z ${precmd_functions-} ]] && precmd_functions=()
+    precmd_functions=($precmd_functions iterm2_precmd)
+
+    [[ -z ${preexec_functions-} ]] && preexec_functions=()
+    preexec_functions=($preexec_functions iterm2_preexec)
+
+    iterm2_print_state_data
+    printf "\033]1337;ShellIntegrationVersion=14;shell=zsh\007"
+  fi
+fi

scripts/install-gh-extensions.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 # Install GitHub CLI extensions
 
+# shellcheck source="shared.sh"
 source "$HOME/.dotfiles/scripts/shared.sh"
 
 if ! command -v gh &> /dev/null; then

zshrc

@@ -138,9 +138,18 @@ fi
 
 # op (1Password cli) is present
 if hash op 2>/dev/null; then
+    export OP_CACHE="$XDG_STATE_HOME/1password"
+    mkdir -p $OP_CACHE;
     eval "$(op completion zsh)"; compdef _op op
 fi
 
+# Ansible configuration
+# https://docs.ansible.com/ansible/latest/reference_appendices/config.html
+if hash ansible 2>/dev/null; then
+    export ANSIBLE_HOME="$XDG_STATE_HOME/ansible"
+    mkdir -p "$ANSIBLE_HOME"
+fi
+
 # gcloud is present
 #if hash gcloud 2>/dev/null; then
 #    GCLOUD_LOC=$(gcloud info --format="value(installation.sdk_root)" --quiet)
@@ -148,4 +157,8 @@ fi
 #    [[ -f "$GCLOUD_LOC/completion.zsh.inc" ]] && builtin source "$GCLOUD_LOC/completion.zsh.inc"
 #fi
 
+# Load iterm2 shell integration
+# https://iterm2.com/documentation-shell-integration.html
+[[ -f "$XDG_BIN_HOME/iterm2_shell_integration.zsh" ]] && source "$XDG_BIN_HOME/iterm2_shell_integration.zsh"
+
 eval "$(starship init zsh)"