emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(php): update version info and fix repl package name

Browse source
This commit is contained in:
Alex Barbosa 2023-02-20 22:06:02 -03:00 • committed by GitHub
parent cc467d009e
commit e7c2305a93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

22
modules/lang/php/README.org
View file

@ -4,11 +4,11 @@
#+since: 1.3 #+since: 1.3
* Description :unfold: * Description :unfold:
This module adds support for PHP 5.3+ (including PHP7) to Doom Emacs. This module adds support for PHP 5.3+ (including PHP8) to Doom Emacs.
- ctags-based code completion (~company-php~ and ~phpctags~) - ctags-based code completion (~company-php~ and ~phpctags~)
- eldoc support (~ac-php~ and ~php-extras~) - eldoc support (~ac-php~ and ~php-extras~)
- REPL (~php-boris~) - REPL (~psysh~)
- Code refactoring commands (~php-refactor-mode~) - Code refactoring commands (~php-refactor-mode~)
- Unit-test commands (~phpunit~) - Unit-test commands (~phpunit~)
- Support for ~laravel~ and ~composer~ projects (with project-specific snippets) - Support for ~laravel~ and ~composer~ projects (with project-specific snippets)
@ -40,7 +40,7 @@ This module adds support for PHP 5.3+ (including PHP7) to Doom Emacs.
** Packages ** Packages
- [[doom-package:async]] - [[doom-package:async]]
- [[doom-package:hack-mode]] if [[doom-module:+hack]] - [[doom-package:hack-mode]] if [[doom-module:+hack]]
- [[doom-package:php-boris]] - [[doom-package:psysh]]
- [[doom-package:php-cs-fixer]] if [[doom-package::editor format]] - [[doom-package:php-cs-fixer]] if [[doom-package::editor format]]
- [[doom-package:php-extras]] - [[doom-package:php-extras]]
- [[doom-package:php-mode]] - [[doom-package:php-mode]]
@ -73,7 +73,7 @@ provided for reference:
#+begin_src sh #+begin_src sh
brew tap homebrew/homebrew-php brew tap homebrew/homebrew-php
brew install php71 # or php53, php54, php55 brew install php@8.0 # or php53, php54, php55
brew install composer brew install composer
# If you use intelephense: # If you use intelephense:
@ -96,7 +96,13 @@ sudo zypper install php-composer
# If you use intelephense: # If you use intelephense:
sudo zypper install nodejs npm sudo zypper install nodejs npm
#+end_src #+end_src
*** Debian
#+begin_src sh
sudo apt-get install php php-common
# If you use intelephense:
sudo apt-get install nodejs npm
#+end_src
** LSP Support ** LSP Support
There are a number of currently supported LSP servers: There are a number of currently supported LSP servers:
@ -112,7 +118,7 @@ which will trigger either when you open a PHP project or manually invoke
The others have to be installed manually and added to your =$PATH=. The others have to be installed manually and added to your =$PATH=.
** Dependencies ** Dependencies
- ~boris~ (REPL) - ~pysh~ (REPL)
- ~phpctags~ (better code completion) - ~phpctags~ (better code completion)
- ~phpunit~ (unit test commands) - ~phpunit~ (unit test commands)
- ~php-cs-fixer~ and ~@prettier/plugin-php~ (for code formatting) - ~php-cs-fixer~ and ~@prettier/plugin-php~ (for code formatting)
@ -120,7 +126,7 @@ The others have to be installed manually and added to your =$PATH=.
#+begin_src sh #+begin_src sh
composer global require \ composer global require \
d11wtq/boris \ psy/psysh \
phpunit/phpunit \ phpunit/phpunit \
techlivezheng/phpctags \ techlivezheng/phpctags \
friendsofphp/php-cs-fixer \ friendsofphp/php-cs-fixer \
@ -144,6 +150,8 @@ command line.
*NOTE* phpactor doesn't have to be installed via =composer=, just has to exist in *NOTE* phpactor doesn't have to be installed via =composer=, just has to exist in
your =$PATH=. your =$PATH=.
*NOTE* Phpactor cannot be installed, globally at least, with PHP ^8.
* TODO Usage * TODO Usage
#+begin_quote #+begin_quote
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]] 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
@ -181,7 +189,7 @@ commands:
| [[kbd:][<localleader> m c o]] | ~composer-find-json-file~ | | [[kbd:][<localleader> m c o]] | ~composer-find-json-file~ |
| [[kbd:][<localleader> m c l]] | ~composer-view-lock-file~ | | [[kbd:][<localleader> m c l]] | ~composer-view-lock-file~ |
These are all invokable via [[kbd:][M-x]] too. These are all run via [[kbd:][M-x]] too.
* TODO Configuration * TODO Configuration
#+begin_quote #+begin_quote