Flutter Lints

https://pub.dev/packages/flutter_lints
Admin
This package provides a recommended set of lints for Flutter applications, packages, and plugins to...
Tokens:11,041
Snippets:235
Trust Score:9.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### pubspec.yaml Dependency Example

Source: https://pub.dev/packages/flutter_lints/versions/2.0.3/install

Example of how the flutter_lints package appears in the dev_dependencies section of a pubspec.yaml file. This configuration enables the recommended lints for the project.

```yaml
dev_dependencies:
  flutter_lints: ^2.0.3
```

--------------------------------

### Example pubspec.yaml with flutter_lints

Source: https://pub.dev/packages/flutter_lints/versions/1.0.0-dev.0/install

An example snippet showing how the flutter_lints package is declared under dev_dependencies in a Dart project's pubspec.yaml file after being added.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.0-dev.0
```

--------------------------------

### Example pubspec.yaml with flutter_lints

Source: https://pub.dev/packages/flutter_lints/versions/1.0.3/install

An example snippet illustrating how the flutter_lints package is declared under `dev_dependencies` in a Dart project's pubspec.yaml file. This configuration enables the recommended linting rules for your project.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.3
```

--------------------------------

### Example pubspec.yaml Entry for flutter_lints

Source: https://pub.dev/packages/flutter_lints/versions/2.0.1/install

This snippet shows how the `flutter_lints` package is listed under `dev_dependencies` in a `pubspec.yaml` file after being added via `dart pub add dev:flutter_lints`. This ensures the linter is available during development and analysis.

```yaml
dev_dependencies:
  flutter_lints: ^2.0.1
```

--------------------------------

### Example pubspec.yaml Entry (Dart)

Source: https://pub.dev/packages/flutter_lints/versions/3.0.0/install

This shows how the flutter_lints package is listed under 'dev_dependencies' in a Dart project's pubspec.yaml file after being added.

```yaml
dev_dependencies:
  flutter_lints: ^3.0.0
```

--------------------------------

### pubspec.yaml Dependency Example

Source: https://pub.dev/packages/flutter_lints/versions/4.0.0/install

This snippet shows how the `flutter_lints` package is added to the `dev_dependencies` section of a `pubspec.yaml` file.

```yaml
dev_dependencies:
  flutter_lints: ^4.0.0
```

--------------------------------

### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/flutter_lints/versions/3.0.2/install

This snippet shows how the flutter_lints package is declared as a dev_dependency within a project's pubspec.yaml file. This configuration ensures that the linter is active during development and analysis.

```yaml
dev_dependencies:
  flutter_lints: ^3.0.2
```

--------------------------------

### Example pubspec.yaml Configuration

Source: https://pub.dev/packages/flutter_lints/versions/5.0.0/install

This snippet shows how the flutter_lints package is declared as a dev_dependency within a project's pubspec.yaml file. This configuration is automatically updated when using `dart pub add` or `flutter pub add`.

```yaml
dev_dependencies:
  flutter_lints: ^5.0.0
```

--------------------------------

### Dart Example: Basic Flutter App with Lint Ignored

Source: https://pub.dev/packages/flutter_lints/example

This Dart code snippet shows a simple Flutter application demonstrating how to use `ignore_for_file` and `ignore` comments to deactivate specific lints. It highlights the `avoid_renaming_method_parameters` and `avoid_print` lints.

```dart
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// The code in this file (and all other dart files in the package) is
// analyzed using the rules activated in `analysis_options.yaml`.

// The following syntax deactivates a lint for the entire file:
// ignore_for_file: avoid_renaming_method_parameters

void main() {
  const String partOne = 'Hello';
  const String partTwo = 'World';

  // The following syntax deactivates a lint on a per-line bases:
  print('$partOne $partTwo'); // ignore: avoid_print
}

abstract class Base {
  int methodA(int foo);
  String methodB(String foo);
}

// Normally, the parameter renaming from `foo` to `bar` in this class would
// trigger the `avoid_renaming_method_parameters` lint, but it has been
// deactivated for the file with the `ignore_for_file` comment above.
class Sub extends Base {
  @override
  int methodA(int bar) => bar;

  @override
  String methodB(String bar) => bar;
}

```

--------------------------------

### Add flutter_lints to Dart Project

