搜尋套件、儲存庫與 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

所屬分類

原始碼儲存庫

使用此套件的專案

所在榜單