Skip to content

Commit c2dc373

Browse files
committed
docs(readme): update readme
1 parent 1d0d371 commit c2dc373

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ The plugin runs the respective check tool/script asynchronously, parses linter/t
1414
- typecheckers
1515
- analyzers
1616

17-
No formatter orchestration, no task-runner complexity — just `command → parser → quickfix`.
17+
No formatter orchestration, no task-runner complexity — just `command → parser → quickfix`. This also makes checks repeatable across environments and independent of each developer's Neovim LSP configuration.
1818

1919
> Per-buffer linting and formatter/auto-fix workflows are intentionally out of scope, since they are typically handled by active LSPs via `nvim-lspconfig`, plugins like `nvim-lint` or `none-ls.nvim`, and formatter flows with `conform.nvim`. **quickmate.nvim** aims to complement the existing tools with a simple and quick _project-wide checks__quickfix list_.
20+
>
21+
> For many language servers, native diagnostics can already be pushed to quickfix with `vim.diagnostic.setqflist({ open = true })`. In many TypeScript/script-driven setups, LSP diagnostics are limited to currently open files, so project commands (for example `tsc`, `nuxt typecheck`, `eslint`, `oxlint`) are necessary to capture full-project results. **quickmate.nvim** focuses on normalizing that output into quickfix without complicated workarounds.
2022
2123
## Features
2224

doc/quickmate.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Flow:
2727
It runs checks asynchronously with |vim.system()|, parses output from common
2828
linters/typecheckers/analyzers, and writes normalized quickfix entries.
2929

30+
Note: many LSPs can populate quickfix directly via
31+
|vim.diagnostic.setqflist()|. In many TypeScript/script-driven setups, LSP
32+
diagnostics are limited to open files, so explicit project commands (for
33+
example tsc/nuxt/eslint/oxlint) are necessary for full-project results.
34+
quickmate normalizes that output into one quickfix workflow. This keeps checks
35+
repeatable and independent of local Neovim LSP setup.
36+
3037
Main help tag: *quickmate.nvim*
3138

3239
==============================================================================

0 commit comments

Comments
 (0)