mirror of
https://github.com/zdharma-continuum/zconvey.git
synced 2026-09-10 07:06:21 -04:00
feat: add lint gh action workflow
This commit is contained in:
Vladislav Doster
parent
90e82e2022
commit
d151f1805e
15
.github/workflows/lint.yml
vendored
Normal file
15
.github/workflows/lint.yml
vendored
Normal 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
|
||||
57
README.md
57
README.md
|
|
@ -1,7 +1,9 @@
|
|||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D6XDCHDSBDSDG)
|
||||
|
||||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||
|
||||
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
|
||||
|
||||
- [Introduction](#introduction)
|
||||
|
|
@ -17,11 +19,10 @@
|
|||
|
||||
# Introduction
|
||||
|
||||
Zconvey integrates multiple Zsh sessions. They are given an ID, optionally a NAME (both unique),
|
||||
and can send commands to each other. Use this to switch all your Zshells to given directory, via
|
||||
`zc-all cd $PWD`! Also, there's `zc-bg-notify` **script** (not a function), that will show
|
||||
notification under prompt of every active Zsh session. You can call this script from any program,
|
||||
Bash or GUI.
|
||||
Zconvey integrates multiple Zsh sessions. They are given an ID, optionally a NAME (both unique), and can send commands
|
||||
to each other. Use this to switch all your Zshells to given directory, via `zc-all cd $PWD`! Also, there's
|
||||
`zc-bg-notify` **script** (not a function), that will show notification under prompt of every active Zsh session. You
|
||||
can call this script from any program, Bash or GUI.
|
||||
|
||||
Video – view on [asciinema](https://asciinema.org/a/156726). You can resize the video by pressing `Ctrl-+` or `Cmd-+`.
|
||||
|
||||
|
|
@ -66,8 +67,8 @@ zstyle ":plugin:zconvey" timestamp_from "datetime"
|
|||
|
||||
# Installation
|
||||
|
||||
**The plugin is "standalone"**, which means that only sourcing it is needed. So to
|
||||
install, unpack `zconvey` somewhere and add
|
||||
**The plugin is "standalone"**, which means that only sourcing it is needed. So to install, unpack `zconvey` somewhere
|
||||
and add
|
||||
|
||||
```zsh
|
||||
source {where-zconvey-is}/zconvey.plugin.zsh
|
||||
|
|
@ -75,22 +76,20 @@ source {where-zconvey-is}/zconvey.plugin.zsh
|
|||
|
||||
to `zshrc`.
|
||||
|
||||
If using a plugin manager, then `Zinit` is recommended, but you can use any
|
||||
other too, and also install with `Oh My Zsh` (by copying directory to
|
||||
`~/.oh-my-zsh/custom/plugins`).
|
||||
If using a plugin manager, then `Zinit` is recommended, but you can use any other too, and also install with `Oh My Zsh`
|
||||
(by copying directory to `~/.oh-my-zsh/custom/plugins`).
|
||||
|
||||
The plugin integrates with my other plugin [Zsh-Select](https://github.com/zdharma-continuum/zsh-select).
|
||||
Install it with e.g. Zinit to be able to use `-a` option for `zc` command. It also integrates
|
||||
with [marzocchi/zsh-notify](https://github.com/marzocchi/zsh-notify), via `cmds/plg-zsh-notify`
|
||||
script.
|
||||
The plugin integrates with my other plugin [Zsh-Select](https://github.com/zdharma-continuum/zsh-select). Install it
|
||||
with e.g. Zinit to be able to use `-a` option for `zc` command. It also integrates with
|
||||
[marzocchi/zsh-notify](https://github.com/marzocchi/zsh-notify), via `cmds/plg-zsh-notify` script.
|
||||
|
||||
## [Zinit](https://github.com/zdharma-continuum/zinit)
|
||||
|
||||
Add `zinit load zdharma-continuum/zconvey` to your `.zshrc` file. Zinit will clone the plugin
|
||||
the next time you start zsh. To update issue `zinit update zdharma-continuum/zconvey`.
|
||||
Add `zinit load zdharma-continuum/zconvey` to your `.zshrc` file. Zinit will clone the plugin the next time you start
|
||||
zsh. To update issue `zinit update zdharma-continuum/zconvey`.
|
||||
|
||||
Zinit can load in [turbo-mode](https://github.com/zdharma-continuum/zinit#turbo-mode-zsh--53),
|
||||
below is an example configuration, together with adding `zc-bg-notify` to `$PATH`:
|
||||
Zinit can load in [turbo-mode](https://github.com/zdharma-continuum/zinit#turbo-mode-zsh--53), below is an example
|
||||
configuration, together with adding `zc-bg-notify` to `$PATH`:
|
||||
|
||||
```zsh
|
||||
zinit ice wait"0"
|
||||
|
|
@ -101,19 +100,19 @@ zinit light zdharma-continuum/zconvey
|
|||
|
||||
## Antigen
|
||||
|
||||
Add `antigen bundle zdharma-continuum/zconvey` to your `.zshrc` file. Antigen will handle
|
||||
cloning the plugin for you automatically the next time you start zsh.
|
||||
Add `antigen bundle zdharma-continuum/zconvey` to your `.zshrc` file. Antigen will handle cloning the plugin for you
|
||||
automatically the next time you start zsh.
|
||||
|
||||
## Oh-My-Zsh
|
||||
|
||||
1. `cd ~/.oh-my-zsh/custom/plugins`
|
||||
2. `git clone git@github.com:zdharma-continuum/zconvey.git`
|
||||
3. Add `zconvey` to your plugin list
|
||||
1. `git clone git@github.com:zdharma-continuum/zconvey.git`
|
||||
1. Add `zconvey` to your plugin list
|
||||
|
||||
## Zgen
|
||||
|
||||
Add `zgen load zdharma-continuum/zconvey` to your .zshrc file in the same place you're doing
|
||||
your other `zgen load` calls in.
|
||||
Add `zgen load zdharma-continuum/zconvey` to your .zshrc file in the same place you're doing your other `zgen load`
|
||||
calls in.
|
||||
|
||||
# Information
|
||||
|
||||
|
|
@ -128,9 +127,7 @@ There are following commands:
|
|||
- `zc-logo` – the same as `zc-id`, but in a form of an on-screen logo; bound to Ctrl-O Ctrl-I
|
||||
- `zc-bg-notify` – in subdirectory `cmds`, link it to `/usr/local/bin`, etc. or load with e.g. Zinit
|
||||
|
||||
The main command is `zc` (yet it is rather rarely used, I'm always sending to all sessions with `zc-all`).
|
||||
It is used to execute commands on other sessions. `zc-ls` is the main tool
|
||||
to obtain overall information on sessions. `zc-take` is a nice rename tool to quickly name a few
|
||||
sessions. Keyboard shortcut Ctrl-O Ctrl-I will show current session's ID and NAME in form of an
|
||||
on-screen logo.
|
||||
|
||||
The main command is `zc` (yet it is rather rarely used, I'm always sending to all sessions with `zc-all`). It is used to
|
||||
execute commands on other sessions. `zc-ls` is the main tool to obtain overall information on sessions. `zc-take` is a
|
||||
nice rename tool to quickly name a few sessions. Keyboard shortcut Ctrl-O Ctrl-I will show current session's ID and NAME
|
||||
in form of an on-screen logo.
|
||||
|
|
|
|||
Loading…
Reference in a new issue