WERDXZ/nvim-dox

A Pure Lua Docstring Generator for NeoVim

Nvim-Dox

A Pure Lua Docstring Generator for NeoVim

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contribution
• TODO
• Design
• License

Introduction

Please note: This plugin is still under active development.

Expect significant changes in upcoming versions.

Features

Nvim-Dox is designed to generate docstrings in NeoVim, offering:

• API Exposure: Easily register new docstring dialects.
• TSNode Parsers: Provides parsers for interpreting TSNode.
• TSNode Queriers: Queriers for retrieving the relevant TSNode.
• Snippet Managers Integration: Seamlessly integrates with snippet managers.

Installation

Install Nvim-Dox using your preferred NeoVim plugin manager.

Usage

• Basic Usage: Execute the Dox command to generate a docstring for the TSNode at the cursor position.
• Specific Node Type: Use the command Dox <type> to generate a docstring for the closest TSNode of type <type>.

Contribution

Contributions are always welcome! Feel free to open a PR or raise an issue. I aim to respond as promptly as possible.

TODO

Feature	Priority
Add documentation (doc/vimdoc)	1
Implement Checkhealth for troubleshooting	1
Integrate with other snippet engines	1
Develop Dox generate for document generation	2
Support other document engines	2
Incorporate namespace/inheritance support (major change)	3
Other completion sources	3

Design

A quick rundown of the plugin's operation:

1. Initiate the Dox command.
2. Fetch the TSNode through the specified Querier functions.
3. Load the relevant docstring template based on the current filetype.
4. Populate the template, replacing format masks using the Parser. This interprets the Querier results.
5. If a snippet engine is present, the generated string is registered.
6. Finally, the docstring is output.

License

This project is under the MIT License. Refer to the LICENSE file for more details.