Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@
"phpactor/file-path-resolver": "^0.8.2",
"phpactor/file-path-resolver-extension": "^0.3.2",
"phpactor/indexer": "^0.1.0",
"phpactor/language-server-completion-extension": "~0.2.0",
"phpactor/language-server-extension": "~0.3",
"phpactor/language-server-reference-finder-extension": "~0.2.0",
"phpactor/logging-extension": "^0.3.2",
"phpactor/path-finder": "^0.1.0",
"phpactor/reference-finder": "^0.1.3",
Expand Down
123 changes: 13 additions & 110 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

75 changes: 75 additions & 0 deletions doc/adr/0002-language-server-package-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
Language Server Package Structure
=================================

**ACCEPTED**

Context
-------

For reasons described in the rejected 0001 ADR we have an issue where adding
language server features involves, if done properly, would involve the
creation of many more separate packages, increasing the maintenance overhead
significantly.

The Language Server is made up of:

- `phpactor/language-server`: A generic language server package, not coupled
to Phpactor.
- `phpactor/language-server-extension`: Command to launch the language server,
hooks to register RPC handlers.
- `phpactor/language-server-completion-extension`: Handlers for completion
(using the existing Phpactor implementations from other packages).
- `phpactor/language-server-reference-finder-extension`: As with the
completion extension.
- `phpactor/language-server-hover-extension`: This package _did_ add support
for hover, but was recently merged into completion.

In addition, there is the prospect of adding:

- `phpactor/language-server-indexer-extension`: Add the indexing service to
the server.
- `phpactor/language-server-code-action-extension`: Integrate all the
code-transform actions.
- `phpactor/language-server-worse-reflection-extension`: Add the workspace
source-locator for worse reflection.
- ...

Decision
--------

Keep the generic language server package, but combine all the Phpactor extensions into
a single package:

- `phpactor/language-server`: A generic language server package, not coupled
to Phpactor.
- `phpactor/language-server-extension`: Macro package containing all the
Phpactor Language Server extensions.

The macro package will be organised with all extensions living in their own
namespaces, i.e. `lib/<extension name>`:

```
lib/LanguageServer/
lib/LanguageServerCompletion/
lib/LanguageServerReferenceFinder/
lib/...
```

The namespace will be mapped as `'Phpactor\\Extension\\' => 'lib/'` - so the
extensions namespaces remain unchanged.

Tests will also be namespaces as before, but will require additional autoload
mapping.

Consequences
------------

Having all the language server functionality in one place makes it easier to
refactor, and much easier to add new features.

In the future it should still be possible to break micro-packages out of the
macro-package.

The risk is that it is much easier for packages to contaminate each other.

As all the extensions are stil
2 changes: 2 additions & 0 deletions lib/Phpactor.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Phpactor\Extension\LanguageServerCompletion\LanguageServerCompletionExtension;
use Phpactor\Extension\LanguageServerReferenceFinder\LanguageServerReferenceFinderExtension;
use Phpactor\Extension\LanguageServerWorseReflection\LanguageServerWorseReflectionExtension;
use Phpactor\Extension\LanguageServer\LanguageServerExtension;
use Phpactor\Indexer\Extension\IndexerExtension;
use RuntimeException;
Expand Down Expand Up @@ -109,6 +110,7 @@ public static function boot(InputInterface $input, string $vendorDir): PhpactorC
LanguageServerExtension::class,
LanguageServerCompletionExtension::class,
LanguageServerReferenceFinderExtension::class,
LanguageServerWorseReflectionExtension::class,
IndexerExtension::class,
];

Expand Down