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

Feature request: preserve comments data in type info #907

Open
BLKTower opened this issue Jan 13, 2025 · 1 comment
Open

Feature request: preserve comments data in type info #907

BLKTower opened this issue Jan 13, 2025 · 1 comment
Labels
feature request New feature or request

Comments

@BLKTower
Copy link

For now, teal compiler just drops any comments data from type info. I hope these comments can also be preserved.
I have 2 use cases:

  • I want to show comments as documents in vscode plugin hover.
    image
  • I want to add a teal formatter plugin. I feel the easiest way to achieve it is to mimic something like tl gen but produce formatted .tl instead of .lua. But as a formatter, all comments need to be preserved unlike the generated lua scripts.
@hishamhm hishamhm added the feature request New feature or request label Jan 13, 2025
@ElhamAryanpur
Copy link

is there any progress on this?

I personally include comments for diagnostics that some LSP for lua uses e.g.

---@param sql string The SQL query to execute.
---@param parameters table Optional table containing the parameters to bind to the query.
function Database:execute(sql, parameters) end

Would be very useful to keep the comments when generating

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants