Better Configuration Documentation (phpactor#359)

* Added configuration documentation

* RPC replay config

Author: dantleech

couscous.yml

@@ -30,6 +30,9 @@ menu:
                 vim-plugin:
                     text: VIM plugin
                     relativeUrl: vim-plugin.html
+                configuration:
+                    text: Configuration
+                    relativeUrl: configuration.html
         reference:
             name: Reference
             items:

doc/configuration.md

@@ -0,0 +1,153 @@
+---
+currentMenu: configuration
+---
+Configuration
+=============
+
+Configuration files are loaded from your current directory, and then from the
+XDG standard user and system directories, for example:
+
+ - `/home/daniel/www/phpactor/phpactor/.phpactor.yml`
+ - `/home/daniel/.config/phpactor/phpactor.yml`
+ - `/etc/xdg/phpactor/phpactor.yml`
+
+Phpactor will merge configuration files, with more specific configurations
+overriding the less specific ones.
+
+Config Dump
+-----------
+
+Use the `config:dump` command to show the currently loaded configuration files
+and all of the current settings:
+
+```bash
+$ phpactor config:dump
+Config files:               
+ [✔] /home/daniel/workspace/myproject/.phpactor.yml
+ [✔] /home/daniel/.config/phpactor/phpactor.yml
+ [𐄂] /etc/xdg/phpactor/phpactor.yml                                   
+
+ code_transform.class_new.variants:
+	exception:exception    
+	autoload:vendor/autoload.php
+
+ # ... etc
+```
+
+Reference
+---------
+
+### Core
+
+#### autoload
+
+*Default*: `vendor/autoload.php`
+
+Phpactor will automatically look to see if it can use the
+[composer](https://getcomposer.org) autoloader at this
+path. The autoloader helps Phpactor locate classes.
+
+#### autoload.deregister
+
+*Default*: `true`
+
+By default Phpactor will deregister the included autoloader to prevent
+any potential conflicts. However, some autoloaders may add global dependencies
+on the code available through that autoloader (e.g. Drupal). In such cases
+set this to `false` and hope that everything is *fine*.
+
+#### cache_dir
+
+Directory Phpactor uses for the cache (e.g. the PhpStorm stub index).
+
+#### logging.enabled
+
+*Default*: `false`
+
+Phpactor can log information, notably RPC requests and responses in addition
+to other debug information.
+
+#### logging.fingers_crossed
+
+*Default*: `false`
+
+If set to `true` only log when an error occurs, but when an error does occur
+include all the log levels.
+
+#### logging.level
+
+*Default*: `DEBUG`
+
+The default logging level.
+
+#### logging.path
+
+*Default*: `phpactor.log`
+
+Where the log file is
+
+### Code Transform Extension
+
+#### code_transform.class_new.variants
+
+```
+code_transform.class_new.variants:                                                             
+  exception: exception                          
+  symfony_command: symfony_command
+```
+
+The variants available when generating new classes. The name of the variant
+should match a directory in a `templates` directory, e.g.:
+
+```
+<your project root>/.phpactor/templates/
+    exception/
+        SourceCode.php.twig
+```
+
+or any of the XDG directories (e.g. `$HOME/.config/phpactor/templates`).
+
+#### code_transform.template_paths
+
+*Default*: `<xdg paths>/templates` and local project `.phpactor/templates`
+
+Directories where class templates can be located.
+
+### Navigator Extension
+
+#### navigator.destinations
+
+The navigator allows navigation between different aspects of the source code
+(e.g. source and tests). A simple configuration would look as follows:
+
+```
+navigator.destinations:
+  source:lib/<kernel>.php                      
+  unit_test:tests/Unit/<kernel>Test.php 
+```
+
+This would enable you to jump (`context menu > navigate`) from
+`lib/Acme/Post.php` to `tests/Unit/Acme/Post.php`.
+
+#### navigator.autocreate
+
+If a navigator destination doesn't exist, you can automatically create them
+using a one of the `code_transform.class_new_variants`:
+
+```
+code_transform.class_new.variants:                                                             
+  source: default
+  unit_test: phpunit_test
+  exception:exception                          
+  symfony_command:symfony_command
+```
+
+### RPC Extension
+
+#### rpc.store_replay
+
+*Default*: `false`
+
+The `rpc` command can replay the last request (useful when debugging an RPC
+client). For this to work enable this flag so that the requests are stored in
+a temporary location.

doc/standalone.md

@@ -54,32 +54,3 @@ $ phpactor status
 ✔ Composer detected - faster class location and more features!
 ✔ Git detected - enables faster refactorings in your repository scope!
 ```
-
-Configuration
--------------
-
-Phpactor is configured with a YAML file. You can dump the configuration using the `config:dump` command.
-
-```bash
-$ phpactor config:dump
-Config files:               
- [✔] /home/daniel/www/phpactor/phpactor/.phpactor.yml
- [✔] /home/daniel/.config/phpactor/phpactor.yml
- [𐄂] /etc/xdg/phpactor/phpactor.yml                                   
-
- code_transform.class_new.variants:
-	exception:exception    
-	autoload:vendor/autoload.php
-
- # ... etc
-```
-
-Note the `Config files` section above. This is a list of config files that
-Phpactor has attempted to load:
-
-- From the current directory.
-- From the users home directory.
-- From the systems configuration directory.
-
-Phpactor will merge configuration files, with more specific configurations
-overriding the less specific ones.