Skip to content

Commit 327134e

Browse files
authored
Merge pull request #14 from zdharma-continuum/ci/gh-action-lint-workflow
feat: add lint gh action workflows
2 parents 0a72269 + bd60fb0 commit 327134e

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

.github/workflows/lint.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
branches: [main, master]
6+
push:
7+
branches: [main, master]
8+
tags: ["v*.*.*"]
9+
workflow_dispatch:
10+
11+
jobs:
12+
commit:
13+
uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main
14+
lint:
15+
uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# zinit-annex-rust<a name="zinit-annex-rust"></a>
22

3-
A Zsh-Zinit annex that installs rust and cargo packages locally inside the
4-
plugin or snippet directories. The crate can then have a so called *shim*
5-
created (name borrowed from `rbenv`) – a script that's located in the standard
6-
`$PATH` entry "`$ZPFX/bin`" of following contents (example):
3+
A Zsh-Zinit annex that installs rust and cargo packages locally inside the plugin or snippet directories. The crate can
4+
then have a so called *shim* created (name borrowed from `rbenv`) – a script that's located in the standard `$PATH`
5+
entry "`$ZPFX/bin`" of following contents (example):
76

87
```zsh
98
#!/usr/bin/env zsh
@@ -21,8 +20,7 @@ lsd "$@"
2120

2221
As it can be seen shim ultimately provides the binary to the command line.
2322

24-
![example zinit-annex-rust
25-
use](https://raw.githubusercontent.com/zdharma-continuum/zinit-annex-rust/master/images/z-a-rust.png)
23+
![example zinit-annex-rust use](https://raw.githubusercontent.com/zdharma-continuum/zinit-annex-rust/master/images/z-a-rust.png)
2624

2725
<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=2 -->
2826

@@ -52,9 +50,8 @@ This installs the annex and makes the `rustup` and `cargo''` ices available.
5250

5351
## Usage<a name="usage"></a>
5452

55-
The Zinit annex provides two new ices: `rustup` and `cargo''`. The first one
56-
installs rust inside the plugin's folder using the official `rustup` installer.
57-
The second one has the following syntax:
53+
The Zinit annex provides two new ices: `rustup` and `cargo''`. The first one installs rust inside the plugin's folder
54+
using the official `rustup` installer. The second one has the following syntax:
5855

5956
`cargo"[name-of-the-binary-or-path <-] [[!][c|N|E|O]:]{crate-name} [-> {shim-script-name}]'`
6057

@@ -67,9 +64,8 @@ The second one has the following syntax:
6764
| `O` | redirect standard output to `/dev/null` |
6865
| `c` | change the current directory to the plugin's or snippet's directory before executing the command |
6966

70-
As the examples showed, the name of the binary to run and the shim name are
71-
by default equal to the name of the crate. Specifying `{binary-name} <- …`
72-
and/or `… -> {shim-name}` allows to override them.
67+
As the examples showed, the name of the binary to run and the shim name are by default equal to the name of the crate.
68+
Specifying `{binary-name} <- …` and/or `… -> {shim-name}` allows to override them.
7369

7470
## Examples<a name="examples"></a>
7571

@@ -138,9 +134,8 @@ zi for \
138134
zdharma-continuum/null
139135
```
140136

141-
When using a global installation of rust in turbo mode, cargos need to omit the
142-
rustup ice, and wait on `$CARGO_HOME` and `$RUSTUP_HOME` environment variables to be
143-
available
137+
When using a global installation of rust in turbo mode, cargos need to omit the rustup ice, and wait on `$CARGO_HOME`
138+
and `$RUSTUP_HOME` environment variables to be available
144139

145140
```zsh
146141
zi for \

0 commit comments

Comments
 (0)