Merge pull request #29 from z-shell/misc

Enhance zsh-diff-so-fancy plugin with error handling and customizatio…

Author: ss-o

LICENSE renamed to .github/LICENSE

@@ -0,0 +1,36 @@
+---
+name: Trunk Code Quality
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions: read-all
+
+jobs:
+  trunk-check:
+    name: Trunk Code Quality Runner
+    runs-on: ubuntu-latest
+    # Provide minimal permissions instead of write-all
+    permissions:
+      pull-requests: write
+      checks: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Optional caching for trunk to speed up subsequent runs
+      - name: Cache trunk
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/trunk
+          key: ${{ runner.os }}-trunk-${{ hashFiles('.trunk/trunk.yaml') }}
+
+      - name: Trunk Code Quality
+        uses: trunk-io/trunk-action@v1

.github/workflows/trunk-check.yaml

@@ -2,6 +2,9 @@
 *logs
 *actions
 *notifications
+tools
+tools.log
 plugins
 user_trunk.yaml
 user.yaml
+tmp

.trunk/.gitignore

@@ -0,0 +1,7 @@
+rules:
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ["{|}"]
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true

.trunk/configs/.yamllint.yaml

@@ -1,24 +1,28 @@
 version: 0.1
 cli:
-  version: 1.3.2
+  version: 1.24.0
 plugins:
   sources:
     - id: trunk
-      ref: v0.0.8
+      ref: v1.7.0
       uri: https://github.com/trunk-io/plugins
 lint:
   enabled:
-    - [email protected]
-    - [email protected]
-    - [email protected]
-    - [email protected]
-    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
     - git-diff-check
-    - prettier@2.8.3
+    - prettier@3.5.3
 runtimes:
   enabled:
-    - [email protected]
-    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
 actions:
   enabled:
     - trunk-announce

.trunk/trunk.yaml

