Javadoc grammar for tree-sitter
Features:
/**)///) support@see and @link references@nospell set for javadocs syntax regions, so you don't have to turn spellcheck off anymore@snippet, @valueInstall nvim-treesitter, then from neovim:
:TSInstall java javadoc html css printf comment
It is recommended to install at least these parsers for treesitter support of java code.
Bindings are published to pypi, npm, and crates.io as tree-sitter-javadoc.
Wasm and source code artifacts are published to GitHub releases
You can customize highlighting by creating custom query files in ~/.config/nvim/queries/:
This ;; extends the default queries, and adds additional queries based on standard coding conventions.
Many treesitter parsers do this, including java, but neovim is trying to move away from it.
If you use an LSP with semantic token support, you don't need this. Otherwise, it might be useful to you.
~/.config/nvim/queries/javadoc/highlights.scm:
;; extends
; Capitalized methods in javadoc references are treated as constructors.
(((method
(identifier) @constructor)
(#lua-match? @constructor "^[A-Z]")))
; Screaming-case members are treated as constants.
((member
(identifier) @constant)
(#lua-match? @constant "^[A-Z_][A-Z0-9_]+$"))
; Camel-case members are treated as types.
((member
(identifier) @type)
(#lua-match? @type "^[A-Z].*[a-z]"))
The default highlighting incorporates highlighting of HTML and markdown tags via their respective parsers. For a more minimal approach with just highlighting of block and inline tags, you can override the injections.
~/.config/nvim/queries/javadoc/injections.scm:
; overriding with an empty query file to disable injections
FAQs
Parser for Javadoc documentation comments
We found that tree-sitter-javadoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.