Source: https://pub.dev/packages/flutter_lints/versions/2.0.2/install

This command adds the flutter_lints package as a development dependency to your Dart project. It modifies your pubspec.yaml file and implicitly runs `dart pub get`.

```bash
dart pub add dev:flutter_lints
```

```yaml
dev_dependencies:
  flutter_lints: ^2.0.2
```

--------------------------------

### Add flutter_lints to Flutter Project

Source: https://pub.dev/packages/flutter_lints/versions/3.0.2/install

This command adds the flutter_lints package as a development dependency to your Flutter project. It updates the pubspec.yaml file and implicitly runs `flutter pub get`. This is the recommended way to add linters for Flutter applications.

```bash
$ flutter pub add dev:flutter_lints
```

--------------------------------

### Configure Flutter Lints with analyzer_options.yaml

Source: https://pub.dev/packages/flutter_lints/versions/1.0

This snippet demonstrates how to configure the Dart analyzer to use the flutter_lints package. It involves creating an analyzer_options.yaml file and including the package's lint configuration. This setup is crucial for enabling static code analysis and enforcing coding standards in Flutter projects.

```yaml
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
  # The lint rules applied to this project can be customized in the
  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
  # included above or to enable additional rules. A list of all available lints
  # and their documentation is published at
  # https://dart-lang.github.io/linter/lints/index.html.
  #
  # Instead of disabling a lint rule for the entire project in the
  # section below, it can also be suppressed for a single line of code
  # or a specific dart file by using the `// ignore: name_of_lint` and
  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
  # producing the lint.
  rules:
    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart-dev/guides/language/analysis-options

```

--------------------------------

### Add flutter_lints Dev Dependency with Dart CLI

Source: https://pub.dev/packages/flutter_lints/versions/0.0.0/install

This command adds the flutter_lints package as a development dependency to your Flutter project using the Dart CLI. It automatically updates your pubspec.yaml file and runs `dart pub get`.

```bash
$ dart pub add dev:flutter_lints
```

--------------------------------

### Add flutter_lints to Dart Project Dependencies

Source: https://pub.dev/packages/flutter_lints/versions/3.0.1/install

This command adds the flutter_lints package as a development dependency to your Dart project. It modifies the pubspec.yaml file and implicitly runs 'dart pub get'. Ensure you are in your project's root directory when executing this command.

```bash
dart pub add dev:flutter_lints
```

```yaml
dev_dependencies:
  flutter_lints: ^3.0.1
```

--------------------------------

### pubspec.yaml Entry for flutter_lints

Source: https://pub.dev/packages/flutter_lints/versions/1.0.2/install

This snippet shows how the flutter_lints package is added to the `dev_dependencies` section of a `pubspec.yaml` file. This is the standard way to include development tools and linters in a Flutter project.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.2
```

--------------------------------

### Configure Flutter Lints in analysis_options.yaml

Source: https://pub.dev/packages/flutter_lints/index

This snippet shows how to configure the `flutter_lints` package in your `analysis_options.yaml` file. It includes the package's default lint rules and demonstrates how to customize or disable specific rules. This configuration is essential for the Dart analyzer to apply the recommended lints.

```yaml
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
  # The lint rules applied to this project can be customized in the
  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
  # included above or to enable additional rules. A list of all available lints
  # and their documentation is published at https://dart.dev/tools/linter-rules.
  #
  # Instead of disabling a lint rule for the entire project in the
  # section below, it can also be suppressed for a single line of code
  # or a specific dart file by using the `// ignore: name_of_lint` and
  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
  # producing the lint.
  rules:
    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart.dev/tools/analysis

```

--------------------------------

### Configure flutter_lints in analysis_options.yaml (Dart)

Source: https://pub.dev/packages/flutter_lints/versions/2

This snippet shows how to configure the flutter_lints package in the `analysis_options.yaml` file. It includes the package's default lint configuration and demonstrates how to optionally disable or enable specific lints.

```yaml
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
  # The lint rules applied to this project can be customized in the
  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
  # included above or to enable additional rules. A list of all available lints
  # and their documentation is published at https://dart.dev/lints.
  #
  # Instead of disabling a lint rule for the entire project in the
  # section below, it can also be suppressed for a single line of code
  # or a specific dart file by using the `// ignore: name_of_lint` and
  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
  # producing the lint.
  rules:
    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options

