Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add lint gh action workflows #1

Merged
merged 1 commit into from
Apr 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -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
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,19 @@

![Dharma logos](https://raw.githubusercontent.com/wiki/zdharma-continuum/zui/img/logo_theme-fs8.png)

This is a RAD (Rapid Application Development) textual user interface library for Zsh. It in many aspects resembles typical CGI+(D)HTML setup. There are:
This is a RAD (Rapid Application Development) textual user interface library for Zsh. It in many aspects resembles
typical CGI+(D)HTML setup. There are:

* generators ran on "server" side (basic Zshell-code that is just generating text!),
* event loop that turns the generated text into document with active elements (buttons, anchors, toggle buttons, text fields, list boxes),
* mechanism to regenerate document parts from the original generators.
- generators ran on "server" side (basic Zshell-code that is just generating text!),
- event loop that turns the generated text into document with active elements (buttons, anchors, toggle buttons, text
fields, list boxes),
- mechanism to regenerate document parts from the original generators.

So, a Zshell code generates text. It is then turned into document with hyperlinks. DHTML-like calls are possible that will regenerate document parts on the fly. Page can be also reloaded with input data, just like an HTML page.
So, a Zshell code generates text. It is then turned into document with hyperlinks. DHTML-like calls are possible that
will regenerate document parts on the fly. Page can be also reloaded with input data, just like an HTML page.

A voiced [video tutorial](https://youtu.be/TfZ8b_RS_Bg) shows how to create an application – Nmap network scanner frontend.
A voiced [video tutorial](https://youtu.be/TfZ8b_RS_Bg) shows how to create an application – Nmap network scanner
frontend.

## Hello World

Expand Down Expand Up @@ -50,44 +54,44 @@ zui-event-loop 1:demo_generator_A

![Hello World screenshot](https://raw.githubusercontent.com/wiki/zdharma-continuum/zui/img/hello-world-fs8.png)

Other example which uses list-box: [zui-demo-list-box](https://github.com/zdharma-continuum/zui/blob/master/demos/zui-demo-list-boxes)
Other example which uses list-box:
[zui-demo-list-box](https://github.com/zdharma-continuum/zui/blob/master/demos/zui-demo-list-boxes)

The API is described at the [wiki](https://github.com/zdharma-continuum/zui/wiki). Checkout [screenshots](https://github.com/zdharma-continuum/zui/wiki/Screenshots)
and [Asciinema recordings](https://github.com/zdharma-continuum/zui/wiki/Asciinema).
The API is described at the [wiki](https://github.com/zdharma-continuum/zui/wiki). Checkout
[screenshots](https://github.com/zdharma-continuum/zui/wiki/Screenshots) and
[Asciinema recordings](https://github.com/zdharma-continuum/zui/wiki/Asciinema).

## Installation

**The plugin is "standalone"**, which means that only sourcing it is needed. So to
install, unpack `zui` somewhere and add
**The plugin is "standalone"**, which means that only sourcing it is needed. So to install, unpack `zui` somewhere and
add

```zsh
source {where-zui-is}/zui.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`).

### Zinit

Add `zinit load zdharma-continuum/zui` to your `.zshrc` file. Zinit will handle
cloning the plugin for you automatically the next time you start zsh. To update
(i.e. to pull from origin) issue `zinit update zdharma-continuum/zui`.
Add `zinit load zdharma-continuum/zui` to your `.zshrc` file. Zinit will handle cloning the plugin for you automatically
the next time you start zsh. To update (i.e. to pull from origin) issue `zinit update zdharma-continuum/zui`.

### Antigen

Add `antigen bundle zdharma-continuum/zui` to your `.zshrc` file. Antigen will handle
cloning the plugin for you automatically the next time you start zsh.
Add `antigen bundle zdharma-continuum/zui` 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 [email protected]:zdharma-continuum/zui.git`
3. Add `zui` to your plugin list
1. `git clone [email protected]:zdharma-continuum/zui.git`
1. Add `zui` to your plugin list

### Zgen

Add `zgen load zdharma-continuum/zui` to your .zshrc file in the same place you're doing
your other `zgen load` calls in.
Add `zgen load zdharma-continuum/zui` to your .zshrc file in the same place you're doing your other `zgen load` calls
in.