Skip to content

feat: Pass fname and cwd to parse function #247

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.

Sign up for GitHub

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

Open
mothzarella wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: Pass fname and cwd to parse function #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c474060
feat: Pass fname and cwd to parse function (#246)
mothzarella Jan 22, 2026
cc011d8
feat: Update provider fn signature to receive fname and cwd
mothzarella Jan 28, 2026
2c63eca
docs: Add linter signatures and terraform example
mothzarella Jan 30, 2026
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
35 changes: 35 additions & 0 deletions ADVANCED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,41 @@ Et voilà!

![image](https://github.com/xiaoshihou514/guard.nvim/assets/108414369/f9137b5a-ae69-494f-9f5b-b6044ae63c86)

### Signatures for custom linter functions

When writing custom lint logic, `fn` and `parse` receive buffer context:

```lua
lint.fn(prev_lines, fname, cwd)
lint.parse(result, bufnr, fname, cwd)
```

**Parameters:**

- `prev_lines` — buffer content (string)
- `result` — linter output (string)
- `bufnr` — target buffer number
- `fname` — absolute file path
- `cwd` — working directory

Use `fname` and `cwd` when linters output relative paths (e.g., `terraform validate` on a directory returns diagnostics for all files).

**Example** — filtering `terraform validate` by current file:

```lua
parse = function(result, bufnr, fname, cwd)
local current = fname:sub(#cwd + 2) -- +2 to include '/'
local decoded = vim.json.decode(result)

for _, d in ipairs(decoded.diagnostics or {}) do
-- terraform returns relative filenames; match against current
if d.range and d.range.filename == current then
-- add to diagnostics...
end
end
end
```

## Take advantage of autocmd events

Guard exposes a `GuardFmt` user event that you can use. It is called both before formatting starts and after it is completely done. To differentiate between pre-format and post-format calls, a `data` table is passed.
Expand Down
6 changes: 3 additions & 3 deletions lua/guard/lint.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ function M.do_lint_single(buf, config)
end

if #data > 0 then
results = lint.parse(data, buf)
results = lint.parse(data, buf, fname, cwd)
end

vim.schedule(function()
Expand All @@ -117,9 +117,9 @@ function M.do_lint_single(buf, config)
end)
end)
else
data = lint.fn(prev_lines)
data = lint.fn(prev_lines, fname, cwd)
if #data > 0 then
results = lint.parse(data, buf)
results = lint.parse(data, buf, fname, cwd)
end

vim.schedule(function()
Expand Down