Link to 'dart fix' docs in table header (dart-lang/lints#132)
* Link to 'dart fix' docs in table header
* Update doc generation script
diff --git a/pkgs/lints/README.md b/pkgs/lints/README.md
index 0edf5cd..2dfe1be 100644
--- a/pkgs/lints/README.md
+++ b/pkgs/lints/README.md
@@ -100,8 +100,8 @@
`include: package:lints/core.yaml`.
<!-- core -->
-| Lint Rules | Description | Fix |
-| :--------- | :---------- | --- |
+| Lint Rules | Description | [Fix][] |
+| :--------- | :---------- | ------- |
| [`avoid_empty_else`](https://dart.dev/lints/avoid_empty_else) | Avoid empty else statements. | ✅ |
| [`avoid_relative_lib_imports`](https://dart.dev/lints/avoid_relative_lib_imports) | Avoid relative imports for files in `lib/`. | ✅ |
| [`avoid_shadowing_type_parameters`](https://dart.dev/lints/avoid_shadowing_type_parameters) | Avoid shadowing type parameters. | |
@@ -138,8 +138,8 @@
`include: package:lints/recommended.yaml`.
<!-- recommended -->
-| Lint Rules | Description | Fix |
-| :--------- | :---------- | --- |
+| Lint Rules | Description | [Fix][] |
+| :--------- | :---------- | ------- |
| [`annotate_overrides`](https://dart.dev/lints/annotate_overrides) | Annotate overridden members. | ✅ |
| [`avoid_function_literals_in_foreach_calls`](https://dart.dev/lints/avoid_function_literals_in_foreach_calls) | Avoid using `forEach` with a function literal. | ✅ |
| [`avoid_init_to_null`](https://dart.dev/lints/avoid_init_to_null) | Don't explicitly initialize variables to null. | ✅ |
@@ -206,3 +206,4 @@
[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
diff --git a/pkgs/lints/tool/README.md b/pkgs/lints/tool/README.md
index 2a95cc7..e1f4a99 100644
--- a/pkgs/lints/tool/README.md
+++ b/pkgs/lints/tool/README.md
@@ -1,25 +1,25 @@
## `tool/validate_lib.dart`
-This tool ensures that we don't commit `.dart` source files into the lib/
+This tool ensures that we don't commit `.dart` source files into the `lib/`
directory; it's automatically run by the CI. To run manually:
-```
-dart tool/validate_lib.dart
+```shell
+dart run tool/validate_lib.dart
```
## `tool/gen_docs.dart`
This tool regenerates the lists of core and recommended lints into the package's
-README.md file. To use it, run:
+`README.md` file. To use it, run:
-```
-dart tool/gen_docs.dart
+```shell
+dart run tool/gen_docs.dart
```
It can also validate that the readme file is up-to-date. It's automatically
run by the CI; to run it manually:
-```
-dart tool/gen_docs.dart --verify
+```shell
+dart run tool/gen_docs.dart --verify
```
diff --git a/pkgs/lints/tool/gen_docs.dart b/pkgs/lints/tool/gen_docs.dart
index 5d25efc..43f494f 100644
--- a/pkgs/lints/tool/gen_docs.dart
+++ b/pkgs/lints/tool/gen_docs.dart
@@ -84,8 +84,8 @@
rules.sort();
final lines = [
- '| Lint Rules | Description | Fix |',
- '| :--------- | :---------- | --- |',
+ '| Lint Rules | Description | [Fix][] |',
+ '| :--------- | :---------- | ------- |',
...rules.map((rule) {
final ruleMeta =
lintMeta.firstWhereOrNull((meta) => meta['name'] == rule);
