phpactor / language-server-protocol
Langauge Server Protocol for PHP (transpiled)
Installs: 139 014
Dependents: 3
Suggesters: 0
Security: 0
Stars: 9
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- dantleech/invoke: ^2.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.0
- friendsofphp/php-cs-fixer: ^2.17
- phpstan/phpstan: ~0.12.0
- phpunit/phpunit: ^9.2
This package is auto-updated.
Last update: 2024-10-04 10:37:20 UTC
README
This package transpiles the vscode-language-server-protocol
library to PHP,
providing the protocol classes required to create Language Server
with PHP.
Notes on using the library
Most (if not all) of the upstream Typescript types have no constructors, therefore the argument order of the constructors can change on every release.
It is therefore strongly recommended to use named arguments.
Generation
Generating the code:
npm run generate
: Build and transpilenpm run watch
: Watch and compile on Typescript changes.
Running the PHP tests:
composer integrate
Usage
Deserialization
This library will use the type information form typescript to generate
fromArray
static constructors for each type:
$item = CompletionItem::fromArray([ 'label' => 'Foobar', 'kind' => 1, 'detail' => 'This is foobar', 'documentation' => [ 'kind' => 'markdown', 'value' => 'Foobar', ], 'additionalTextEdits' => [ [ 'range' => [ 'start' => [ 'line' => 5, 'character' => 10, ], 'end' => [ 'line' => 10, 'character' => 10, ], ], 'newText' => 'Foobar', ], ], 'command' => [ 'title' => 'Foobar', 'command' => 'my.command', ], ]);
Will return a fully hydrated completion item with concrete sub-types.
NOTE: that when deserializing from a language server client request, it is
probably a good idea to ignore additional parameters (the second argument to
fromArray
). This is because it is perfectly valid to pass unknown properties
to some of the LSP objects.
Serialization
Properties in classes are public to enable JSON serialization. Call
json_encode($lspObject)
to get the valid LSP JSON object.
Contributing
This package is open source and welcomes contributions! Feel free to open a pull request on this repository.
Support
- Create an issue on the main Phpactor repository.
- Join the
#phpactor
channel on the Slack Symfony Devs channel.