Issue 2977: LuaLS autodoc is including global table in output md/json files

[codrod]

Fixes ISSUE 2977

The LuaLS autodoc is exporting the LuaCATS meta definition files for the builtin Lua language features. I added a new function getExportableGlobals() since we do want to track the builtin globals but not export them. I also updated the default export.gatherGlobals() to use the new getExportableGloblas() function instead of getAllGlobals().

[gemini-code-assist]

Summary of Changes

Hello @codrod, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a bug in the LuaLS autodoc feature that caused it to export internal LuaCATS meta definitions alongside user-defined globals. The changes introduce a mechanism to differentiate between internal and exportable global definitions, ensuring that the generated documentation accurately reflects only the intended public API.

Highlights

• Fix Autodoc Export: Resolves an issue where LuaLS autodoc was incorrectly including internal LuaCATS meta definitions in its output documentation files.
• New Filtering Function: Introduces a new function, vm.getExportableGlobals(), which filters the complete list of global definitions to return only those intended for export, excluding internal meta definitions.
• Updated Global Gathering Logic: Modifies the export.gatherGlobals() function to utilize the newly introduced vm.getExportableGlobals(), ensuring that only relevant and public global definitions are processed for documentation generation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request addresses an issue where built-in globals from meta definition files were being included in the generated documentation. The approach of adding a uri to each global and then filtering them in a new getExportableGlobals function is sound. I've found a couple of critical issues in the implementation of vm.getExportableGlobals that would lead to runtime errors. Specifically, a variable is used without being defined, and there's a potential for a nil value to be passed to string.find. Additionally, I've suggested a small refactoring in export.gatherGlobals to simplify the code by using an existing utility function. Please address the critical issues to ensure the fix works as intended.