Documentation restructuring

docs/intermediate/source-code-analysis.rst

@@ -0,0 +1,108 @@
+.. _source_code_analysis:
+
+********************
+Source Code Analysis
+********************
+
+This tutorial gives you a general overview how to do static code analysis from within the PHP
+container.
+
+.. seealso::
+   * :ref:`available_tools`
+   * :ref:`work_inside_the_php_container`
+
+
+**Table of Contents**
+
+.. contents:: :local:
+
+
+Awesome-ci
+==========
+
+Awesome-ci is a collection of tools for analysing your
+workspace and its files. You can for example check for:
+
+* git conflicts
+* git ignored files that have not been removed from the git index
+* trailing spaces and newlines
+* non-utf8 files or utf8 files with bom
+* windows line feeds
+* null-byte characters
+* empty files
+* syntax errors for various languages
+* inline css or js code
+* customized regex
+
+Some of the bundled tools even allow for automatic fixing.
+
+.. seealso:: `awesome-ci <https://github.com/cytopia/awesome-ci>`_
+
+.. code-block:: bash
+
+   # 1. Enter your PHP container
+   host> ./bash
+
+   # 2. Go to your project folder
+   devilbox@php-7.0.20 $ cd /shared/httpd/my-project
+
+   # 3. Run the tools
+   devilbox@php-7.0.20 $ git-conflicts --path=.
+   devilbox@php-7.0.20 $ git-ignored --path=.
+   devilbox@php-7.0.20 $ file-cr --path=.
+   devilbox@php-7.0.20 $ file-crlf --path=.
+   devilbox@php-7.0.20 $ file-empty --path=.
+
+   # 4. Run tools with more options
+   devilbox@php-7.0.20 $ syntax-php --path=. --extension=php
+   devilbox@php-7.0.20 $ syntax-php --path=. --shebang=php
+
+   # 5. Various syntax checks
+   devilbox@php-7.0.20 $ syntax-bash --path=. --text --extension=sh
+   devilbox@php-7.0.20 $ syntax-css --path=. --text --extension=css
+   devilbox@php-7.0.20 $ syntax-js --path=. --text --extension=js
+   devilbox@php-7.0.20 $ syntax-json --path=. --text --extension=json
+   devilbox@php-7.0.20 $ syntax-markdown --path=. --text --extension=md
+   devilbox@php-7.0.20 $ syntax-perl --path=. --text --extension=pl
+   devilbox@php-7.0.20 $ syntax-php --path=. --text --extension=php
+   devilbox@php-7.0.20 $ syntax-python --path=. --text --extension=python
+   devilbox@php-7.0.20 $ syntax-ruby --path=. --text --extension=rb
+   devilbox@php-7.0.20 $ syntax-scss --path=. --text --extension=scss
+
+
+PHPCS
+=====
+
+PHPCS is a code style analyser for PHP.
+
+.. seealso:: `PHPCS <https://github.com/squizlabs/PHP_CodeSniffer>`_
+
+.. code-block:: bash
+
+   # 1. Enter your PHP container
+   host> ./bash
+
+   # 2. Go to your project folder
+   devilbox@php-7.0.20 $ cd /shared/httpd/my-project
+
+   # 3. Run it
+   devilbox@php-7.0.20 $ phpcs .
+
+
+ESLint
+======
+
+ESLint is a Javascript static source code analyzer.
+
+.. seealso:: `ESLint <https://eslint.org>`_
+
+.. code-block:: bash
+
+   # 1. Enter your PHP container
+   host> ./bash
+
+   # 2. Go to your project folder
+   devilbox@php-7.0.20 $ cd /shared/httpd/my-project
+
+   # 3. Run it
+   devilbox@php-7.0.20 $ eslint .