|
1 |
| -<a href="https://github.com/netglade"> |
2 |
| - <picture > |
3 |
| - <source media="(prefers-color-scheme: dark)" height='120px' srcset="https://raw.githubusercontent.com/netglade/netglade_analysis/main/doc/badge_light.png"> |
4 |
| - <source media="(prefers-color-scheme: light)" height='120px' srcset="https://raw.githubusercontent.com/netglade/netglade_analysis/main/doc/badge_dark.png"> |
5 |
| - <img alt="netglade" height='120px' src="https://raw.githubusercontent.com/netglade/netglade_analysis/main/doc/badge_dark.png"> |
6 |
| - </picture> |
7 |
| -</a> |
8 |
| - |
9 |
| -Developed with 💚 by [netglade][netglade_link] |
10 |
| - |
11 |
| -[![ci][ci_badge]][ci_badge_link] |
12 |
| -[![pub package][pub_badge]][pub_badge_link] |
13 |
| -[![license: MIT][license_badge]][license_badge_link] |
14 |
| -[![style: netglade analysis][style_badge]][style_badge_link] |
15 |
| -[![Discord][discord_badge]][discord_badge_link] |
16 |
| - |
17 |
| ---- |
18 |
| - |
19 |
| -This package provides lint rules for Dart and Flutter which are used at [netglade][netglade_link]. |
20 |
| - |
21 |
| -You can also check all the available Dart lint rules on [linter rules site][linter_rules] or [supported lint rules site][supported_lint_rules]. |
22 |
| -And you can see all the available on [DCM rules site][dcm_rules]. |
23 |
| - |
24 |
| -## Usage |
25 |
| - |
26 |
| -To use the lints, add as a dev dependency in your `pubspec.yaml`: |
27 |
| - |
28 |
| -```yaml |
29 |
| -dev_dependencies: |
30 |
| - netglade_analysis: ^4.0.0 |
31 |
| -``` |
32 |
| -
|
33 |
| -Then, add an include in `analysis_options.yaml`: |
34 |
| - |
35 |
| -```yaml |
36 |
| -include: package:netglade_analysis/lints.yaml |
37 |
| -``` |
38 |
| - |
39 |
| -To also use [Dart Code Metrics](https://dcm.dev), add configuration in `analysis_options.yaml`. |
40 |
| -Then you can use its CLI tool. |
41 |
| - |
42 |
| -```yaml |
43 |
| -dart_code_metrics: |
44 |
| - extends: |
45 |
| - - package:netglade_analysis/dcm.yaml |
46 |
| -``` |
47 |
| - |
48 |
| -## Recommendations |
49 |
| - |
50 |
| -Consider adding an analyzer exclude for generated, coverage, ... files. |
51 |
| - |
52 |
| -```yaml |
53 |
| -analyzer: |
54 |
| - exclude: |
55 |
| - - '**/*.g.dart' |
56 |
| - - '**/*.freezed.dart' |
57 |
| - - test/.test_coverage.dart |
58 |
| - - lib/generated_plugin_registrant.dart |
59 |
| -``` |
60 |
| - |
61 |
| -## Badge |
62 |
| - |
63 |
| -To indicate your project is using `netglade_analysis` → |
64 |
| -[![style: netglade analysis][style_badge]][style_badge_link] |
65 |
| - |
66 |
| -```md |
67 |
| -[](https://pub.dev/packages/netglade_analysis) |
68 |
| -``` |
69 |
| - |
70 |
| -[netglade_link]: https://netglade.com/en |
71 |
| - |
72 |
| -[ci_badge]: https://github.com/netglade/netglade_analysis/workflows/ci/badge.svg |
73 |
| -[ci_badge_link]: https://github.com/netglade/netglade_analysis/actions |
74 |
| -[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg |
75 |
| -[license_badge_link]: https://opensource.org/licenses/MIT |
76 |
| -[pub_badge]: https://img.shields.io/pub/v/netglade_analysis.svg |
77 |
| -[pub_badge_link]: https://pub.dartlang.org/packages/netglade_analysis |
78 |
| -[style_badge]: https://img.shields.io/badge/style-netglade_analysis-26D07C.svg |
79 |
| -[style_badge_link]: https://pub.dev/packages/netglade_analysis |
80 |
| -[discord_badge]: https://img.shields.io/discord/1091460081054400532.svg?logo=discord&color=blue |
81 |
| -[discord_badge_link]: https://discord.gg/sJfBBuDZy4 |
82 |
| - |
83 |
| -[linter_rules]: https://dart.dev/tools/linter-rules |
84 |
| -[supported_lint_rules]: https://dart-lang.github.io/linter/lints |
85 |
| -[dcm_rules]: https://dcm.dev/docs/rules/ |
| 1 | +# NetGlade Flutter Core |
| 2 | + |
| 3 | +[![license: MIT][license_badge]][license_badge_link] |
| 4 | +[![Discord][discord_badge]][discord_badge_link] |
| 5 | + |
| 6 | +Dart and Flutter packages used internally at [netglade][netglade_link] |
| 7 | + |
| 8 | +| Package | pub | CI | |
| 9 | +| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | |
| 10 | +| [netglade_analysis][netglade_analysis-link] | [![netglade_analysis pub.dev badge][netglade_analysis-pub-badge]][netglade_analysis-pub-badge-link] | [![][netglade_analysis-build-badge]][netglade_analysis-build-badge-link] | |
| 11 | +| [netglade_utils][netglade_utils-link] | [![netglade_utils pub.dev badge][netglade_utils-pub-badge]][netglade_utils-pub-badge-link] | [![][netglade_utils-build-badge]][netglade_utils-build-badge-link] | |
| 12 | +| [netglade_flutter_utils][netglade_flutter_utils-link] | [![netglade_flutter_utils pub.dev badge][netglade_flutter_utils-pub-badge]][netglade_flutter_utils-pub-badge-link] | [![][netglade_flutter_utils-build-badge]][netglade_flutter_utils-build-badge-link] | |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +[netglade_link]: https://netglade.com/en |
| 17 | +[discord_badge]: https://img.shields.io/discord/1091460081054400532.svg?logo=discord&color=blue |
| 18 | +[discord_badge_link]: https://discord.gg/sJfBBuDZy4 |
| 19 | +[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg |
| 20 | +[license_badge_link]: https://opensource.org/licenses/MIT |
| 21 | + |
| 22 | +[netglade_analysis-link]: https://github.com/netglade/flutter_core/tree/main/packages/netglade_analysis |
| 23 | +[netglade_analysis-pub-badge]: https://img.shields.io/pub/v/netglade_analysis.svg |
| 24 | +[netglade_analysis-pub-badge-link]: https://pub.dartlang.org/packages/netglade_analysis |
| 25 | +[netglade_analysis-build-badge]: https://github.com/netglade/flutter_core/workflows/netglade_analysis-test/badge.svg |
| 26 | +[netglade_analysis-build-badge-link]: https://github.com/netglade/flutter_core/actions/workflows/netglade_utils-test.yaml |
| 27 | + |
| 28 | +[netglade_utils-link]: https://github.com/netglade/flutter_core/tree/main/packages/netglade_utils |
| 29 | +[netglade_utils-pub-badge]: https://img.shields.io/pub/v/netglade_utils.svg |
| 30 | +[netglade_utils-pub-badge-link]: https://pub.dartlang.org/packages/netglade_utils |
| 31 | +[netglade_utils-build-badge]: https://github.com/netglade/flutter_core/workflows/netglade_utils-test/badge.svg |
| 32 | +[netglade_utils-build-badge-link]: https://github.com/netglade/flutter_core/actions/workflows/netglade_utils-test.yaml |
| 33 | + |
| 34 | +[netglade_flutter_utils-link]: https://github.com/netglade/flutter_core/tree/main/packages/netglade_flutter_utils |
| 35 | +[netglade_flutter_utils-pub-badge]: https://img.shields.io/pub/v/netglade_flutter_utils.svg |
| 36 | +[netglade_flutter_utils-pub-badge-link]: https://pub.dartlang.org/packages/netglade_flutter_utils |
| 37 | +[netglade_flutter_utils-build-badge]: https://github.com/netglade/flutter_core/workflows/netglade_flutter_utils-test/badge.svg |
| 38 | +[netglade_flutter_utils-build-badge-link]: https://github.com/netglade/flutter_core/actions/workflows/netglade_utils-test.yaml |
0 commit comments