Skip to content
This repository has been archived by the owner on Jan 7, 2025. It is now read-only.

Commit

Permalink
Cleanup docs and links (#142)
Browse files Browse the repository at this point in the history
  • Loading branch information
parlough authored Aug 11, 2023
1 parent 1e0245e commit 54cd7a0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 19 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,21 @@ sets in the ecosystem (available at [pub.dev](https://pub.dev/)).
Rule set authors: consider adding the `lints` topic to your pubspec to allow
easier discovery (e.g.,
[pub.dev/packages?q=topic:lints](https://pub.dev/packages?q=topic%3Alints)).
For more information about topics, see
For more information about topics, visit
[dart.dev/tools/pub/pubspec#topics](https://dart.dev/tools/pub/pubspec#topics).

## Where these lints are used

When creating new Dart project using the [`dart create`][dart create] command,
the lints from `package:lints` are enabled by default.
the `recommended` set of lints from `package:lints` is enabled by default.

When uploading a package to the [pub.dev] package repository, packages are
[awarded pub points][scoring] based on how many of the 'core' lints pass.

## Enabling the lints

For new apps created with `dart create` the `recommended` set of lints are enabled
by default.
For new apps created with `dart create` the `recommended` set of lints are
enabled by default.

For existing apps or packages, you can enable these lints via:

Expand All @@ -74,7 +74,7 @@ For existing apps or packages, you can enable these lints via:
## Customizing the predefined lint sets
For details on customizing static analysis above and beyond the predefined
lint sets, see [customizing static analysis].
lint sets, check out [Customizing static analysis].
## Evolving the lint sets
Expand Down Expand Up @@ -198,13 +198,12 @@ To use these lints create an `analysis_options.yaml` file with:
| [`use_rethrow_when_possible`](https://dart.dev/lints/use_rethrow_when_possible) | Use rethrow to rethrow a caught exception. | ✅ |
<!-- recommended -->
[dart create]: https://dart.dev/tools/dart-tool
[dart create]: https://dart.dev/tools/dart-create
[scoring]: https://pub.dev/help/scoring
[customizing static analysis]: https://dart.dev/guides/language/analysis-options
[customizing static analysis]: https://dart.dev/tools/analysis
[rules]: https://dart.dev/tools/linter-rules
[pub.dev]: https://pub.dev
[issue]: https://github.com/dart-lang/lints/issues
[linter repo]: https://github.com/dart-lang/linter
[`package:pedantic`]: https://pub.dev/packages/pedantic
[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints
[Fix]: https://dart.dev/tools/dart-fix
8 changes: 4 additions & 4 deletions lib/core.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This is a set of core lints used to identify critical issues. See
# https://github.com/dart-lang/lints for more information.
# This is a set of core lints used to identify critical issues.
# Check out 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.
# To learn more about customizing static analysis for your package or app,
# visit https://dart.dev/tools/analysis.

linter:
rules:
Expand Down
14 changes: 7 additions & 7 deletions lib/recommended.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# 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.
# This set of lints builds on top of `package:lints/core.yaml`.
# It includes lints that help identify additional issues that might lead to
# problems when running or consuming Dart code, as well as lints
# that enforce writing Dart using a single, idiomatic style.
# Check out 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.
# To learn more about customizing static analysis for your package or app,
# visit https://dart.dev/tools/analysis.

include: package:lints/core.yaml

Expand Down

0 comments on commit 54cd7a0

Please sign in to comment.