zsh/zdharma-continuum.zsh-diff-so-fancy
1
0
Fork 0
mirror of https://github.com/zdharma-continuum/zsh-diff-so-fancy.git synced 2026-09-10 07:16:24 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add lint gh action workflow

Browse source
This commit is contained in:
Vladislav Doster 2023-04-14 17:11:10 -05:00
parent 13e19eb038
commit 19f8fac48f
No known key found for this signature in database
2 changed files with 31 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
.github/workflows/lint.yml vendored Normal file
View file

@ -0,0 +1,15 @@
name: Lint
on:
pull_request:
branches: [main, master]
push:
branches: [main, master]
tags: ["v*.*.*"]
workflow_dispatch:
jobs:
commit:
uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main
lint:
uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main

36
README.md
View file

@ -1,12 +1,11 @@
# Zsh-Diff-So-Fancy
The project [so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) is very
interesting, however I find it difficult to a) install it, b) hook it up to git.
The project [so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) is very interesting, however I find it
difficult to a) install it, b) hook it up to git.
For the a), I just like to install things as user, in home directory, not system-wide via
package manager. So even if the package exists (like it is in e.g. Homebrew for OS X, it
has `diff-so-fancy`), I try to not use it. Think about remote shell accounts, is it good
to ask every system administrator to install your favorite packages?
For the a), I just like to install things as user, in home directory, not system-wide via package manager. So even if
the package exists (like it is in e.g. Homebrew for OS X, it has `diff-so-fancy`), I try to not use it. Think about
remote shell accounts, is it good to ask every system administrator to install your favorite packages?
With this Zsh plugin, you simply add two lines to `.zshrc`:
@ -15,10 +14,9 @@ zplugin ice as"program" pick"bin/git-dsf"
zplugin light zdharma-continuum/zsh-diff-so-fancy
```
This will install `diff-so-fancy` on every account where you use Zshell, and automatically
equip `git` with subcommand `dsf`. No need to use system package manager and to configure
`git`. Of course, if you have the following standard line in your `.gitconfig`, it will
still work normally:
This will install `diff-so-fancy` on every account where you use Zshell, and automatically equip `git` with subcommand
`dsf`. No need to use system package manager and to configure `git`. Of course, if you have the following standard line
in your `.gitconfig`, it will still work normally:
```
[core]
@ -27,17 +25,15 @@ still work normally:
(because this plugin adds `diff-so-fancy` to `$PATH`).
Think about Puppet or Chef, i.e. about declarative approach to system configuration.
In this case `.zshrc` is like a declarative setup guarding you will have `diff-so-fancy`
on your accounts.
Think about Puppet or Chef, i.e. about declarative approach to system configuration. In this case `.zshrc` is like a
declarative setup guarding you will have `diff-so-fancy` on your accounts.
# A Few Details
[so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) is cloned from
Github as submodule. The plugin has `bin/git-dsf` script which adds subcommand `dsf`
to git. That's basically everything needed: convenient way of installing (single Zsh
plugin manager invocation), updating (Zsh plugin managers can easily update) and
integrating with `git`.
[so-fancy/diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) is cloned from Github as submodule. The plugin has
`bin/git-dsf` script which adds subcommand `dsf` to git. That's basically everything needed: convenient way of
installing (single Zsh plugin manager invocation), updating (Zsh plugin managers can easily update) and integrating with
`git`.
# Other plugin managers
@ -49,5 +45,5 @@ zplug "zdharma/zsh-diff-so-fancy", as:command, use:"bin/"
zgen load zdharma/zsh-diff-so-fancy
```
Without `as"program"`-like functionality the `.plugin.zsh` file picks up setup
and simulates adding a command to system, so `Zgen` and other can work.
Without `as"program"`-like functionality the `.plugin.zsh` file picks up setup and simulates adding a command to system,
so `Zgen` and other can work.