Skip to content

Commit 8875f1a

Browse files
srawlinsCommit Queue
authored andcommitted
DAS plugins: Write initial text for README
Change-Id: I97aee31ed59a136591c71fc36d6f3febc9a53b18 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/450800 Reviewed-by: Brian Wilkerson <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]>
1 parent 3f2801d commit 8875f1a

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed
Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# analysis\_server\_plugin package
22

3-
This package offers support for writing Dart analyzer plugins.
3+
This package offers support for writing Dart analysis server plugins.
44

5-
Until this README is fleshed out, more inforamtion can be found in the [docs][].
5+
Analysis server plugins empower developers to contribute their own Dart static
6+
analysis in IDEs and at the command line via `dart analyze` and `flutter
7+
analyze`. Analysis server plugins can offer the following static analyses:
68

7-
[docs]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc
9+
* analysis rules, which report diagnostics in the IDE, and at the command line
10+
* IDE quick fixes, which are local refactorings offered to users to correct a
11+
given diagnostic
12+
* IDE quick assists, which are local refactorings that are offered at specific
13+
syntax nodes in code, but do not necessarily correct a static code issue
814

15+
Review the following documents for how to write and how to use analysis server
16+
plugins:
17+
18+
* [Writing a plugin][]
19+
* [Writing rules][]
20+
* [Testing rules][]
21+
* [Writing fixes][]
22+
* [Writing assists][]
23+
* [Using plugins][]
24+
25+
[Writing a plugin]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/writing_a_plugin.md
26+
[Writing rules]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/writing_rules.md
27+
[Testing rules]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/testing_rules.md
28+
[Writing fixes]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/writing_fixes.md
29+
[Writing assists]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/writing_assists.md
30+
[Using plugins]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server_plugin/doc/using_plugins.md

0 commit comments

Comments
 (0)