Skip to content

Commit 8cc3678

Browse files
authored
docs(ecosystem): zsh-lint Go reboot page + sync markers (#753)
docs(ecosystem): rewrite zsh-lint page for Go reboot + add sync markers Co-authored-by: Salvydas Lukosius <ss-o@users.noreply.github.com>
1 parent 4c41b11 commit 8cc3678

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

ecosystem/plugins/zsh_lint.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,50 @@
22
id: zsh_lint
33
title: 🔍 Zsh Lint
44
sidebar_position: 13
5-
description: A Zi-aware linter for Zsh configuration and scripting.
5+
description: A Go-based semantic analyzer for Zsh.
66
keywords:
77
- zsh-lint
88
- linter
9-
- zi
9+
- zsh
10+
- go
1011
---
1112

1213
{/* @format */}
1314

14-
import Tabs from "@theme/Tabs";
15-
import TabItem from "@theme/TabItem";
15+
## A Go-based semantic analyzer for Zsh
1616

17-
## Zi-aware Linter for Zsh scripting language
18-
19-
`zsh-lint` is a powerful linter designed specifically for Zsh. It understands Zi-specific constructs and helps ensure your configuration and scripts are following best practices and are free of syntax errors.
17+
`zsh-lint` is being rebooted as a Go semantic analyzer for Zsh. It parses Zsh
18+
sources with a real grammar front end and reports problems. It currently
19+
operates as a **parser survey** — reporting which files the parser accepts — and
20+
does not implement lint rules yet.
2021

2122
### <i class="fa-brands fa-github"></i> [z-shell/zsh-lint][]
2223

2324
### Installation
2425

25-
<Tabs>
26-
<TabItem value="zi" label="Zi" default>
26+
```sh
27+
go install github.com/z-shell/zsh-lint/cmd/zsh-lint@latest
28+
```
2729

28-
Add the following to your `.zshrc` file:
30+
### Usage
2931

30-
```zsh title="~/.zshrc"
31-
zi light z-shell/zui
32-
zi light z-shell/zsh-lint
32+
```sh
33+
zsh-lint path/to/file.zsh another.zsh
3334
```
3435

35-
Note: `zsh-lint` requires [ZUI](zui) to be loaded as well.
36+
Each file gets an `OK`/`FAIL` line; failures include a greppable
37+
`path:line:col: message`. The exit code is `0` only if every file parsed.
3638

37-
</TabItem>
38-
<TabItem value="standalone" label="Standalone">
39+
## Reference
3940

40-
Clone the repository and source the plugin:
41+
The section below is generated from the project's Go doc comments and synced
42+
automatically. Do not edit it by hand.
4143

42-
```shell title="~/.zshrc"
43-
git clone https://github.com/z-shell/zsh-lint.git
44-
source path/to/zsh-lint/zsh-lint.plugin.zsh
45-
```
44+
{/* zsh-lint:generated:start */}
45+
46+
_Reference content is injected here by the `wiki-docs-sync` workflow._
4647

47-
</TabItem>
48-
</Tabs>
48+
{/* zsh-lint:generated:end */}
4949

5050
{/* end-of-file */}
5151
{/* links */}

0 commit comments

Comments
 (0)