Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bamlab/theodo_analysis
Lint and dcm rules for Dart and Flutter used internally at theodo apps ❤️💙💛
https://github.com/bamlab/theodo_analysis
dart dcm flutter lint
Last synced: about 1 month ago
JSON representation
Lint and dcm rules for Dart and Flutter used internally at theodo apps ❤️💙💛
- Host: GitHub
- URL: https://github.com/bamlab/theodo_analysis
- Owner: bamlab
- License: mit
- Created: 2024-09-07T20:03:17.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-22T12:36:57.000Z (about 2 months ago)
- Last Synced: 2024-09-29T11:45:37.691Z (about 1 month ago)
- Topics: dart, dcm, flutter, lint
- Language: Dart
- Homepage:
- Size: 372 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# THEODO Analysis
Lint and dcm rules for Dart and Flutter used internally at Theodo Apps ❤️💙💛.
Note: This package was heavily inspired by very_good_analysis.
---
## 🧑💻 Usage
To use the lints, add as a dev dependency in your `pubspec.yaml`:
```yaml
dart pub add dev:theodo_analysis
# or
flutter pub add dev:theodo_analysis
```
Then, add an include in `analysis_options.yaml`:
```yaml
include: package:theodo_analysis/analysis_options.yaml
```
**Optional**: enable DCM.
This packages also include a subset of [dcm](https://dcm.dev) rules. Since dcm needs an API key to start. You can skip this part. Also, we consider it as a great tool, and we recommend it's usage.
First instal dcm:
```bash
$ brew tap CQLabs/dcm
$ brew install dcm
```
Then, [activate the license](https://dcm.dev/docs/getting-started/#activating-the-license):
```bash
dcm activate --license-key=YOUR_KEY
```
## ⚙️ Customize rules
To add or suppress a specific rules, you can edit the `analysis_options.yaml` file.
Suppression:
```yaml
include: package:theodo_analysis/theodo_analysis.yaml
linter:
rules:
public_member_api_docs: false
dart_code_metrics:
rules:
- member-ordering: false
```
Addition:
```yaml
include: package:theodo_analysis/theodo_analysis.yaml
linter:
rules:
- no_leading_underscores_for_local_identifiers
dart_code_metrics:
rules:
- avoid-inferrable-type-arguments
```
> The list of all available dart rule can be found [here](https://dart.dev/tools/linter-rules/all).
> And the list of all available dcm rules can be found [here](https://dcm.dev/docs/rules/).
You can also disable it for specific files or folder. By default, theodo_analysis will not be applied to generated files.
```yaml
include: package:theodo_analysis/theodo_analysis.yaml
analyzer:
exclude:
- "**/*.g.dart"
- "**/*.freezed.dart"
- "**/*.graphql.dart"
dart_code_metrics:
rules-exclude:
- "**/*.g.dart"
- "**/*.freezed.dart"
- "**/*.graphql.dart"
```
## 👉 About Theodo Apps
We are a 130 people company developing and designing universal applications with [React Native](https://apps.theodo.com/expertise/react-native) and [Flutter](https://apps.theodo.com/expertise/flutter) using the Lean & Agile methodology. To get more information on the solutions that would suit your needs, feel free to get in touch by [email](mailto://[email protected]) or through or [contact form](https://apps.theodo.com/contact)!
We will always answer you with pleasure 😁