Include local and global installation instructions in README.md.

[LeviHarman]

This pull request alters the installation section of the readme to include the installation instructions found at emacs-lsp/lsp-php

I found that guide helpful. Hopefully it helps others.

[codecov]

Codecov Report

Merging #639 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #639   +/-   ##
=========================================
  Coverage     81.52%   81.52%           
  Complexity      912      912           
=========================================
  Files            62       62           
  Lines          2078     2078           
=========================================
  Hits           1694     1694           
  Misses          384      384

[felixfbecker]

I would recommend adding these lines:

https://github.com/felixfbecker/vscode-php-intellisense/blob/21d79b5fd64fb7dcc09d97febf48ade309256e65/composer.json#L7-L11

so then it's not needed to run manually.

[LeviHarman]

Okay I changed it. I am unsure at the moment if I need the following line.

After editing your composer.json, you can install felixfbecker/php-language-server.
composer global require felixfbecker/language-server

I can check if the line above is needed but it will have to be tomorrow. I'm about to turn off the computer for the day.

[LeviHarman]

I checked the lines in question above they are needed.

[felixfbecker]

Side question, what is the use case for installing globally?

[LeviHarman]

I haven't done it myself. I included it because it was in emacs-lsp/lsp-php readme. I'll ask the creator of the README and see why he included it.

[rchl]

Would appreciate this getting merged too as current instructions in the readme did not work for me and I wasn't sure why as I don't know composer.

I got this error with default instructions:

% composer require felixfbecker/language-server
Using version ^5.4 for felixfbecker/language-server
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - felixfbecker/language-server v5.4.2 requires jetbrains/phpstorm-stubs dev-master -> satisfiable by jetbrains/phpstorm-stubs[dev-master] but these conflict with your requirements or minimum-stability.
    - felixfbecker/language-server v5.4.1 requires jetbrains/phpstorm-stubs dev-master -> satisfiable by jetbrains/phpstorm-stubs[dev-master] but these conflict with your requirements or minimum-stability.
    - felixfbecker/language-server v5.4.0 requires jetbrains/phpstorm-stubs dev-master -> satisfiable by jetbrains/phpstorm-stubs[dev-master] but these conflict with your requirements or minimum-stability.
    - Installation request for felixfbecker/language-server ^5.4 -> satisfiable by felixfbecker/language-server[v5.4.0, v5.4.1, v5.4.2].


Installation failed, deleting ./composer.json.

[rchl]

Well, to be fair these instructions didn't help either. Still getting same error.

But personally I think installing globally makes sense as this is the kind of package that IMO should be installed globally in user's directory rather than in specific project as it is generally consumed by text editors.

[rchl]

I have found #611 and managed to fix my issue.

Problem for me was that I already had ~/.composer directory so running composer global require felixfbecker/language-server used composer.json from that directory instead of global one from ~/.config/composer/composer.json.

EDIT: But then after deleting ~/.composer, running composer global require felixfbecker/language-server still didn't user configuration file from ~/.config/composer/composer.json so I had to actually put these configuration options in ~/.composer/composer.json.

[felixfbecker]

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-server

[phil-s]

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?

[phil-s]

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.

[jason0x43]

At least on my system (Mac with homebrew installed php and composer), the global config is in ~/.composer/composer.json rather than ~/.config/composer/composer.json.

[phil-s]

More generally, use $COMPOSER_HOME if it's set. Refer to https://getcomposer.org/doc/03-cli.md#composer-home

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.