```

--------------------------------

### Add flutter_lints as a Dev Dependency (Flutter)

Source: https://pub.dev/packages/flutter_lints/install

This command adds the flutter_lints package as a development dependency for your Flutter project using the Flutter CLI. It makes the recommended linting rules available for your Flutter application.

```bash
flutter pub add dev:flutter_lints
```

--------------------------------

### Configure analysis_options.yaml to include flutter_lints

Source: https://pub.dev/packages/flutter_lints/versions/1

This configuration file tells the Dart analyzer to include the linting rules provided by the flutter_lints package. You can also customize or disable specific rules within this file.

```yaml
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart-dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
  # The lint rules applied to this project can be customized in the
  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
  # included above or to enable additional rules. A list of all available lints
  # and their documentation is published at
  # https://dart-lang.github.io/linter/lints/index.html.
  #
  # Instead of disabling a lint rule for the entire project in the
  # section below, it can also be suppressed for a single line of code
  # or a specific dart file by using the `// ignore: name_of_lint` and
  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
  # producing the lint.
  rules:
    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart-dev/guides/language/analysis-options

```

--------------------------------

### flutter_lints Dev Dependency in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/versions/0.0.0/install

This snippet shows how the flutter_lints package appears in the `dev_dependencies` section of your project's `pubspec.yaml` file after being added via the Dart CLI.

```yaml
dev_dependencies:
  flutter_lints: ^0.0.0
```

--------------------------------

### Add flutter_lints Dependency (Flutter)

Source: https://pub.dev/packages/flutter_lints/versions/2.0.3/install

Command to add the flutter_lints package as a development dependency for Flutter projects. This command ensures the package is available for linting in your Flutter application.

```bash
# flutter pub add dev:flutter_lints
```

--------------------------------

### Add flutter_lints as a dev dependency

Source: https://pub.dev/packages/flutter_lints/versions/1

This command adds the flutter_lints package as a development dependency to your Flutter project. This is necessary to use the recommended linting rules for your project.

```bash
flutter pub add --dev flutter_lints
```

--------------------------------

### Add flutter_lints as a Dev Dependency (Dart)

Source: https://pub.dev/packages/flutter_lints/install

This command adds the flutter_lints package as a development dependency for your Dart project using the Dart CLI. It ensures that the linter is available for use during development and testing.

```bash
dart pub add dev:flutter_lints
```

--------------------------------

### Declare flutter_lints in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/install

This snippet shows how to declare the flutter_lints package as a dev_dependency in your project's pubspec.yaml file. This is the standard way to include development tools and libraries.

```yaml
dev_dependencies:
  flutter_lints: ^6.0.0
```

--------------------------------

### Add flutter_lints Dependency (Dart)

Source: https://pub.dev/packages/flutter_lints/versions/2.0.3/install

Command to add the flutter_lints package as a development dependency for Dart projects. This command automatically updates the pubspec.yaml file.

```bash
# dart pub add dev:flutter_lints
```

--------------------------------

### Flutter Lints Dependency in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/versions/2.0.0/install

This YAML snippet shows how the flutter_lints package is declared as a development dependency within a Dart project's pubspec.yaml file. This ensures the lints are applied during development and analysis.

```yaml
dev_dependencies:
  flutter_lints: ^2.0.0
```

--------------------------------

### flutter_lints Dependency in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/versions/1.0.1/install

This snippet shows how the flutter_lints package is declared as a dev dependency in a Dart project's `pubspec.yaml` file. This configuration is typically added automatically when using the `dart pub add` command.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.1
```

--------------------------------

### flutter_lints Dependency in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/versions/1.0.4/install

This snippet shows how the flutter_lints package is declared as a dev_dependency in a project's pubspec.yaml file. This declaration ensures that the linter is available during development but not in the final production build.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.4
```

--------------------------------

### flutter_lints Dependency in pubspec.yaml

Source: https://pub.dev/packages/flutter_lints/versions/1.0.0/install

This snippet shows how the flutter_lints package is declared as a dev_dependency within a Dart project's pubspec.yaml file. This configuration is typically added automatically when using `dart pub add`.

```yaml
dev_dependencies:
  flutter_lints: ^1.0.0
```
Tokens:
Raw