Sam Rawlins
cfc705ce09
We have chosen a new name for this package. So before we write more code inside, we need to move everything from 'server_plugin' to 'analysis_server_plugin'. There are some steps do doing so, to not break various infra: 1. Land this change, introducing the new package in the SDK, but no dependencies on it. 2. Land this change independently in google3 (the package is not yet "unbundled.") 3. Mark the package as "unbundled" in google3. 4. Move all code from server_plugin to analysis_server_plugin; update imports; and delete server_plugin. 5. Remove server_plugin as an "unbundled" package; and remove server_plugin from google3. Bug: https://github.com/dart-lang/sdk/issues/53402 Change-Id: I70197fdf61dd5862c2220d8ed5dd0880a1593ead Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/363600 Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Reviewed-by: Alexander Thomas <athom@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
56 lines
2.8 KiB
Markdown
56 lines
2.8 KiB
Markdown
# analysis\_server\_plugin package
|
|
|
|
This package is being developed for the second incarnation of Dart Analyzer
|
|
plugins. It is in an intermediate state, and a few things must be kept in mind
|
|
during this phase of development:
|
|
|
|
1. **This package is not to be published on pub yet.** We will flesh out a
|
|
stable API befoure the first publish.
|
|
2. **In order to support the above point, no pub-publishable code can depend on
|
|
this package.** At no point can we introduce a dependency from a package
|
|
like `analyzer` or `analyzer_plugin` to this package. If we did so, then at
|
|
the next time we published _that_ package to pub, we would need to publish
|
|
_this_ package to pub. No. In short, I think what this means is that only
|
|
the `analysis_server` package can depend on this package.
|
|
|
|
## Migration of code between packages
|
|
|
|
As part of the design of the new Dart Analyzer plugins, much code will shift
|
|
around, in a few directions.
|
|
|
|
* **`analysis_server` package to `analysis_server_plugin` package:** The API of
|
|
the new Dart Analyzer plugins focuses around two primary concepts: lint rules
|
|
and quick fixes. Quick assists may be chosen as a third important concept.
|
|
Lint rule code has typically lived in the `analyzer` package, and does not
|
|
need to move. (It's presence in the `analyzer` package could be deprecated in
|
|
favor of this package, but it is not important for the implementation.)
|
|
|
|
Quick fixes, however, have only existed in concept, and interface, and API,
|
|
in the `analysis_server` package. That code needs to move to this package in
|
|
order to be used in a Dart Analyzer plugin.
|
|
|
|
**A move from the `analysis_server` package to this package is not a breaking
|
|
change.**
|
|
|
|
* **`analyzer_plugin` package to `analysis_server_plugin` package:** Care is
|
|
being taken to decide where Dart Analyzer plugin code will live and how it
|
|
will be published. It is not decided yet what the ultimate package API will
|
|
be. Some code from **analyzer_plugin** may move to this package.
|
|
|
|
**A move from the `analyzer_plugin` package is a breaking change. Extreme
|
|
care must be taken.**
|
|
|
|
* **`analyzer_plugin` package to `analysis_server` package:** There will be
|
|
many components of the analysis server that currently live in
|
|
`analyzer_plugin`, because they were necessary for the first version of Dart
|
|
Analyzer plugins), but are not part of the new Dart Analyzer plugins. These
|
|
components can be moved safely back into the `analysis_server` package.
|
|
|
|
In terms of priority, it is not crucial for such code to be moved out of the
|
|
`analyzer_plugin` package. It can live there indefinitely, and the
|
|
`analysis_server` package can continue to depend on code from the
|
|
`analyzer_plugin` package, as shipped in the SDK.
|
|
|
|
**A move from the `analyzer_plugin` package is a breaking change. Extreme
|
|
care must be taken.**
|