Revise php layer
Make doc more clearly describe which tools belong to which backend. Change keybindings to be consistent with spacemacs conventions. Simplify LSP layer code.
This commit is contained in:
Maximilian Wolff
parent
be2ac6313d
commit
43bf85c685
|
|
@ -7,6 +7,7 @@ eproject.lst
|
|||
.smex-items
|
||||
\#*
|
||||
.places
|
||||
.ac-php-conf.json
|
||||
.directory
|
||||
.cache
|
||||
/eww-bookmarks
|
||||
|
|
|
|||
|
|
@ -14,14 +14,12 @@
|
|||
- [[#php-language-server][php-language-server]]
|
||||
- [[#ac-php-core][ac-php-core]]
|
||||
- [[#setup][Setup]]
|
||||
- [[#refactoring-tools][Refactoring tools]]
|
||||
- [[#additional-tools][Additional tools]]
|
||||
- [[#refactoring][Refactoring]]
|
||||
- [[#debugging][Debugging]]
|
||||
- [[#refactoring][Refactoring]]
|
||||
- [[#key-bindings][Key bindings]]
|
||||
- [[#general][General]]
|
||||
- [[#refactoring-1][Refactoring]]
|
||||
- [[#debugging-1][Debugging]]
|
||||
- [[#refactoring-for-non-lsp-backends][Refactoring for non LSP backends]]
|
||||
- [[#debugging-for-non-lsp-backends][Debugging for non LSP backends]]
|
||||
- [[#lsp-keybindings][LSP keybindings]]
|
||||
|
||||
* Description
|
||||
This layer adds PHP language support to Spacemacs.
|
||||
|
|
@ -46,7 +44,7 @@ add =php= to the existing =dotspacemacs-configuration-layers= list in this
|
|||
file.
|
||||
|
||||
** Backends
|
||||
For php you have the choice between a set of possible LSP backends with
|
||||
For php you have the choice between a set of possible backends with
|
||||
different setup instructions and different capabilities.
|
||||
|
||||
Note that you'll need to use the =lsp= layer to enable these backends.
|
||||
|
|
@ -113,38 +111,32 @@ If your project contains the following files at the root folder:
|
|||
the necessary configuration file (=.ac-php-conf.json=) will be created automatically
|
||||
if it does not exist.
|
||||
|
||||
** Refactoring tools
|
||||
**** Refactoring
|
||||
This backend provides refactoring and class auto-completion capabilities via [[https://github.com/emacs-php/phpactor.el][phpactor.el]].
|
||||
To ensure that the phpactor package is intact, just run
|
||||
~M-x phpactor-install-or-update~ and the package itself will make sure that
|
||||
you're good to go.
|
||||
|
||||
To ensure that the phpactor package is intact, just run
|
||||
~M-x phpactor-install-or-update~ and the package itself will make sure that
|
||||
you're good to go.
|
||||
|
||||
* Additional tools
|
||||
|
||||
** Refactoring
|
||||
This layer provides refactoring and class auto-completion capabilities via [[https://github.com/emacs-php/phpactor.el][phpactor.el]].
|
||||
|
||||
** Debugging
|
||||
For configuration details, please refer to [[https://github.com/ahungry/geben][geben package]] repo page.
|
||||
It also provides debug capabilities via the [[https://github.com/ahungry/geben][geben package]]. Please refer for details
|
||||
to the project page.
|
||||
|
||||
* Key bindings
|
||||
|
||||
** General
|
||||
|
||||
| Key binding | Description |
|
||||
|-------------+-------------------------|
|
||||
| ~SPC m g g~ | jump to define at point |
|
||||
| ~C-t~ | jump back |
|
||||
|
||||
** Refactoring
|
||||
** Refactoring for non LSP backends
|
||||
|
||||
For more precise insights on which key does what, check out [[https://phpactor.github.io/phpactor/refactorings.html][phpactor API reference.]]
|
||||
For more precise insights on the meaning of the key bindings please refer to [[https://phpactor.github.io/phpactor/refactorings.html][phpactor API reference.]]
|
||||
|
||||
| Key binding | Description |
|
||||
|---------------+---------------------------------------------------------|
|
||||
| ~SPC m r i~ | import class under cursor |
|
||||
| ~SPC m r R v~ | rename local variable |
|
||||
| ~SPC m r R V~ | rename variable in a whole file |
|
||||
| ~SPC m r r~ | rename local variable |
|
||||
| ~SPC m r R~ | rename variable in a whole file |
|
||||
| ~SPC m r n~ | synchronize namespace with file location |
|
||||
| ~SPC m r v~ | toggle method visibility (public->protected->private) |
|
||||
| ~SPC m r g a~ | generate unknown property accessors |
|
||||
|
|
@ -162,7 +154,7 @@ if it does not exist.
|
|||
| ~SPC m P s~ | ask phpactor about it's status |
|
||||
| ~SPC m P u~ | install/update phpactor package |
|
||||
|
||||
** Debugging
|
||||
** Debugging for non LSP backends
|
||||
|
||||
XDebug client management:
|
||||
|
||||
|
|
@ -201,3 +193,7 @@ if it does not exist.
|
|||
| ~k~ | previous variable or section |
|
||||
| ~TAB~ | fold/unfold variable or section |
|
||||
| ~q~ | close variable listing |
|
||||
|
||||
** LSP keybindings
|
||||
For a detailed list of keybindings in =lsp-mode= please checkout the README.org
|
||||
file of the =lsp layer=.
|
||||
|
|
|
|||
|
|
@ -14,6 +14,6 @@
|
|||
|
||||
(spacemacs|define-jump-handlers php-mode)
|
||||
|
||||
(defvar php-backend nil
|
||||
(defvar php-backend 'nil
|
||||
"The backend to use for IDE features.
|
||||
Possible values are `lsp'.")
|
||||
|
|
|
|||
|
|
@ -9,24 +9,7 @@
|
|||
;;
|
||||
;;; License: GPLv3
|
||||
|
||||
(defun spacemacs//php-backend ()
|
||||
"Returns selected backend."
|
||||
(if php-backend
|
||||
php-backend
|
||||
(cond
|
||||
((configuration-layer/layer-used-p 'lsp) 'lsp)
|
||||
(t nil))))
|
||||
|
||||
(defun spacemacs//php-setup-backend ()
|
||||
"Conditionally setup php backend."
|
||||
(pcase (spacemacs//php-backend)
|
||||
(`lsp (spacemacs//php-setup-lsp))))
|
||||
|
||||
|
||||
;; lsp
|
||||
|
||||
(defun spacemacs//php-setup-lsp ()
|
||||
"Setup lsp backend."
|
||||
(if (configuration-layer/layer-used-p 'lsp)
|
||||
(lsp)
|
||||
(message "`lsp' layer is not installed, please add `lsp' layer to your dotfile.")))
|
||||
(pcase php-backend
|
||||
(`lsp (lsp))))
|
||||
|
|
|
|||
|
|
@ -9,25 +9,25 @@
|
|||
;;
|
||||
;;; License: GPLv3
|
||||
|
||||
(setq php-packages
|
||||
'(
|
||||
drupal-mode
|
||||
eldoc
|
||||
evil-matchit
|
||||
flycheck
|
||||
ggtags
|
||||
counsel-gtags
|
||||
helm-gtags
|
||||
php-auto-yasnippets
|
||||
(php-extras :location (recipe :fetcher github :repo "arnested/php-extras"))
|
||||
php-mode
|
||||
phpcbf
|
||||
phpunit
|
||||
phpactor
|
||||
(company-phpactor :requires company)
|
||||
(company-php :requires company)
|
||||
geben
|
||||
))
|
||||
(defconst php-packages
|
||||
'(
|
||||
drupal-mode
|
||||
eldoc
|
||||
evil-matchit
|
||||
flycheck
|
||||
ggtags
|
||||
counsel-gtags
|
||||
helm-gtags
|
||||
php-auto-yasnippets
|
||||
(php-extras :location (recipe :fetcher github :repo "arnested/php-extras"))
|
||||
php-mode
|
||||
phpcbf
|
||||
phpunit
|
||||
(phpactor :toggle (not (eq php-backend 'lsp)))
|
||||
(company-phpactor :requires company :toggle (not (eq php-backend 'lsp)))
|
||||
(company-php :requires company :toggle (not (eq php-backend 'lsp)))
|
||||
(geben :toggle (not (eq php-backend 'lsp)))
|
||||
))
|
||||
|
||||
(defun php/init-drupal-mode ()
|
||||
(use-package drupal-mode
|
||||
|
|
@ -62,7 +62,7 @@
|
|||
(defun php/init-php-mode ()
|
||||
(use-package php-mode
|
||||
:defer t
|
||||
:mode ("\\.php\\'" . php-mode))
|
||||
:mode ("\\.php\\'" . php-mode)
|
||||
:init
|
||||
(progn
|
||||
(add-hook 'php-mode-hook 'spacemacs//php-setup-backend))
|
||||
|
|
@ -73,25 +73,24 @@
|
|||
(spacemacs/set-leader-keys-for-major-mode 'php-mode
|
||||
"tt" 'phpunit-current-test
|
||||
"tc" 'phpunit-current-class
|
||||
"tp" 'phpunit-current-project)))
|
||||
"tp" 'phpunit-current-project))))
|
||||
|
||||
(defun php/init-phpactor ()
|
||||
(use-package phpactor
|
||||
:defer t
|
||||
:config
|
||||
(progn
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mg" "references")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mrg" "generate")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mre" "extract")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mrm" "methods")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mrc" "classes")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mrp" "properties")
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mP" "phpactor")
|
||||
|
||||
(spacemacs/declare-prefix-for-mode 'php-mode "mr" "refactoring")
|
||||
(spacemacs/set-leader-keys-for-major-mode 'php-mode
|
||||
"ri" #'phpactor-import-class
|
||||
"Rv" #'phpactor-rename-variable-local
|
||||
"RV" #'phpactor-rename-variable-file
|
||||
"rr" #'phpactor-rename-variable-local
|
||||
"rR" #'phpactor-rename-variable-file
|
||||
"rn" #'phpactor-fix-namespace
|
||||
"rv" #'phpactor-change-visibility
|
||||
"rga" #'phpactor-generate-accessors
|
||||
|
|
@ -108,7 +107,6 @@
|
|||
"rmc" #'phpactor-implement-contracts
|
||||
"Ps" #'phpactor-status
|
||||
"Pu" #'phpactor-install-or-update)
|
||||
|
||||
(setq-default phpactor-references-list-col1-width 72))))
|
||||
|
||||
(defun php/init-phpcbf ()
|
||||
|
|
|
|||
Loading…
Reference in New Issue