myple_lint

Description:

myple lint

myple lint #
Developed with ❤️ by myple




This package provides lint rules for Dart and Flutter which are used at myple. For more information, see the complete list of options.
Note: This package was heavily inspired by pedantic.

Usage #

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

# If you use `package:myple_lint/myple_lint.dart`, add a normal dependency.
dependencies:
myple_lint: ^0.1.0

# Or, if you just want `analysis_options.yaml`, it can be a dev dependency.
dev_dependencies:
myple_lint: ^0.1.0
copied to clipboard

Then, add an include in analysis_options.yaml:

include: package:myple_lint/analysis_options.yaml
copied to clipboard
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:myple/analysis_options.0.1.0.yaml
copied to clipboard

Suppressing Lints #
There may be cases where specific lint rules are undesirable. Lint rules can be surpressed 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 surpress 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 {}
copied to clipboard
File Level #
To surpress 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 {}
copied to clipboard
Project Level #
To surpress a specific lint rule for an entire project, modify analysis_options.yaml:
include: package:myple_lint/analysis_options.yaml
linter:
rules:
public_member_api_docs: false
copied to clipboard

Badges #
To indicate your project is using myple lint

[](https://pub.dev/publishers/myple.io/packages)
copied to clipboard

[](https://pub.dev/publishers/myple.io/packages)
copied to clipboard

[](https://pub.dev/publishers/myple.io/packages)
copied to clipboard

[](https://pub.dev/publishers/myple.io/packages)
copied to clipboard

How to contribute #
If you would like to help contribute to this GitHub Action, please see CONTRIBUTING