搜索插件、代码仓与 APP 分类

插件详情v11.0.0

very_good_analysis

Very Good Ventures 内部使用的 Dart 和 Flutter 代码检查规则。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
133万
喜欢数
774
Pub 分数
160

安装插件

flutter pub add very_good_analysis

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一套全面的 Dart 和 Flutter 代码检查规则,由 Very Good Ventures 内部开发并使用。该包可确保项目中代码质量、可读性和最佳实践的一致性。它帮助开发者及早发现常见问题,保持代码库的整洁,并遵循行业标准规范。这些检查规则适用于 Flutter 和纯 Dart 应用,非常适合追求高质量、可维护代码的团队。它可通过 pub 与 Flutter 工具链无缝集成。

适合场景

  • 在团队项目中强制执行一致的代码风格
  • 通过自动化 linting 提升代码质量
  • 保持干净且可读的 Dart/Flutter 代码库
  • 将标准化的 linting 集成到 CI/CD 流水线中
  • 通过清晰的编码规范支持入职

主要特点

  • 预定义的、有意见的静态检查规则
  • 与 Flutter 和 Dart 工具链的集成
  • 定期更新以符合现代实践
  • 支持所有主要平台
  • 专为团队一致性设计

适合对象

  • Flutter 开发团队
  • Dart 项目维护者
  • 注重代码质量的团队
  • CI/CD 环境
  • 新开发者学习最佳实践

使用建议

  • 现有项目可能需要配置调整
  • 有倾向性的规则可能不适合每个团队的风格
  • 需要理解 linting 概念
  • 不适合避免严格 lint 检查的项目
  • 需要定期更新以保持最新

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Very Good Analysis

Very Good Ventures Very Good Ventures

Developed with 💙 by Very Good Ventures 🦄

ci pub package License: MIT style: very good analysis


This package provides lint rules for Dart and Flutter which are used at Very Good Ventures. For more information, see the complete list of options.

Note: This package was heavily inspired by pedantic.

Usage

To use the lints, add as a dev dependency in your pubspec.yaml:

dart pub add dev:very_good_analysis
# or
flutter pub add dev:very_good_analysis

Then, add an include in analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml

This will ensure you always use the latest version of the lints. If you wish to restrict the lint version, specify a version of analysis_options.yaml instead:

include: package:very_good_analysis/analysis_options.10.0.0.yaml

Formatter

In addition to lint rules, this package configures the Dart formatter. Trailing commas are set to automate, which lets the formatter decide when to add or remove trailing commas to keep code readable:

formatter:
  trailing_commas: automate

If you prefer to manage trailing commas yourself, override this setting in your analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml
formatter:
  trailing_commas: preserve

Suppressing Lints

There may be cases where specific lint rules are undesirable. Lint rules can be suppressed at the line, file, or project level.

An example use case for suppressing lint rules at the file level is suppressing the prefer_const_constructors in order to achieve 100% code coverage. This is due to the fact that const constructors are executed before the tests are run, resulting in no coverage collection.

Line Level

To suppress a specific lint rule for a specific line of code, use an ignore comment directly above the line:

// ignore: public_member_api_docs
class A {}
File Level

To suppress a specific lint rule of a specific file, use an ignore_for_file comment at the top of the file:

// ignore_for_file: public_member_api_docs

class A {}

class B {}
Project Level

To suppress a specific lint rule for an entire project, modify analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml
linter:
  rules:
    public_member_api_docs: false

Badge

To indicate your project is using very_good_analysis → style: very good analysis

[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)

Excluded rules

Below is a list of rules that are not enabled by default together with the reason on why they have been excluded:

Rule Reason
always_put_control_body_on_new_line Can conflict with the Dart formatter
always_specify_types Incompatible with omit_local_variable_types
annotate_redeclares Experimental
avoid_annotating_with_dynamic Not specified
avoid_classes_with_only_static_members Not specified
avoid_futureor_void Experimental
avoid_implementing_value_types We need to implement value types for mocks/fakes in tests
avoid_null_checks_in_equality_operators Has been deprecated and will be removed
avoid_private_typedef_functions Deprecated
close_sinks Has unresolved false positives
diagnostic_describe_all_properties Not specified
do_not_use_environment Not specified
initialize_in_field_declaration Not specified
library_names Superseded by unnecessary_library_name
no_dynamic_casts Not specified
no_raw_types Not specified
no_runtimetype_tostring Not specified
omit_obvious_local_variable_types Experimental
omit_obvious_property_types Incompatible with type_annotate_public_apis
one_member_abstracts Deprecated
package_prefixed_library_names Broken; superseded by unnecessary_library_name
prefer_double_quotes Incompatible with prefer_single_quotes
prefer_expression_function_bodies Not specified
prefer_final_parameters Incompatible with avoid_final_parameters
prefer_for_elements_to_map_fromiterable Not specified
prefer_iterable_wheretype Not specified
prefer_relative_imports Incompatible with always_use_package_imports
prefer_void_to_null Has unresolved false positives
specify_nonobvious_local_variable_types Experimental
unnecessary_async Experimental
unnecessary_await_in_return Deprecated
unnecessary_const_in_enum_constructor Not specified
unnecessary_final Incompatible with prefer_final_locals
unreachable_from_main Not specified
unsafe_variance Experimental
use_decorated_box Has unresolved malfunctions
use_if_null_to_convert_nulls_to_bools Not specified
use_primary_constructors Not specified
var_with_no_type_annotation Not specified

所属分类

源码仓库

使用此插件的项目

所在榜单