@@ -3,11 +3,26 @@
 # Use diff for unified output, and pipe the output to diff-so-fancy
 
 ff() {
-  if [[ -z $1 ]] && [[ -z $2 ]]; then
-    print -Pr "Provide two files to show diff."
+  if (( $# != 2 )); then
+    print -Pr "%F{red}Error: Exactly two file arguments are required.%f" >&2
+    print -P "Usage: fancy-diff <file1> <file2>" >&2
     return 1
-  else
-    command diff -u "$1" "$2" --color=auto | diff-so-fancy | less --tabs=4 -FRXSi
   fi
+
+  if [[ ! -f "$1" ]]; then
+    print -Pr "%F{red}Error: File '$1' not found.%f" >&2
+    return 1
+  fi
+
+  if [[ ! -f "$2" ]]; then
+    print -Pr "%F{red}Error: File '$2' not found.%f" >&2
+    return 1
+  fi
+
+  # Use FANCY_DIFF_LESS_OPTS if set, otherwise fallback to a default.
+  # The plugin typically sets a default for FANCY_DIFF_LESS_OPTS.
+  local less_opts="${FANCY_DIFF_LESS_OPTS:---tabs=4 -FRXSi}"
+  command diff -u "$1" "$2" --color=always | diff-so-fancy --patch | less "${less_opts}"
 }
+
 ff "$@"

bin/fancy-diff

@@ -1,9 +1,13 @@
 #!/usr/bin/env zsh
 
 # Git will search $PATH for this file, when invoked by "git dsf ...".
-
 f() {
+  # Use GIT_DSF_LESS_OPTS if set, otherwise fallback to a default.
+  # The plugin zsh-diff-so-fancy.plugin.zsh typically sets a default for GIT_DSF_LESS_OPTS.
+  local less_opts="${GIT_DSF_LESS_OPTS:---tabs=4 -FRXSi}"
+
   [[ -z "${GIT_PREFIX}" ]] || builtin cd -q "${GIT_PREFIX}" && \
-    command git diff --color=auto "$@" | diff-so-fancy --patch | less --tabs=4 -FRXSi
+    command git diff --color=always "$@" | diff-so-fancy --patch | less "${less_opts}"
 }
+
 f "$@"

bin/git-dsf

@@ -8,116 +8,80 @@
   <p><img align="center" src="https://raw.githubusercontent.com/z-shell/wiki/main/static/img/gif/zsh-diff-so-fancy.gif" alt="zsh-diff-so-fancy" /></p>
 </div><hr />
 
-## The `diff-so-fancy`
+# zsh-diff-so-fancy
 
-The [so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) as Github submodule.
+A simple plugin integrating [so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) into Zsh. It provides:
 
-The plugin has `bin/git-dsf` script which adds subcommand `dsf` to `git`, and `bin/fancy-diff` to pipe the `diff` output to diff-so-fancy.
+- `git dsf`: A subcommand to run Git diffs through diff-so-fancy
+- `fancy-diff`: A helper to run a unified diff and beautify it with diff-so-fancy
 
-## Manual configuration
+## Quick Start
 
-```shell
-diff-so-fancy --colors        # View the commands to set the recommended colors
-diff-so-fancy --set-defaults  # Configure git-diff to use diff-so-fancy and suggested colors
-diff-so-fancy --patch         # Use diff-so-fancy in patch mode (interoperable with `git add --patch`)
-```
+1. **Install** [diff-so-fancy](https://github.com/so-fancy/diff-so-fancy#installation) or load it via your preferred method.
+2. **Load the plugin** in your `.zshrc` or plugin manager:
+   ```shell
+   # Example using Zi
+   zi ice as'program' pick'bin/*'
+   zi light z-shell/zsh-diff-so-fancy
+   ```
+3. **Use** the commands:
+   - `git dsf <files>` to see a diff rendered by diff-so-fancy
+   - `fancy-diff <file1> <file2>` to compare two files with diff-so-fancy
 
-```shell
-# Configure git to use d-s-f for *all* diff operations
-git config --global core.pager "diff-so-fancy | less --tabs=4 -RFX"
-```
+## Manual Configuration
 
 ```shell
-# Configure git to use d-s-f for `git add --patch`
-git config --global interactive.diffFilter "diff-so-fancy --patch"
+diff-so-fancy --colors        # Show recommended color config
+diff-so-fancy --set-defaults  # Configure Git to use diff-so-fancy with suggested colors
+diff-so-fancy --patch         # Patch mode, interoperable with `git add --patch`
 ```
 
-### Options
-
-#### markEmptyLines
-
-Should the first block of an empty line be colored. (Default: true)
+### Git Integration
 
 ```shell
-git config --bool --global diff-so-fancy.markEmptyLines false
-```
-
-#### changeHunkIndicators
-
-Simplify git header chunks to a more human readable format. (Default: true)
-
-```shell
-git config --bool --global diff-so-fancy.changeHunkIndicators false
-```
-
-#### stripLeadingSymbols
-
-Should the pesky `+` or `-` at line-start be removed. (Default: true)
-
-```shell
-git config --bool --global diff-so-fancy.stripLeadingSymbols false
-```
-
-#### useUnicodeRuler
-
-By default, the separator for the file header uses Unicode line-drawing characters. If this is causing output errors on your terminal, set this to `false` to use ASCII characters instead. (Default: true)
-
-```shell
-git config --bool --global diff-so-fancy.useUnicodeRuler false
-```
-
-#### rulerWidth
-
-By default, the separator for the file header spans the full width of the terminal. Use this setting to set the width of the file header manually.
+# Use diff-so-fancy for all diffs
+git config --global core.pager "diff-so-fancy | less --tabs=4 -RFX"
 
-```shell
-git config --global diff-so-fancy.rulerWidth 47    # git log's commit header width
+# Use diff-so-fancy for `git add --patch`
+git config --global interactive.diffFilter "diff-so-fancy --patch"
 ```
 
-## Install with [Zi](https://github.com/z-shell/zi)
+### diff-so-fancy Options
 
-The project [so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) integration with Zi.
+- **markEmptyLines** (bool, default: true)
+  Color the first block of an empty line.
+- **changeHunkIndicators** (bool, default: true)
+  Simplify Git header chunks to a more readable format.
+- **stripLeadingSymbols** (bool, default: true)
+  Remove leading `+` or `-` from lines.
+- **useUnicodeRuler** (bool, default: true)
+  Use Unicode line-drawing characters for file headers (disable if your terminal cannot display them).
+- **rulerWidth** (int, default: full width)
+  Set a fixed width for the file header separator.
 
-Simply add two lines to `.zshrc`:
-
-Using [bin-gem-node](https://wiki.zshell.dev/ecosystem/annexes/bin-gem-node) annex (recommended):
+### Installation with [Zi](https://github.com/z-shell/zi)
 
 ```shell
 zi ice as'null' sbin'bin/*'
 zi light z-shell/zsh-diff-so-fancy
 ```
 
-Default:
+Or:
 
 ```shell
 zi ice as'program' pick'bin/*'
 zi light z-shell/zsh-diff-so-fancy
 ```
 
-This will add `diff-so-fancy`, `fancy-diff`, `git-dsf` to `$PATH` and automatically equip `git` with subcommand `dsf`.
-
-**No need to use the system package manager or manually configure** `git`, however, if you have the following standard line in your `.gitconfig`, it will still work as expected:
-
-```ini
-[core]
-	pager = diff-so-fancy | less --tabs=4 -RFX
-[interactive]
-	diffFilter = diff-so-fancy --patch
-```
-
-## Other plugin managers
-
-### Zplug
-
-```shell
-zplug "z-shell/zsh-diff-so-fancy", as:command, use:"bin/"
-```
-
-### Zgen
+This places `diff-so-fancy`, `fancy-diff`, and `git-dsf` in `$PATH`, adding the `dsf` subcommand to Git automatically.
 
-```shell
-zgen load z-shell/zsh-diff-so-fancy
-```
+## Other Plugin Managers
 
-Without `as"program"`-like functionality the `.plugin.zsh` file picks up setup
-and simulates adding a command to the system, so `Zgen` and others can work.
+- **Zplug**
+  ```shell
+  zplug "z-shell/zsh-diff-so-fancy", as:command, use:"bin/"
+  ```
+- **Zgen**
+  ```shell
+  zgen load z-shell/zsh-diff-so-fancy
+  ```

docs/README.md

@@ -8,7 +8,37 @@
 0="${ZERO:-${${0:#$ZSH_ARGZERO}:-${(%):-%N}}}"
 0="${${(M)0:#/*}:-$PWD/$0}"
 
+# Ensure consistent behavior and set recommended options
+builtin emulate -L zsh ${=${options[xtrace]:#off}:+-o xtrace}
+setopt extended_glob warn_create_global typeset_silent no_short_loops rc_quotes no_auto_pushd
+
+# Check if diff-so-fancy is installed
+if ! command -v diff-so-fancy >/dev/null 2>&1; then
+  print -Pr "%F{yellow}Warning: zsh-diff-so-fancy plugin loaded, but 'diff-so-fancy' command not found in PATH.%f" >&2
+  print -Pr "%F{yellow}Please install diff-so-fancy: https://github.com/so-fancy/diff-so-fancy#installation%f" >&2
+  return 1
+fi
+
+# Default options for `less` used by `fancy-diff`.
+# Users can override this by setting FANCY_DIFF_LESS_OPTS in their zshrc.
+: "${FANCY_DIFF_LESS_OPTS:=--tabs=4 -FRXSi}"
+
+# Default options for `less` used by `git-dsf`.
+# Users can override this by setting GIT_DSF_LESS_OPTS in their zshrc.
+: "${GIT_DSF_LESS_OPTS:=--tabs=4 -FRXSi}"
+
 # https://wiki.zshell.dev/community/zsh_plugin_standard#binaries-directory
 if [[ $PMSPEC != *b* ]] {
   path+=( "${0:h}/bin" )
 }
+
+# Optional unload function
+zsh_diff_so_fancy_plugin_unload() {
+  if [[ $PMSPEC != *b* ]]; then
+    # Remove the bin path if it was added by this plugin.
+    # This reconstructs the path based on $0, relying on its initial normalization.
+    path=( "${(@)path:#${0:h}/bin}" )
+  fi
+  unfunction zsh_diff_so_fancy_plugin_unload
+  # Add any other cleanup needed, like unsetting global variables or options set by the plugin.
+}