Skip to content

docs: delete include options on README#435

Merged
ronnnnn merged 1 commit intomainfrom
docs-example
Nov 30, 2025
Merged

docs: delete include options on README#435
ronnnnn merged 1 commit intomainfrom
docs-example

Conversation

@ronnnnn
Copy link
Copy Markdown
Member

@ronnnnn ronnnnn commented Nov 30, 2025

Overview

Delete include options for configurations of analyzer plugin.

Feature type

  • Lint Rule
  • Quick fix
  • Assist
  • Other (Update docs, Configure CI, etc...)

@ronnnnn ronnnnn added the docs Improvements or additions to documentation label Nov 30, 2025
Copilot AI review requested due to automatic review settings November 30, 2025 15:30
@ronnnnn ronnnnn added the invalid This doesn't seem right label Nov 30, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes the include-based configuration approach for the analyzer plugins, replacing it with direct configuration using the diagnostics format. The main purpose is to simplify the configuration by eliminating the versioned analysis_options_all*.yaml files that users could include, and instead directing users to explicitly enable rules they need.

Key changes:

  • Removed all analysis_options_all.yaml and versioned configuration files from package lib directories
  • Updated README files to remove instructions for using include directive and emphasize the diagnostics approach
  • Consolidated plugin configurations into the root analysis_options.yaml file

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/nilts_flutter_hooks/lib/analysis_options_all.yaml Deleted file that provided include-based configuration
packages/nilts_flutter_hooks/lib/analysis_options_all.1.0.0.yaml Deleted versioned configuration file
packages/nilts_flutter_hooks/analysis_options.yaml Updated to use direct include of very_good_analysis instead of relative path
packages/nilts_flutter_hooks/README.md Removed documentation for include-based configuration, added explanation for diagnostics approach
packages/nilts_core/analysis_options.yaml Updated to use direct include of very_good_analysis instead of relative path
packages/nilts_clock/lib/analysis_options_all.yaml Deleted file that provided include-based configuration
packages/nilts_clock/lib/analysis_options_all.1.0.0.yaml Deleted versioned configuration file
packages/nilts_clock/analysis_options.yaml Updated to use direct include of very_good_analysis instead of relative path
packages/nilts_clock/README.md Removed documentation for include-based configuration, added explanation for diagnostics approach
packages/nilts/lib/analysis_options_all.yaml Deleted file that provided include-based configuration
packages/nilts/lib/analysis_options_all.1.0.0.yaml Deleted versioned configuration file with all rule definitions
packages/nilts/analysis_options.yaml Updated to use direct include of very_good_analysis instead of relative path
packages/nilts/README.md Removed documentation for include-based configuration, simplified example
examples/nilts_example/analysis_options.yaml Simplified to single include statement instead of multiple includes
analysis_options_all_rules.yaml Deleted file containing all plugin rule configurations
analysis_options.yaml Added comprehensive plugin configurations directly in the root file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @ronnnnn, 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 refactors the analyzer plugin configuration and its associated documentation to simplify how users enable and manage lint rules. The primary goal is to move away from 'include all rules' directives and instead promote explicit configuration via the diagnostics section within analysis_options.yaml. This change centralizes plugin definitions in the main analysis_options.yaml and updates all relevant READMEs to guide users towards this more explicit and flexible configuration method.

Highlights

  • Configuration Simplification: The pull request removes the include options for enabling all analyzer plugin rules, streamlining the configuration process by promoting direct diagnostics configuration.
  • Centralized Plugin Configuration: All nilts family plugin configurations are now consolidated into the root analysis_options.yaml file, making it the central point for managing these rules.
  • Documentation Update: README files across nilts, nilts_clock, and nilts_flutter_hooks packages have been updated to reflect the new recommended way of enabling specific rules via diagnostics and remove outdated include instructions.
  • Self-contained Package Analysis Options: Individual package analysis_options.yaml files have been modified to directly include package:very_good_analysis and define linter/formatter rules, reducing their dependency on the root configuration.
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.

Copy link
Copy Markdown

@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 refactors the configuration of the analyzer plugins by removing the include option for enabling all rules and updating the documentation accordingly. The plugin configurations are now consolidated in the root analysis_options.yaml file, and the READMEs are updated to guide users on the new, more explicit configuration method. The changes are consistent and improve the project's structure.

My review includes a few suggestions to improve maintainability and documentation clarity:

  • Use version constraints for plugins in analysis_options.yaml for better flexibility.
  • Use relative links in the README files to point to the example configuration, ensuring version consistency.


plugins:
nilts:
version: 1.0.0
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For better maintainability and consistency with the README, it's recommended to use a version constraint (e.g., ^1.0.0) instead of a fixed version. This will prevent potential issues when the package version is updated.

    version: ^1.0.0

unstable_enum_name: true
unstable_enum_values: true
nilts_clock:
version: 1.0.0
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For better maintainability and consistency with the README, it's recommended to use a version constraint (e.g., ^1.0.0) instead of a fixed version. This will prevent potential issues when the package version is updated.

    version: ^1.0.0

diagnostics:
using_date_time_now: true
nilts_flutter_hooks:
version: 1.0.0
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

For better maintainability and consistency with the README, it's recommended to use a version constraint (e.g., ^1.0.0) instead of a fixed version. This will prevent potential issues when the package version is updated.

    version: ^1.0.0

```
<!-- prettier-ignore-end -->

For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using a relative link to analysis_options.yaml is more robust. It ensures that users viewing the README for a specific version or tag will see the corresponding version of the configuration file, rather than always being directed to the main branch.

Suggested change
For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
For a complete example of enabling all rules, see [`analysis_options.yaml`](../../analysis_options.yaml).

```
<!-- prettier-ignore-end -->

For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using a relative link to analysis_options.yaml is more robust. It ensures that users viewing the README for a specific version or tag will see the corresponding version of the configuration file, rather than always being directed to the main branch.

Suggested change
For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
For a complete example of enabling all rules, see [`analysis_options.yaml`](../../analysis_options.yaml).

```
<!-- prettier-ignore-end -->

For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using a relative link to analysis_options.yaml is more robust. It ensures that users viewing the README for a specific version or tag will see the corresponding version of the configuration file, rather than always being directed to the main branch.

Suggested change
For a complete example of enabling all rules, see [`analysis_options.yaml`](https://github.com/dassssshers/nilts/blob/main/analysis_options.yaml).
For a complete example of enabling all rules, see [`analysis_options.yaml`](../../analysis_options.yaml).

@ronnnnn ronnnnn merged commit fc7145d into main Nov 30, 2025
8 checks passed
@ronnnnn ronnnnn deleted the docs-example branch November 30, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants