Include local and global installation instructions in README.md. #639
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -132,18 +132,54 @@ All classes are considered internal and are not subject to semver. | |
|
|
||
| ## Installation | ||
|
|
||
| The recommended installation method is through [Composer](https://getcomposer.org/). Follow the following installation instructions for local or global installation after installing composer on your system. | ||
|
|
||
| ### Local Installation | ||
| Create a directory for php-language-server. Create a composer.json file in it, with the following contents: | ||
|
|
||
| ``` | ||
| { | ||
| "minimum-stability": "dev", | ||
| "prefer-stable": true, | ||
| "require": { | ||
| "felixfbecker/language-server": "v5.4.0" | ||
| }, | ||
| "scripts": { | ||
| "parse-stubs": "LanguageServer\\ComposerScripts::parseStubs", | ||
| "post-update-cmd": "@parse-stubs", | ||
| "post-install-cmd": "@parse-stubs" | ||
| } | ||
| } | ||
| ``` | ||
| Then, in the directory, run the following commands: | ||
|
|
||
| ``` | ||
| composer require felixfbecker/language-server | ||
| ``` | ||
|
|
||
| ### Global installation | ||
| Before installing php-language-server, make sure your ~/.config/composer/composer.json includes the lines below. The settings apply to all globally installed Composer packages, so proceed with caution. If you do not want to edit your global Composer configuration, see the section for local installation above. | ||
|
There was a problem hiding this comment. At least on my system (Mac with homebrew installed php and composer), the global config is in There was a problem hiding this comment. More generally, use If it's not set, note that a hard-coded fallback could be error-prone, as the default value is quite variable depending on the OS (and version thereof) you're running. |
||
|
|
||
| ``` | ||
| { | ||
| "minimum-stability": "dev", | ||
| "prefer-stable": true, | ||
| "require": { | ||
| "felixfbecker/language-server": "v5.4.0" | ||
| }, | ||
| "scripts": { | ||
| "parse-stubs": "LanguageServer\\ComposerScripts::parseStubs", | ||
| "post-update-cmd": "@parse-stubs", | ||
| "post-install-cmd": "@parse-stubs" | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
| After editing your composer.json, you can install felixfbecker/php-language-server. | ||
|
|
||
| ``` | ||
| composer global require felixfbecker/language-server | ||
| ``` | ||
|
|
||
| ## Running | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea for local installation is that your add this to the composer.json file of your project, where the project is something like https://github.com/felixfbecker/vscode-php-intellisense or some other editor integration or use case for the language server. The directory shouldn't be considered "the directory for php-language-server" because that will be
./vendor/felixfbecker/language-serverThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the idea here is that some users will want to try this out without making any changes to their global composer config, and these instructions provide a way of creating a local (perhaps temporary) instance of the language server without touching anything else.
The text editor can then be pointed to the local installation for testing. If it all pans out, the user might move to a global install (or not, as the case may be).
So "local" installation here can be thought of as a self-contained installation, rather than integrating it into another project like vscode-php-intellisense. Perhaps that should be covered as a third case, though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An example of why users might want a separate/self-contained installation is so that they can patch the language server for specific use-cases without affecting their global installation. For instance, modifying the hard-coded set of filename extensions which should be treated as PHP files in a particular project type -- a need that I personally ran into yesterday.