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

doc/lua-filters.md: Add static analysis paragraph to debugging section #10568

Merged
merged 1 commit into from
Jan 29, 2025
Merged
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
5 changes: 5 additions & 0 deletions doc/lua-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,11 @@ colon syntax (`mystring:uc_upper()`).

# Debugging Lua filters

Many errors can be avoided by performing static analysis.
[`luacheck`](https://github.com/rnwst/pandoc.git) may be used for this
purpose. A Luacheck configuration file for pandoc filters is available
at <https://github.com/rnwst/pandoc-luacheckrc>.

William Lupton has written a Lua module with some handy
functions for debugging Lua filters, including functions
that can pretty-print the Pandoc AST elements manipulated
Expand Down
Loading