Improve EmmyLua export with type ordering and class conversion#10
Merged
YoloWingPixie merged 1 commit intoMay 16, 2025
Merged
Conversation
- Refactor EmmyLua annotation export: Convert pure record types (non-global data structures) to `---@class` with semantic notes for enhanced IDE autocompletion and type introspection. This resolves #8 - Implement topological sorting of type definitions to ensure dependencies are declared before use, improving language server accuracy. This shouldn't affect runtime but does may LuaLS happier when looking at the output file. - Docs: Add comprehensive RST format docstrings to all functions in the lua export script for better maintainability and clarity.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the EmmyLua export by refactoring type annotations, implementing topological sorting for type definitions, and adding comprehensive docstrings to improve maintainability and IDE support.
- Converted pure record types to class annotations for better autocompletion.
- Implemented topological sorting to ensure type dependencies are declared in order.
- Updated function documentation in RST format for clarity.
DCS Schema Stats
✅ All validation checks passed! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
---@classwith semantic notes for enhanced IDE autocompletion and type introspection. This resolves Poor IDE Introspection for Complex---@aliasTable Structures #8