dart-code-linter GitHub Details, Stars and Alternatives | OpenRepoFinder
bancolombia / repository
dart-code-linter
Dart Code Linter is a software analytics tool that helps developers analyse and improve software quality. Dart Code Linter is based on a fork of Dart Code Metrics. We welcome contributions from other developers. Please feel free to submit pull-requests and bugreports to this GitHub repository.
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
100
Community adoption25% weight
39
Maintenance state20% weight
65
License clarity10% weight
100
Project information10% weight
92
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
Dart Code Linter
Dart Code Linter (DCL) is a powerful toolkit designed to enhance your development process by identifying and resolving issues within your Dart and Flutter code. Whether you're dealing with potential runtime bugs, violations of best practices, or styling concerns, DCL has got you covered. With a comprehensive collection of over 70 pre-built rules, you can effortlessly validate your code against a variety of expectations. Furthermore, DCL offers the flexibility to customize these rules to cater to your specific requirements, ensuring an optimized coding experience.
Links
See CHANGELOG.md for major/breaking updates, and releases for a detailed version history.
DCL can be used as a plugin for the Dart analyzerpackage providing additional rules. All issues produced by rules or anti-patterns will be highlighted in the IDE.
Depending on your Dart SDK version, you can configure the plugin in two ways:
1. Analysis Server Plugin (Recommended for Dart >= 3.9)
DCL supports the new Dart Analysis Server plugin protocol (analysis_server_plugin). To use it, add the plugin configuration under the top-level plugins key in your analysis_options.yaml:
plugins:
dart_code_linter:
diagnostics:
avoid-dynamic: true
prefer-trailing-comma: true
# ... add other rule IDs to enable them
[!NOTE]
Rules that require mandatory user-supplied configuration (such as avoid-banned-imports or ban-name) are not currently supported via the analysis_server_plugin protocol and should be configured using the legacy mechanism instead.
2. Legacy Analyzer Plugin (Dart < 3.9)
Configure the plugin under analyzer in your analysis_options.yaml:
Rules that are marked with 🛠 have auto-fixes available through the IDE context menu. VS Code example:
Compatibility
As DCL depends on the Dart analyzer package. The following table shows the compatible versions:
DCL Version
Analyzer Version
Dart SDK
4.1.7
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.6
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.5
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.4
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.3
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.2
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.1
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.1.0
>=10.0.0 <14.0.0
>=3.5.0 <4.0.0
4.0.5
>=10.0.0 <13.0.0
>=3.5.0 <4.0.0
4.0.4
>=10.0.0 <13.0.0
>=3.5.0 <4.0.0
4.0.3
>=10.0.0 <13.0.0
>=3.5.0 <4.0.0
4.0.2
>=10.0.0 <13.0.0
>=3.5.0 <4.0.0
4.0.1
>=10.0.0 <13.0.0
>=3.5.0 <4.0.0
4.0.0
>=11.0.0 <12.0.0
>=3.5.0 <4.0.0
>=3.2.0 <4.0.0
^8.0.0
>=3.4.0 <4.0.0
>=3.0.0 <3.2.0
^7.4.1
>=3.4.0 <4.0.0
>=2.0.0 <3.0.0
^6.0.0
>=3.0.0 <4.0.0
CLI
The package can be used as CLI and supports multiple commands:
Command
Example of use
Short description
analyze
dart run dart_code_linter:metrics analyze lib
Reports code metrics, rules and anti-patterns violations.
check-unnecessary-nullable
dart run dart_code_linter:metrics check-unnecessary-nullable lib
Checks unnecessary nullable parameters in functions, methods, constructors.
check-unused-files
dart run dart_code_linter:metrics check-unused-files lib
Checks unused *.dart files.
check-unused-l10n
dart run dart_code_linter:metrics check-unused-l10n lib
Check unused localization in *.dart files.
check-unused-code
dart run dart_code_linter:metrics check-unused-code lib
Checks unused code in *.dart files.
For additional help on any of the commands, enter dart run dart_code_linter:metrics help <command>
Note: if you're setting up DCL for multi-package repository (a.k.a. monorepo), it'll pick up analysis_options.yaml files correctly.
You can define one analysis_options.yaml at the root file.
Analyze
Reports code metrics, rules and anti-patterns violations. To execute the command, run
$ dart run dart_code_linter:metrics analyze lib
It will produce a result in one of the format:
Console
GitHub
Codeclimate
HTML
JSON
Check unnecessary nullable parameters
Checks unnecessary nullable parameters in functions, methods, constructors. To execute the command, run
$ dart run dart_code_linter:metrics check-unnecessary-nullable lib
It will produce a result in one of the format:
Console
JSON
Check unused files
Checks unused *.dart files. To execute the command, run
$ dart run dart_code_linter:metrics check-unused-files lib
It will produce a result in one of the format:
Console
JSON
Check unused localization
Checks unused Dart class members, that encapsulates the app’s localized values.
An example of such class:
class ClassWithLocalization {
String get title {
return Intl.message(
'Hello World',
name: 'title',
desc: 'Title for the Demo application',
locale: localeName,
);
}
}
To execute the command, run
$ dart run dart_code_linter:metrics check-unused-l10n lib
It will produce a result in one of the format:
Console
JSON
Check unused code
Checks unused code in *.dart files. To execute the command, run
$ dart run dart_code_linter:metrics check-unused-code lib
It will produce a result in one of the format:
Console
JSON
Troubleshooting
Please read the following guide if the plugin is not working as you'd expect it to work.
Contributing
If you are interested in contributing, please check out the contribution guidelines. Feedback and contributions are welcome!
