yeet

.config/emacs/modules/lang/php/README.org

@@ -0,0 +1,246 @@
+#+TITLE:   lang/php
+#+DATE:    January 16, 2017
+#+SINCE:   v1.3
+#+STARTUP: inlineimages nofold
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#maintainers][Maintainers]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+- [[#prerequisites][Prerequisites]]
+  - [[#php][PHP]]
+    - [[#macos][MacOS]]
+    - [[#arch-linux][Arch Linux]]
+    - [[#opensuse][openSUSE]]
+  - [[#dependencies][Dependencies]]
+- [[#features][Features]]
+  - [[#lsp-support][LSP Support]]
+  - [[#phpunit][PHPUnit]]
+  - [[#composer][Composer]]
+- [[#configuration][Configuration]]
+  - [[#docker-compose][Docker Compose]]
+- [[#troubleshooting][Troubleshooting]]
+  - [[#im-missing-functionality-on-lsp-mode]["I'm missing functionality on lsp-mode"]]
+
+* Description
+This module adds support for PHP 5.3+ (including PHP7).
+
++ ctags-based code completion (~company-php~ and ~phpctags~)
++ eldoc support (~ac-php~ and ~php-extras~)
++ REPL (~php-boris~)
++ Code refactoring commands (~php-refactor-mode~)
++ Unit-test commands (~phpunit~)
++ Support for ~laravel~ and ~composer~ projects (with project-specific snippets)
++ Shortcuts for composer commands
++ [[../../editor/file-templates/templates/php-mode][File templates]]
++ [[https://github.com/hlissner/doom-snippets/tree/master/php-mode][Snippets]]
+
+#+begin_quote
+PHP was the first programming language I got paid to code in, back in the
+Cretaceous period (2003). My sincerest apologies go out to all the programmers
+who inherited my earliest PHP work. I know you're out there, writhing in your
+straitjackets.
+
+Save a programmer today. Stop a friend from choosing PHP as their first
+language.
+#+end_quote
+
+** Maintainers
+This module has no dedicated maintainers.
+
+** Module Flags
++ =+hack= Add support for the [[https://hacklang.org/][Hack dialect of PHP]] by Facebook.
++ =+lsp= Enable LSP support through phpactor or intelephense. Requires the ~:tools
+  lsp~ module and the [[https://phpactor.readthedocs.io/en/develop/usage/standalone.html][phpactor server]] to be installed on your system.
+** Plugins
++ [[https://github.com/tomterl/php-boris][async]]
++ [[https://github.com/tomterl/php-boris][php-boris]]
++ [[https://github.com/arnested/php-extras][php-extras]]
++ [[https://github.com/emacs-php/php-mode][php-mode]]
++ [[https://github.com/keelerm84/php-refactor-mode.el][php-refactor-mode]]
++ [[https://github.com/nlamirault/phpunit.el][phpunit]]
++ [[https://github.com/emacs-php/composer.el][composer.el]]
++ =+hack=
+  + [[https://github.com/hhvm/hack-mode][hack-mode]]
++ =+lsp=
+  + [[https://github.com/emacs-php/phpactor.el][phpactor]]
+  + [[https://github.com/emacs-php/phpactor.el][company-phpactor]]
++ =:editor format=
+  + [[https://github.com/OVYA/php-cs-fixer][php-cs-fixer]]
+
+* Prerequisites
+** PHP
+To get started with PHP, you'll need ~php~ (5.3+) and ~composer~.
+
+Note for =+lsp=:
+1. In order to make full use of phpactor server, ~php~ (7.3+) is recommended.
+2. If you use intelephense, ~node~ and ~npm~ are needed.
+
+*** MacOS
+PHP 5.5 comes prepackaged with newer versions of MacOS. These instructions are
+provided for reference:
+
+#+begin_src sh :tangle (if (doom-system-os 'macos) "yes")
+brew tap homebrew/homebrew-php
+brew install php71  # or php53, php54, php55
+brew install composer
+
+# If you use intelephense:
+brew install node
+brew install npm
+#+end_src
+
+*** Arch Linux
+#+begin_src sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
+sudo pacman --needed --noconfirm -S php composer  # or php53, php54, php55
+
+# If you use intelephense:
+sudo pacman -S nodejs npm
+#+end_src
+
+*** openSUSE
+#+begin_src sh :dir /sudo::
+sudo zypper install php-composer
+
+# If you use intelephense:
+sudo zypper install nodejs npm
+#+end_src
+
+** Dependencies
+This module has no required dependencies, but it has a couple optional ones.
+
++ ~boris~ (REPL)
++ ~phpctags~ (better code completion)
++ ~phpunit~ (unit test commands)
++ ~php-cs-fixer~ and ~@prettier/plugin-php~ (for code formatting)
++ ~phpactor~ (for LSP if intelephense isn't desired)
+
+#+begin_src sh
+composer global require \
+    d11wtq/boris \
+    phpunit/phpunit \
+    techlivezheng/phpctags \
+    friendsofphp/php-cs-fixer \
+    phpactor/phpactor
+
+# Needed by php-cs-fixer, otherwise you'll get "Couldn't resolve parser
+# 'php'" errors
+npm install -g @prettier/plugin-php
+#+end_src
+
+You must ensure that ~~/.composer/vendor/bin~ is in ~PATH~, so these executables are
+visible to Emacs:
+
+#+begin_src sh
+# place this in your profile file, like ~/.bash_profile or ~/.zshenv
+export PATH="~/.composer/vendor/bin:$PATH"
+#+end_src
+
+You may also need to regenerate your envvar file by running ~doom env~ on the
+command line.
+
+*NOTE* phpactor doesn't have to be installed via =composer=, just has to exist in
+your =$PATH=.
+
+* Features
+** LSP Support
+There are a number of currently supported LSP servers:
+
++ [[https://emacs-lsp.github.io/lsp-mode/page/lsp-intelephense/][Intelephense]] (_Recommended_)
++ [[https://emacs-lsp.github.io/lsp-mode/page/lsp-phpactor/][phpactor]]
++ [[https://emacs-lsp.github.io/lsp-mode/page/lsp-serenata/][Serenata]]
++ [[https://emacs-lsp.github.io/lsp-mode/page/lsp-php/][felixbecker]] (Considered unsupported)
+
+Intelephense is currently the only server that supports automatic installation,
+which will trigger either when you open a PHP project or manually invoke
+=lsp-install-server= through =M-x=.
+
+The others have to be installed manually and added to your =$PATH=.
+
+** PHPUnit
+This module provides an interface to PHPUnit through a number of commands as
+detailed below. By default, it loads configuration from the root ~phpunit.xml~.
+
++ ~phpunit-current-project~ Launch all tests for the project
++ ~phpunit-current-class~ Launch all tests for the current class/fixture
++ ~phpunit-current-test~ Launch the current test at point
+
+If for some reason, the default ~phpunit.xml~ is in a different location (or you
+use the ~phpunit.xml.dist~ convention) , the path can be changed via
+=phpunit-configuration-file=
+
+#+begin_src emacs-lisp
+(setq phpunit-configuration-file "phpunit.xml")
+#+end_src
+
+** Composer
+This module provides several convenience methods for triggering composer
+commands:
+
+| Binding             | Function                        |
+|---------------------+---------------------------------|
+| ~<localleader> m c c~ | ~composer~                        |
+| ~<localleader> m c i~ | ~composer-install~                |
+| ~<localleader> m c r~ | ~composer-require~                |
+| ~<localleader> m c u~ | ~composer-update~                 |
+| ~<localleader> m c d~ | ~composer-dump-autoload~          |
+| ~<localleader> m c s~ | ~composer-run-scripts~            |
+| ~<localleader> m c v~ | ~composer-run-vendor-bin-command~ |
+| ~<localleader> m c o~ | ~composer-find-json-file~         |
+| ~<localleader> m c l~ | ~composer-view-lock-file~         |
+
+These are all invokable via =M-x= too.
+
+* Configuration
+** Docker Compose
+A lot of projects rely on running inside docker compose (ie Laravel), and as
+such a minor mode has been configured to attempt to run tests inside the =php-fpm=
+(by default) container.
+
+This mode is disabled by default, to opt-in set =+php-run-tests-in-docker= to =t= in
+your config. If this is done during Emacs running, you will also have to reload
+=php-mode= (i.e. through =M-x php-mode=)
+
+If you wish to specify a different container, modify the
+~+php-default-docker-container~ variable (ideally inside a ~.dir-locals.el~ file)
+
+#+begin_src emacs-lisp
+((php-mode . ((+php-default-docker-container . "php-octane"))))
+#+end_src
+
+* Troubleshooting
+** "I'm missing functionality on lsp-mode"
+Unfortunately, [[https://intelephense.com/][intelephense]] currently operates under a "freemium" model, and as
+such requires a license for extended features. Once purchased, this can be
+(insecurely) added directly to your config:
+
+#+begin_src emacs-lisp
+(setq lsp-intelephense-licence-key "<key>")
+#+end_src
+
+A more recommended approach would be to utilise Emacs' own ~auth-sources~ for
+storing authentication info, which can also be encrypted.
+
+Create a file in your home directory (which can optionally be encrypted, verify
+your ~auth-sources~ has the correct values) called ~~/.authinfo~
+
+#+begin_src
+machine * login intelephense password <key>
+#+end_src
+
+And add the following to your config
+
+#+begin_src emacs-lisp
+(defun my-fetch-password (&rest params)
+  (require 'auth-source)
+  (let ((match (car (apply #'auth-source-search params))))
+    (if match
+        (let ((secret (plist-get match :secret)))
+          (if (functionp secret)
+              (funcall secret)
+            secret))
+      (error "Password not found for %S" params))))
+
+(setq lsp-intelephense-license-key (my-fetch-password :user intelephense))
+#+end_src

.config/emacs/modules/lang/php/autoload.el

@@ -0,0 +1,26 @@
+;;; lang/php/autoload.el -*- lexical-binding: t; -*-
+
+(defvar +php-composer-conf (make-hash-table :test 'equal))
+
+;;;###autoload
+(defun +php-composer-conf (&optional project-root refresh-p)
+  "Retrieve the contents of composer.json as an alist. If REFRESH-P is non-nil
+ignore the cache."
+  (let ((project-root (or project-root (doom-project-root))))
+    (or (and (not refresh-p) (gethash project-root +php-composer-conf))
+        (let ((package-file (expand-file-name "composer.json" project-root)))
+          (when-let (data (and (file-exists-p package-file)
+                               (require 'json)
+                               (json-read-file package-file)))
+            (puthash project-root data +php-composer-conf))))))
+
+;;
+;;; Commands
+
+
+;;;###autoload
+(defun +php/open-repl ()
+  "Open PHP REPL."
+  (interactive)
+  (psysh)
+  (pop-to-buffer (current-buffer)))

.config/emacs/modules/lang/php/config.el

@@ -0,0 +1,178 @@
+;;; lang/php/config.el -*- lexical-binding: t; -*-
+
+(defvar +php--company-backends nil
+  "List of company backends to use in `php-mode'.")
+
+(defvar +php-default-docker-container "php-fpm"
+  "The default docker container to run commands in.")
+
+(defvar +php-default-docker-compose "docker-compose.yml"
+  "Path to docker-compose file.")
+
+(defvar +php-run-tests-in-docker nil
+  "Whether or not to run tests in a docker environment")
+
+(after! projectile
+  (add-to-list 'projectile-project-root-files "composer.json"))
+
+
+;;
+;;; Packages
+
+(use-package! php-mode
+  :mode "\\.inc\\'"
+  :hook (php-mode . rainbow-delimiters-mode)
+  :config
+  ;; Disable HTML compatibility in php-mode. `web-mode' has superior support for
+  ;; php+html. Use the .phtml extension instead.
+  (setq php-mode-template-compatibility nil)
+
+  (set-docsets! 'php-mode "PHP" "PHPUnit" "Laravel" "CakePHP" "CodeIgniter" "Doctrine_ORM")
+  (set-repl-handler! 'php-mode #'+php/open-repl)
+  (set-lookup-handlers! 'php-mode :documentation #'php-search-documentation)
+  (set-formatter! 'php-mode #'php-cs-fixer-fix)
+  (set-ligatures! 'php-mode
+    ;; Functional
+    :lambda "function()" :lambda "fn"
+    :def "function"
+    ;; Types
+    :null "null"
+    :true "true" :false "false"
+    :int "int" :float "float"
+    :str "string"
+    :bool "list"
+    ;; Flow
+    :not "!"
+    :and "&&" :and "and"
+    :or "||" :or "or"
+    :for "for"
+    :return "return"
+    :yield "use")
+
+  (if (not (featurep! +lsp))
+      ;; `+php-company-backend' uses `company-phpactor', `php-extras-company' or
+      ;; `company-dabbrev-code', in that order.
+      (when +php--company-backends
+        (set-company-backend! 'php-mode
+          (cons :separate +php--company-backends)
+          'company-dabbrev-code))
+    (when (executable-find "php-language-server.php")
+      (setq lsp-clients-php-server-command "php-language-server.php"))
+    (add-hook 'php-mode-local-vars-hook #'lsp!))
+
+  ;; Use the smallest `sp-max-pair-length' for optimum `smartparens' performance
+  (setq-hook! 'php-mode-hook sp-max-pair-length 5)
+
+  (sp-with-modes '(php-mode)
+    (sp-local-pair "<?"    "?>" :post-handlers '(("| " "SPC" "=") ("||\n[i]" "RET") ("[d2]" "p")))
+    (sp-local-pair "<?php" "?>" :post-handlers '(("| " "SPC") ("||\n[i]" "RET"))))
+
+  (map! :localleader
+        :map php-mode-map
+        :prefix ("t" . "test")
+        "r" #'phpunit-current-project
+        "a" #'phpunit-current-class
+        "s" #'phpunit-current-test))
+
+
+(use-package! phpactor
+  :unless (featurep! +lsp)
+  :after php-mode
+  :init
+  (add-to-list '+php--company-backends #'company-phpactor nil 'eq)
+  :config
+  (set-lookup-handlers! 'php-mode
+    :definition #'phpactor-goto-definition)
+  (map! :localleader
+        :map php-mode-map
+        :prefix ("r" . "refactor")
+        "cc" #'phpactor-copy-class
+        "mc" #'phpactor-move-class
+        "oi" #'phpactor-offset-info
+        "t"  #'phpactor-transform
+        "ic" #'phpactor-import-class))
+
+
+(use-package! php-refactor-mode
+  :hook php-mode
+  :config
+  (map! :localleader
+        :map php-refactor-mode-map
+        :prefix "r"
+        "cv" #'php-refactor--convert-local-to-instance-variable
+        "u"  #'php-refactor--optimize-use
+        "xm" #'php-refactor--extract-method
+        "rv" #'php-refactor--rename-local-variable))
+
+
+(use-package! php-extras
+  :after php-mode
+  :preface
+  ;; We'll set up company support ourselves
+  (advice-add #'php-extras-company-setup :override #'ignore)
+  :init
+  (add-to-list '+php--company-backends #'php-extras-company)
+  :config
+  (setq php-extras-eldoc-functions-file
+        (concat doom-etc-dir "php-extras-eldoc-functions"))
+  ;; Silence warning if `php-extras-eldoc-functions-file' hasn't finished
+  ;; generating yet.
+  (defun php-extras-load-eldoc ()
+    (require 'php-extras-eldoc-functions php-extras-eldoc-functions-file t))
+  ;; Make expensive php-extras generation async
+  (unless (file-exists-p (concat php-extras-eldoc-functions-file ".el"))
+    (message "Generating PHP eldoc files...")
+    (require 'async)
+    (async-start `(lambda ()
+                    ,(async-inject-variables "\\`\\(load-path\\|php-extras-eldoc-functions-file\\)$")
+                    (require 'php-extras-gen-eldoc)
+                    (php-extras-generate-eldoc-1 t))
+                 (lambda (_)
+                   (load (concat php-extras-eldoc-functions-file ".el"))
+                   (message "PHP eldoc updated!")))))
+
+
+(use-package! hack-mode
+  :when (featurep! +hack)
+  :mode "\\.hh$")
+
+
+(use-package! composer
+  :defer t
+  :init
+  (map! :after php-mode
+        :localleader
+        :map php-mode-map
+        :prefix ("c" . "composer")
+        "c" #'composer
+        "i" #'composer-install
+        "r" #'composer-require
+        "u" #'composer-update
+        "d" #'composer-dump-autoload
+        "s" #'composer-run-script
+        "v" #'composer-run-vendor-bin-command
+        "o" #'composer-find-json-file
+        "l" #'composer-view-lock-file))
+
+
+;;
+;; Projects
+
+(def-project-mode! +php-laravel-mode
+  :modes '(php-mode yaml-mode web-mode nxml-mode js2-mode scss-mode)
+  :files (and "artisan" "server.php"))
+
+(def-project-mode! +php-composer-mode
+  :modes '(web-mode php-mode)
+  :files ("composer.json"))
+
+(def-project-mode! +phpunit-docker-compose-mode
+  :when +php-run-tests-in-docker
+  :modes '(php-mode docker-compose-mode)
+  :files (and "phpunit.xml" (or +php-default-docker-compose  "docker-compose.yml"))
+  :on-enter
+  (setq phpunit-args `("exec" ,+php-default-docker-container "php" "vendor/bin/phpunit")
+        phpunit-executable (executable-find "docker-compose"))
+  :on-exit
+  (setq phpunit-args nil
+        phpunit-executable nil))

.config/emacs/modules/lang/php/doctor.el

@@ -0,0 +1,6 @@
+;; -*- lexical-binding: t; no-byte-compile: t; -*-
+;;; lang/php/doctor.el
+
+(assert! (or (not (featurep! +lsp))
+             (featurep! :tools lsp))
+         "This module requires (:tools lsp)")

.config/emacs/modules/lang/php/packages.el

@@ -0,0 +1,27 @@
+;; -*- no-byte-compile: t; -*-
+;;; lang/php/packages.el
+
+(package! psysh :pin "21250984ad8137aa3440ac12e52475ef03f19fcb")
+(package! php-extras
+  :recipe (:host github :repo "arnested/php-extras")
+  :pin "d410c5af663c30c01d461ac476d1cbfbacb49367")
+(package! php-mode :pin "535aec81739e8e766e0420fda616efc8846f2911")
+(package! php-refactor-mode :pin "7a794b0618df2882b1bd586fdd698dba0bc5130d")
+(package! phpunit :pin "fe6bc91c3bd8b329c6d26ad883a025f06b5121ee")
+(package! composer :pin "7c7f89df226cac69664d7eca5e913b544dc475c5")
+
+(when (featurep! +hack)
+  (package! hack-mode
+    :recipe (:host github :repo "hhvm/hack-mode")
+    :pin "4c1c2b093970b92f8589b061759288c0deb228c9"))
+
+(unless (featurep! +lsp)
+  (package! phpactor :pin "272217fbb6b7e7f70615fc518d77c6d75f33a44f")
+  (when (featurep! :completion company)
+    (package! company-phpactor :pin "272217fbb6b7e7f70615fc518d77c6d75f33a44f")))
+
+(when (featurep! :editor format)
+  (package! php-cs-fixer :pin "7e12a1af5d65cd8a801eeb5564c6268a4e190c0c"))
+
+;; For building php-extras
+(package! async :pin "5d365ffc6a2c2041657eaa5d762c395ea748c8d7")