Preserve trailing commas (issue #209)

[xJac0b]

Resolves #209

[gemini-code-assist]

Hello @xJac0b, 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!

Summary of Changes

Hello team, Gemini here with a summary of this pull request by @xJac0b.

This PR addresses issue #209 by configuring the code formatter to preserve trailing commas. This is a common code style preference, especially in languages like Dart/Flutter, which can improve readability for multi-line arguments or list/map literals.

The change involves updating the analysis_options.yaml file to explicitly set the trailing_commas option for the formatter.

Highlights

• Code Formatting: Configures the code formatter to preserve trailing commas, aligning with a common style preference and resolving issue #209.
• Configuration Update: Adds a new formatter section to analysis_options.yaml to control formatting behavior.

Changelog

• lib/analysis_options.yaml
  • Added a formatter section with the trailing_commas: preserve option to configure the code formatter.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

---

Comma at the end,
Keeps lines clean, easy to read,
Style guide is set.

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

Thank you for this pull request! Configuring trailing comma behavior is a good step towards consistent code formatting. The intent to preserve trailing commas is clear from the PR title and the chosen option.

I have a couple of points regarding the specific configuration value and its interaction with existing lint rules that would be beneficial to address.

Summary of Findings

• Potentially Invalid Formatter Option: The trailing_commas formatter option is set to preserve. This value is not listed in the official Dart documentation for dart format, which specifies all, none, or optional as valid options. Using an unrecognized value could lead to the formatter defaulting to unexpected behavior or ignoring the setting, which is critical for formatting consistency.
• Linter and Formatter Configuration Interaction: If the trailing_commas formatter option is set to optional (or preserve if it behaves like optional), it will not automatically add missing trailing commas. This conflicts with the enabled require_trailing_commas lint rule (line 238), which mandates their presence. This mismatch means dart format won't fix these specific lint violations, potentially leading to a less streamlined developer workflow.

Merge Readiness

This pull request addresses an important aspect of code formatting. However, there's a critical concern regarding the validity of the preserve option for trailing_commas and a medium-severity concern about its interaction with the existing require_trailing_commas lint rule.

I recommend addressing these points, particularly the potentially invalid option, before merging to ensure the formatter configuration is correct and the developer experience is optimal. As a reviewer, I am not authorized to approve pull requests, but resolving these issues would significantly improve the change. Other reviewers should then perform a final check.

[solid-vovabeloded]

Looks good so far, @xJac0b!
It would be great to fix the failing actions, but there might be a lot of changes - let's do it in a separate PR.