From b980654e386076d18a7477a5091c71c2bc2ece66 Mon Sep 17 00:00:00 2001 From: Bartek Pacia Date: Wed, 1 Dec 2021 11:37:36 +0100 Subject: [PATCH] Remove `leancode_lint`'s dependency on `flutter` (#47) * * add .prettierrc * remove dependency on flutter * differentiate between app & package * Update packages/leancode_lint/README.md Co-authored-by: Marcin Wojnarowski * Update packages/leancode_lint/README.md Co-authored-by: Marcin Wojnarowski Co-authored-by: Marcin Wojnarowski --- .prettierrc | 3 +++ packages/leancode_lint/CHANGELOG.md | 5 +++++ packages/leancode_lint/README.md | 25 ++++++++++++++++++++++--- packages/leancode_lint/pubspec.yaml | 3 +-- 4 files changed, 31 insertions(+), 5 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..544138be --- /dev/null +++ b/.prettierrc @@ -0,0 +1,3 @@ +{ + "singleQuote": true +} diff --git a/packages/leancode_lint/CHANGELOG.md b/packages/leancode_lint/CHANGELOG.md index d3d38928..a15797b9 100644 --- a/packages/leancode_lint/CHANGELOG.md +++ b/packages/leancode_lint/CHANGELOG.md @@ -1,3 +1,8 @@ +# 1.0.2 + +- Remove dependency on `flutter` +- Update README to differentiate between app and package projects + # 1.0.1+1 - Improve explanation in README on why one might want to add `leancode_lint` as diff --git a/packages/leancode_lint/README.md b/packages/leancode_lint/README.md index c0294bbf..53a1ecc5 100644 --- a/packages/leancode_lint/README.md +++ b/packages/leancode_lint/README.md @@ -27,9 +27,11 @@ dependencies: ## Usage +### App + Add `include: package:leancode_lint/analysis_options.yaml` to `analysis_options.yaml` in your project. You might want to exclude some files -(e.g generated frezeed models) from analysis. +(e.g generated freezed models) from analysis. ```yaml include: package:leancode_lint/analysis_options.yaml @@ -37,8 +39,25 @@ include: package:leancode_lint/analysis_options.yaml # Optional analyzer: exclude: - - "**/*.g.dart" - - "**/*.freezed.dart" + - '**/*.g.dart' + - '**/*.freezed.dart' +``` + +### Package + +Add `include: package:leancode_lint/analysis_options_package.yaml` to +`analysis_options.yaml` in your project. It includes additional lints for +packages. You might want to exclude some files (e.g generated freezed models) +from analysis. + +```yaml +include: package:leancode_lint/analysis_options_package.yaml + +# Optional +analyzer: + exclude: + - '**/*.g.dart' + - '**/*.freezed.dart' ``` [pub-badge]: https://img.shields.io/pub/v/leancode_lint diff --git a/packages/leancode_lint/pubspec.yaml b/packages/leancode_lint/pubspec.yaml index 99519bd9..4c695d0e 100644 --- a/packages/leancode_lint/pubspec.yaml +++ b/packages/leancode_lint/pubspec.yaml @@ -1,12 +1,11 @@ name: leancode_lint -version: 1.0.1+1 +version: 1.0.2 homepage: https://github.com/leancodepl/flutter_corelibrary/tree/master/packages/leancode_lint repository: https://github.com/leancodepl/flutter_corelibrary description: Lint rules used internally at LeanCode. environment: sdk: '>=2.12.0 <3.0.0' - flutter: '>=2.0.0' dependencies: flutter_lints: ^1.0.4