[fix]: opts, update repository files (#32)

* Enhance zsh-diff-so-fancy plugin with improved diff output and customization options - [fix [bug]: Zsh warnings when loading from Oh-my-zsh #30

Signed-off-by: Salvydas Lukosius <[email protected]>

* Update .gitignore and trunk.yaml for improved plugin management and linting tools

Signed-off-by: Salvydas Lukosius <[email protected]>

* Add GitHub Copilot setup workflow for zsh-diff-so-fancy plugin

Signed-off-by: Salvydas Lukosius <[email protected]>

* Update zsh-diff-so-fancy.plugin.zsh

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Sall <[email protected]>

---------

Signed-off-by: Salvydas Lukosius <[email protected]>
Signed-off-by: Sall <[email protected]>
Co-authored-by: Salvydas Lukosius <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: ss-o

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,63 @@
+name: GitHub Copilot Coding Agent Setup Guide
+
+# This file is used by GitHub Copilot Coding Agent to set up the environment
+# See: https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent
+
+on:
+  # This workflow is intended to be used by GitHub Copilot
+  workflow_dispatch:
+
+# Explicitly define minimum required permissions
+permissions:
+  contents: read
+
+jobs:
+  setup-guide:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Prerequisites
+        run: |
+          echo "::setup::Install ZSH"
+          sudo apt-get update
+          sudo apt-get install -y zsh
+
+      - name: Setup diff-so-fancy
+        run: |
+          echo "::setup::Install diff-so-fancy"
+          git clone https://github.com/so-fancy/diff-so-fancy.git /tmp/diff-so-fancy
+          sudo cp /tmp/diff-so-fancy/diff-so-fancy /usr/local/bin/
+          sudo chmod +x /usr/local/bin/diff-so-fancy
+
+      - name: Test Environment
+        run: |
+          echo "::test::Test diff-so-fancy installation"
+          diff-so-fancy --version
+
+      - name: Setup Instructions
+        run: |
+          echo "::info::Plugin Usage"
+          echo "This zsh plugin provides:"
+          echo "- git dsf: A Git subcommand to run Git diffs through diff-so-fancy"
+          echo "- fancy-diff: A helper to compare two files with diff-so-fancy"
+
+          echo "::info::Environment Variables"
+          echo "You can customize the output by setting these environment variables:"
+          echo "- FANCY_DIFF_LESS_OPTS: Options for less when using fancy-diff"
+          echo "- GIT_DSF_LESS_OPTS: Options for less when using git dsf"
+
+          echo "::info::Testing the plugin"
+          echo "To test the plugin after changes:"
+          echo "1. Run 'zsh' to start a new zsh session"
+          echo "2. Source the plugin: source zsh-diff-so-fancy.plugin.zsh"
+          echo "3. Create two test files with different content"
+          echo "4. Run: fancy-diff file1 file2"
+          echo "5. Run: git dsf (in a git repository)"
+
+      - name: Development Workflow
+        run: |
+          echo "::info::Development Workflow"
+          echo "1. Make changes to zsh-diff-so-fancy.plugin.zsh or scripts in bin/"
+          echo "2. Ensure scripts have proper error handling and comments"
+          echo "3. Test changes in a zsh shell"
+          echo "4. Update documentation in docs/README.md if needed"
+          echo "5. Run trunk check before committing: trunk check"

.trunk/.gitignore

@@ -2,8 +2,7 @@
 *logs
 *actions
 *notifications
-tools
-tools.log
+*tools
 plugins
 user_trunk.yaml
 user.yaml

.trunk/trunk.yaml

@@ -4,20 +4,20 @@ cli:
 plugins:
   sources:
     - id: trunk
-      ref: v1.7.0
+      ref: v1.7.1
       uri: https://github.com/trunk-io/plugins
 lint:
   enabled:
-    - [email protected].435
-    - trufflehog@3.88.35
+    - [email protected].451
+    - trufflehog@3.90.0
     - [email protected]
     - [email protected]
     - [email protected]
-    - gitleaks@8.26.0
+    - gitleaks@8.27.2
     - [email protected]
     - [email protected]
     - git-diff-check
-    - prettier@3.5.3
+    - prettier@3.6.2
 runtimes:
   enabled:
     - [email protected]

bin/fancy-diff

@@ -22,6 +22,10 @@ ff() {
   # 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}"
+
+  # Run diff with unified output (-u), colorized, and pipe through diff-so-fancy
+  # The --patch flag preserves the original diff format in the output
+  # This is useful for interoperability with tools that parse diff output
   command diff -u "$1" "$2" --color=always | diff-so-fancy --patch | less "${less_opts}"
 }
 

bin/git-dsf

@@ -6,7 +6,11 @@ f() {
   # 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}"
 
+  # Handle Git prefix directory if set (for submodules and special Git contexts)
   [[ -z "${GIT_PREFIX}" ]] || builtin cd -q "${GIT_PREFIX}" && \
+    # Run git diff with color, pipe through diff-so-fancy
+    # The --patch flag preserves the original diff format in the output
+    # This is useful for interoperability with tools that parse git diff output
     command git diff --color=always "$@" | diff-so-fancy --patch | less "${less_opts}"
 }
 

docs/README.md

@@ -28,6 +28,20 @@ A simple plugin integrating [so-fancy/diff-so-fancy](https://github.com/so-fancy
    - `git dsf <files>` to see a diff rendered by diff-so-fancy
    - `fancy-diff <file1> <file2>` to compare two files with diff-so-fancy
 
+## Customization
+
+You can customize the `less` options by setting these environment variables in your `.zshrc` before loading the plugin:
+
+```shell
+# Customize less options for fancy-diff
+export FANCY_DIFF_LESS_OPTS="--tabs=2 -RFX"
+
+# Customize less options for git dsf
+export GIT_DSF_LESS_OPTS="--tabs=2 -FRXS"
+```
+
+The default is `--tabs=4 -FRXSi` for both commands if not specified.
+
 ## Manual Configuration
 
 ```shell
@@ -59,6 +73,12 @@ git config --global interactive.diffFilter "diff-so-fancy --patch"
 - **rulerWidth** (int, default: full width)
   Set a fixed width for the file header separator.
 
+### Plugin Details
+
+- Both `fancy-diff` and `git-dsf` use the `--patch` flag with `diff-so-fancy` to preserve the original diff format in the output, which is useful for interoperability with tools that parse diff output.
+- The plugin follows the [Zsh Plugin Standard](https://wiki.zshell.dev/community/zsh_plugin_standard) and provides an unload function for plugin managers that support unloading.
+- The plugin checks if `diff-so-fancy` is installed and provides a helpful warning if it's not found.
+
 ### Installation with [Zi](https://github.com/z-shell/zi)
 
 ```shell

zsh-diff-so-fancy.plugin.zsh

@@ -19,13 +19,18 @@ if ! command -v diff-so-fancy >/dev/null 2>&1; then
   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}"
+# Create the variables in the correct scope using typeset
+# This prevents them from leaking into the global namespace
+# Reference: https://github.com/z-shell/zsh-diff-so-fancy/issues/30
+() {
+  # Default options for `less` used by `fancy-diff`.
+  # Users can override this by setting FANCY_DIFF_LESS_OPTS in their zshrc.
+  typeset -g FANCY_DIFF_LESS_OPTS="${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}"
+  # Default options for `less` used by `git-dsf`.
+  # Users can override this by setting GIT_DSF_LESS_OPTS in their zshrc.
+  typeset -g GIT_DSF_LESS_OPTS="${GIT_DSF_LESS_OPTS:---tabs=4 -FRXSi}"
+}
 
 # https://wiki.zshell.dev/community/zsh_plugin_standard#binaries-directory
 if [[ $PMSPEC != *b* ]] {
@@ -39,6 +44,11 @@ zsh_diff_so_fancy_plugin_unload() {
     # This reconstructs the path based on $0, relying on its initial normalization.
     path=( "${(@)path:#${0:h}/bin}" )
   fi
+
+  # Unset the global variables if they were set by this plugin
+  # Note: We avoid unsetting if they might have been set by the user
+  unset FANCY_DIFF_LESS_OPTS GIT_DSF_LESS_OPTS 2>/dev/null
+
+  # Clean up the function itself
   unfunction zsh_diff_so_fancy_plugin_unload
-  # Add any other cleanup needed, like unsetting global variables or options set by the plugin.
 }