Skip to content

Conversation

xuhuanzy
Copy link
Member

No description provided.

Copy link

Summary of Changes

Hello @xuhuanzy, I'm Gemini Code Assist1! 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 significantly extends the EmmyLua parser by integrating a new attribute feature. This allows for more expressive and structured documentation within Lua code, enabling developers to define custom metadata tags and apply them to code elements. The changes involve updates across the lexer, parser, and syntax definitions to support both the declaration and application of these attributes, complete with argument parsing.

Highlights

  • New Attribute Feature: Introduced the attribute feature, allowing users to define custom attributes (---@attribute) and apply them (---@[attribute_name(params)]) within LuaDoc comments.
  • Parser Extensions: Added new syntax kinds and parsing logic to emmylua_parser to correctly interpret attribute definitions and their usage, including attribute names and argument lists.
  • Lexer Updates: Enhanced the LuaDoc lexer with new token kinds and a dedicated state (AttributeUsage) to accurately tokenize the new attribute syntax.
  • Test Coverage: Included a new test case to ensure the proper parsing and Abstract Syntax Tree (AST) generation for the attribute feature.
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

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.

@xuhuanzy xuhuanzy marked this pull request as draft September 22, 2025 21:21
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new attribute feature, allowing for attribute definitions with ---@attribute and their usage with ---@[...]. The implementation spans across the lexer, parser, and syntax kinds, and includes a new test case.

The changes are well-structured. I've found one area in the attribute argument list parsing where the code can be simplified by removing redundant whitespace handling and clarifying the loop logic.

Comment on lines +713 to +740
while p.current_token() != LuaTokenKind::TkRightParen
&& p.current_token() != LuaTokenKind::TkEof
{
// 跳过空白字符
while p.current_token() == LuaTokenKind::TkWhitespace {
p.bump();
}

// 如果遇到右括号则跳出
if p.current_token() == LuaTokenKind::TkRightParen {
break;
}

// 解析单个参数
parse_attribute_arg(p)?;

// 跳过空白字符
while p.current_token() == LuaTokenKind::TkWhitespace {
p.bump();
}

// 处理逗号分隔符
if p.current_token() == LuaTokenKind::TkComma {
p.bump();
} else if p.current_token() != LuaTokenKind::TkRightParen {
break;
}
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The logic for parsing the attribute argument list can be simplified.

  1. The LuaDocParser is already configured to skip whitespace tokens when the lexer is in the AttributeUsage state. Therefore, the manual while p.current_token() == LuaTokenKind::TkWhitespace loops are redundant.
  2. The main while loop can be refactored into a more idiomatic loop for parsing comma-separated lists, which improves readability and explicitly handles trailing commas.

Here is a suggested simplification:

    if p.current_token() != LuaTokenKind::TkRightParen {
        loop {
            if p.current_token() == LuaTokenKind::TkEof {
                break;
            }
            parse_attribute_arg(p)?;
            if p.current_token() != LuaTokenKind::TkComma {
                break;
            }
            p.bump(); // consume comma
            if p.current_token() == LuaTokenKind::TkRightParen {
                break; // trailing comma
            }
        }
    }

@xuhuanzy xuhuanzy linked an issue Sep 23, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implementing new syntax: Attribute
1 participant