Skip to content

chore: run very_good_analysis with no rule overrides - #102

Merged
marcossevilla merged 2 commits into
mainfrom
chore/full-very-good-analysis
Oct 28, 2026
Merged

marcossevilla merged 2 commits into
mainfrom
chore/full-very-good-analysis

Conversation

@ryzizub

@ryzizub ryzizub commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Description

Stack 5 of 5 for #68. Base: docs/completion-and-windows-support (#101).

Both packages disabled public_member_api_docs. Very Good CLI disables nothing and excludes generated files in the analyzer section instead, so this does the same and documents the members that were missing a comment.

The bulk of the diff is mechanical, and worth knowing before reading it: the lint reads a Dart 3.13 primary constructor as an undocumented member, and the class's own doc comment does not satisfy it. The only thing that does is declaring the constructor in the body as this; under /// {@macro name}. Very Good CLI puts its constructor doc in exactly the same place — it just never needs the bare declaration, because it has no primary constructors. The cost is about two lines per public class, now and for every class added later.

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore
  • 🧪 Test

🤖 Generated with Claude Code

@ryzizub
ryzizub added this pull request to stack #103 October 21, 2026 12:19
@ryzizub
ryzizub marked this pull request as ready for review October 21, 2026 12:20
marcossevilla
marcossevilla previously approved these changes Oct 21, 2026
@marcossevilla
marcossevilla force-pushed the chore/full-very-good-analysis branch from f034d12 to e144274 Compare October 28, 2026 11:54
@marcossevilla
marcossevilla force-pushed the chore/full-very-good-analysis branch 3 times, most recently from 2ffb6b6 to 965955f Compare October 28, 2026 12:28
@marcossevilla
marcossevilla requested a review from a team as a code owner October 28, 2026 12:28
Base automatically changed from docs/completion-and-windows-support to main October 28, 2026 12:30
Both packages disabled public_member_api_docs. Very Good CLI disables nothing
and excludes generated files in the analyzer section instead, so do the same
and document the members that were missing a comment.

The lint reads a Dart 3.13 primary constructor as an undocumented member, and
the class's own doc comment does not satisfy it. The only thing that does is
declaring the constructor in the body as `this;` under `/// {@macro name}`.
Very Good CLI puts its constructor doc in the same place; it just never needs
the bare declaration, because it has no primary constructors.
@marcossevilla
marcossevilla force-pushed the chore/full-very-good-analysis branch from 965955f to af342b0 Compare October 28, 2026 12:30
@marcossevilla
marcossevilla merged commit c93ea52 into main Oct 28, 2026
8 checks passed
@marcossevilla
marcossevilla deleted the chore/full-very-good-analysis branch October 28, 2026 14:46
@vgvbot vgvbot mentioned this pull request Oct 29, 2026
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.

2 participants