From c85fc801cca329e3b6688e7468785f405e44c117 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Thu, 20 Oct 2022 11:58:54 -0700 Subject: [PATCH] update lint files docs --- .github/dependabot.yaml | 8 ++++++++ .github/workflows/validate.yml | 2 +- CHANGELOG.md | 5 +++++ README.md | 3 ++- lib/core.yaml | 6 ++++++ lib/recommended.yaml | 9 +++++++++ pubspec.yaml | 11 ++++++----- 7 files changed, 37 insertions(+), 7 deletions(-) create mode 100644 .github/dependabot.yaml diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..2144819 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,8 @@ +# Dependabot configuration file. +version: 2 + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 09461b0..59847a7 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -21,7 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b - name: Check for sources run: | diff --git a/CHANGELOG.md b/CHANGELOG.md index 9201fe6..fd5cddc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## 2.0.1 + +- Updated documentation for the `lib/core.yaml` and `lib/recommended.yaml` + analysis configurations. + ## 2.0.0 - Added the following lints to core.yaml: diff --git a/README.md b/README.md index 2748bc6..2d9751a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -[![pub package](https://img.shields.io/pub/v/lints.svg)](https://pub.dev/packages/lints) [![Build Status](https://github.com/dart-lang/lints/workflows/validate/badge.svg)](https://github.com/dart-lang/lints/actions?query=branch%3Amain) +[![pub package](https://img.shields.io/pub/v/lints.svg)](https://pub.dev/packages/lints) +[![package publisher](https://img.shields.io/pub/publisher/lints.svg)](https://pub.dev/packages/lints/publisher) # Official Dart lint rules diff --git a/lib/core.yaml b/lib/core.yaml index b5e8cd2..ec6fff7 100644 --- a/lib/core.yaml +++ b/lib/core.yaml @@ -1,3 +1,9 @@ +# This is a set of core lints used to identify critical issues. See +# https://github.com/dart-lang/lints for more information. +# +# For documentation about customizing static analysis for your project, see +# https://dart.dev/guides/language/analysis-options. + linter: rules: - avoid_empty_else diff --git a/lib/recommended.yaml b/lib/recommended.yaml index 13999d1..7541773 100644 --- a/lib/recommended.yaml +++ b/lib/recommended.yaml @@ -1,3 +1,12 @@ +# This set of lints builds on top of `package:lints/core.yaml`; it includes +# lints that help identify additional issues that may lead to problems when +# running or consuming Dart code, as well as lints that enforce writing Dart +# using a single, idiomatic style. See https://github.com/dart-lang/lints for +# more information. +# +# For documentation about customizing static analysis for your project, see +# https://dart.dev/guides/language/analysis-options. + include: package:lints/core.yaml linter: diff --git a/pubspec.yaml b/pubspec.yaml index 3d19220..13260db 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,12 +1,13 @@ name: lints -description: Official Dart lint rules. Defines the 'core' and 'recommended' set of lints suggested by the Dart team. -homepage: https://github.com/dart-lang/lints +version: 2.0.1 +description: > + Official Dart lint rules. Defines the 'core' and 'recommended' set of lints + suggested by the Dart team. repository: https://github.com/dart-lang/lints -version: 2.0.0 environment: - sdk: '>=2.17.0-206.0.dev <3.0.0' + sdk: '>=2.17.0 <3.0.0' +# NOTE: Code is not allowed in this package. Do not add dependencies. # dependencies: # dev_dependencies: -# NOTE: Code is not allowed in this package. Do not add dependencies.