ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-23 14:42:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DVL-012 Add documentation for awesome-ci

Browse Source
This commit is contained in:
cytopia 2017-08-16 09:16:58 +02:00
parent 77fb8d50d1
commit b2ebe2df0a
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
5 changed files with 152 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.devilbox/www/config.php
View File

@ -11,7 +11,7 @@ putenv('RES_OPTIONS=retrans:1 retry:1 timeout:1 attempts:1');
$DEVILBOX_VERSION = 'v0.11'; $DEVILBOX_VERSION = 'v0.11';
$DEVILBOX_DATE = '2017-06-25'; $DEVILBOX_DATE = '2017-08-16';
$DEVILBOX_API_PAGE = 'devilbox-api/status.json'; $DEVILBOX_API_PAGE = 'devilbox-api/status.json';
// //

24
README.md
View File

@ -207,6 +207,7 @@ The devilbox has everything setup for you. The only thing you will have to insta
| tool | binary | | tool | binary |
|----------------|---------| |----------------|---------|
| [awesome-ci](https://github.com/cytopia/awesome-ci) | `file-cr`, `file-crlf`, `file-empty`, `file-nullbyte-char`, `file-trailing-newline`, `file-trailing-single-newline`, `file-trailing-space`, `file-utf8`, `file-utf8-bom`, `git-conflicts`, `git-ignored`, `inline-css`, `inline-js`, `regex-grep`, `regex-perl`, `syntax-bash`, `syntax-css`, `syntax-js`, `syntax-json`, `syntax-markdown`, `syntax-perl`, `syntax-php`, `syntax-python`, `syntax-ruby`, `syntax-scss`, `syntax-sh` |
| [composer](https://getcomposer.org) | `composer` | | [composer](https://getcomposer.org) | `composer` |
| [drupal-console](https://drupalconsole.com) | `drupal` | | [drupal-console](https://drupalconsole.com) | `drupal` |
| [drush](http://www.drush.org) | `drush` | | [drush](http://www.drush.org) | `drush` |
@ -344,14 +345,21 @@ The devilbox documentation consists of the following main sections.
2. [MongoDB Database Restore](docs/Backups.md#4-1-mongodb-database-restore) 2. [MongoDB Database Restore](docs/Backups.md#4-1-mongodb-database-restore)
10. **[Examples](docs/Examples.md)** 10. **[Examples](docs/Examples.md)**
1. [Introduction](docs/Examples.md#1-introduction) 1. [Introduction](docs/Examples.md#1-introduction)
2. [Setup CakePHP](docs/Examples.md#2-setup-cakephp) 1. [Framework/CMS tools](docs/Examples.md#1-1-framework-cms-tools)
3. [Setup Drupal](docs/Examples.md#3-setup-drupal) 2. [Code analysis tools](docs/Examples.md#1-2-code-analysis-tools)
4. [Setup Laravel](docs/Examples.md#4-setup-laravel) 2. [Project setup](docs/Examples.md#2-project-setup)
5. [Setup Phalcon](docs/Examples.md#5-setup-phalcon) 2. [Setup CakePHP](docs/Examples.md#2-1-setup-cakephp)
6. [Setup Symfony](docs/Examples.md#6-setup-symfony) 3. [Setup Drupal](docs/Examples.md#2-2-setup-drupal)
7. [Setup Wordpress](docs/Examples.md#7-setup-wordpress) 4. [Setup Laravel](docs/Examples.md#2-3-setup-laravel)
8. [Setup Yii](docs/Examples.md#8-setup-yii) 5. [Setup Phalcon](docs/Examples.md#2-4-setup-phalcon)
9. [Setup Zend](docs/Examples.md#9-setup-zend) 6. [Setup Symfony](docs/Examples.md#2-5-setup-symfony)
7. [Setup Wordpress](docs/Examples.md#2-6-setup-wordpress)
8. [Setup Yii](docs/Examples.md#2-7-setup-yii)
9. [Setup Zend](docs/Examples.md#2-8-setup-zend)
3. [Code analysis](docs/Examples.md#3-code-analysis)
1. [awesome-ci](docs/Examples.md#3-1-awesome-ci)
2. [phpcs](docs/Examples.md#3-2-phpcs)
3. [eslint](docs/Examples.md#3-3-eslint)
11. **[Technical](docs/Technical.md)** 11. **[Technical](docs/Technical.md)**
1. [Networking](docs/Technical.md#1-networking) 1. [Networking](docs/Technical.md#1-networking)
2. [Ports and forwarding](docs/Technical.md#2-ports-and-forwarding) 2. [Ports and forwarding](docs/Technical.md#2-ports-and-forwarding)

135
docs/Examples.md
View File

@ -19,20 +19,31 @@ Examples |
## Examples ## Examples
1. [Introduction](#1-introduction) 1. [Introduction](#1-introduction)
2. [Setup CakePHP](#2-setup-cakephp) 1. [Framework/CMS tools](#1-1-framework-cms-tools)
3. [Setup Drupal](#3-setup-drupal) 2. [Code analysis tools](#1-2-code-analysis-tools)
4. [Setup Laravel](#4-setup-laravel) 2. [Project setup](#2-project-setup)
5. [Setup Phalcon](#5-setup-phalcon) 1. [Setup CakePHP](#2-1-setup-cakephp)
6. [Setup Symfony](#6-setup-symfony) 2. [Setup Drupal](#2-2-setup-drupal)
7. [Setup Wordpress](#7-setup-wordpress) 3. [Setup Laravel](#2-3-setup-laravel)
8. [Setup Yii](#8-setup-yii) 4. [Setup Phalcon](#2-4-setup-phalcon)
9. [Setup Zend](#9-setup-zend) 5. [Setup Symfony](#2-5-setup-symfony)
6. [Setup Wordpress](#2-6-setup-wordpress)
7. [Setup Yii](#2-7-setup-yii)
8. [Setup Zend](#2-8-setup-zend)
3. [Code analysis](#3-code-analysis)
1. [awesome-ci](#3-1-awesome-ci)
2. [phpcs](#3-2-phpcs)
3. [eslint](#3-3-eslint)
--- ---
## 1. Introduction ## 1. Introduction
The devilbox provides popular tools for setting up and managing major frameworks or content management systems. The following bundled tools are available: The devilbox provides popular tools for setting up and managing major frameworks or content management systems, as well as tools for static code analysis. The following bundled tools are available inside each PHP|HHVM Docker container:
#### 1.1 Framework/CMS tools
You can use the following tools to setup or manage your Frameworks/CMS.
| Binary | Tool name | Framework/CMS | | Binary | Tool name | Framework/CMS |
|------------|-------------------|--------------------| |------------|-------------------|--------------------|
@ -45,8 +56,20 @@ The devilbox provides popular tools for setting up and managing major frameworks
| `symfony` | [symfony installer](https://github.com/symfony/symfony-installer) | Symfony | | `symfony` | [symfony installer](https://github.com/symfony/symfony-installer) | Symfony |
| `wp` | [wp-cli](https://wp-cli.org/) | Wordpress | | `wp` | [wp-cli](https://wp-cli.org/) | Wordpress |
#### 1.2 Code analysis tools
## 2. Setup CakePHP You can use the following tools to analyse and fix your source code files.
| Binary | Tool name | Description |
|------------|-------------------|--------------------|
| `file-cr`, `file-crlf`, `file-empty`, `file-nullbyte-char`, `file-trailing-newline`, `file-trailing-single-newline`, `file-trailing-space`, `file-utf8`, `file-utf8-bom`, `git-conflicts`, `git-ignored`, `inline-css`, `inline-js`, `regex-grep`, `regex-perl`, `syntax-bash`, `syntax-css`, `syntax-js`, `syntax-json`, `syntax-markdown`, `syntax-perl`, `syntax-php`, `syntax-python`, `syntax-ruby`, `syntax-scss`, `syntax-sh` | [awesome-ci](https://github.com/cytopia/awesome-ci) | General file, code and repository analysis and linting (Some of them also support to fix the problems) |
| `phpcs` | [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) | Lint and optionally fix your PHP files |
| `eslint` | [eslint](http://eslint.org/) | Lint and optionally fix your JS files |
## 2. Project Setup
#### 2.1 Setup CakePHP
> **[Official CakePHP Documentation](https://book.cakephp.org/3.0/en/installation.html)** > **[Official CakePHP Documentation](https://book.cakephp.org/3.0/en/installation.html)**
@ -121,7 +144,7 @@ If you do not have auto-DNS configured, you will need to add the following line
All set now, you can visit http://my-cake.loc in your browser. All set now, you can visit http://my-cake.loc in your browser.
## 3. Setup Drupal #### 2.2 Setup Drupal
> **[Official Drupal Documentation](https://www.drupal.org/docs/7/install)** > **[Official Drupal Documentation](https://www.drupal.org/docs/7/install)**
@ -169,7 +192,7 @@ Open your browser at http://my-drupal.loc and follow the Drupal installation ste
**Note:** For MySQL host choose `127.0.0.1`. **Note:** For MySQL host choose `127.0.0.1`.
## 4. Setup Laravel #### 2.3 Setup Laravel
> **[Official Laravel Documentation](https://laravel.com/docs/5.4/installation)** > **[Official Laravel Documentation](https://laravel.com/docs/5.4/installation)**
@ -215,7 +238,7 @@ If you do not have auto-DNS configured, you will need to add the following line
Open your browser at http://my-laravel.loc Open your browser at http://my-laravel.loc
## 5. Setup Phalcon #### 2.4 Setup Phalcon
> **[Official Phalcon Documentation](https://docs.phalconphp.com/en/3.2/devtools-usage)** > **[Official Phalcon Documentation](https://docs.phalconphp.com/en/3.2/devtools-usage)**
@ -261,7 +284,7 @@ If you do not have auto-DNS configured, you will need to add the following line
Open your browser at http://my-phalcon.loc Open your browser at http://my-phalcon.loc
## 6. Setup Symfony #### 2.5 Setup Symfony
> **[Official Symfony Documentation](https://symfony.com/doc/current/setup.html)** > **[Official Symfony Documentation](https://symfony.com/doc/current/setup.html)**
@ -312,7 +335,7 @@ If you do not have auto-DNS configured, you will need to add the following line
Open your browser at http://my-symfony.loc Open your browser at http://my-symfony.loc
## 7. Setup Wordpress #### 2.6 Setup Wordpress
> **[Official Wordpress Documentation](https://codex.wordpress.org/Installing_WordPress)** > **[Official Wordpress Documentation](https://codex.wordpress.org/Installing_WordPress)**
@ -358,7 +381,7 @@ If you do not have auto-DNS configured, you will need to add the following line
Open your browser at http://my-wp.loc Open your browser at http://my-wp.loc
## 8. Setup Yii #### 2.7 Setup Yii
> **[Official Yii Documentation](http://www.yiiframework.com/doc-2.0/guide-start-installation.html)** > **[Official Yii Documentation](http://www.yiiframework.com/doc-2.0/guide-start-installation.html)**
@ -404,7 +427,7 @@ If you do not have auto-DNS configured, you will need to add the following line
Open your browser at http://my-yii.loc Open your browser at http://my-yii.loc
## 9. Setup Zend #### 2.8 Setup Zend
> **[Official Zend Documentation](https://docs.zendframework.com/tutorials/getting-started/skeleton-application/)** > **[Official Zend Documentation](https://docs.zendframework.com/tutorials/getting-started/skeleton-application/)**
@ -448,3 +471,81 @@ If you do not have auto-DNS configured, you will need to add the following line
**6. Open your browser** **6. Open your browser**
Open your browser at http://my-zend.loc Open your browser at http://my-zend.loc
## 3. Code analysis
#### 3.1 awesome-ci
**[awesome-ci](https://github.com/cytopia/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 allow for automatic fixing. See the project page for how to use it: [https://github.com/cytopia/awesome-ci](https://github.com/cytopia/awesome-ci).
The following shows an example how to use it with the devilbox:
```shell
# 1. Enter your PHP/HHVM 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
...
```
#### 3.2 phpcs
**[phpcs](https://github.com/squizlabs/PHP_CodeSniffer)** is also available the devilbox:
```shell
# 1. Enter your PHP/HHVM 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 .
```
For more details visit its project page [https://github.com/squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
#### 3.3 eslint
**[eslint](http://eslint.org/)** is also available the devilbox:
```shell
# 1. Enter your PHP/HHVM 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 .
```
For more details visit its project page [http://eslint.org](http://eslint.org).

16
docs/FAQ.md
View File

@ -154,35 +154,35 @@ You need a valid DNS entry for every project that points to the Httpd server. As
#### Does it work with CakePHP? #### Does it work with CakePHP?
Yes, see **[How to setup CakePHP](Examples.md#2-setup-cakephp)**. Yes, see **[How to setup CakePHP](Examples.md#2-1-setup-cakephp)**.
#### Does it work with Drupal? #### Does it work with Drupal?
Yes, see **[How to setup Drupal](Examples.md#3-setup-drupal)**. Yes, see **[How to setup Drupal](Examples.md#2-2-setup-drupal)**.
#### Does it work with Laravel? #### Does it work with Laravel?
Yes, see **[How to setup Laravel](Examples.md#4-setup-laravel)**. Yes, see **[How to setup Laravel](Examples.md#2-3-setup-laravel)**.
#### Does it work with PhalconPHP? #### Does it work with PhalconPHP?
Yes, see **[How to setup Phalcon](Examples.md#5-setup-phalcon)**. Yes, see **[How to setup Phalcon](Examples.md#2-4-setup-phalcon)**.
#### Does it work with Symfony? #### Does it work with Symfony?
Yes, see **[How to setup Symfony](Examples.md#6-setup-symfony)**. Yes, see **[How to setup Symfony](Examples.md#2-5-setup-symfony)**.
#### Does it work with Wordpress? #### Does it work with Wordpress?
Yes, see **[How to setup Wordpress](Examples.md#7-setup-wordpress)**. Yes, see **[How to setup Wordpress](Examples.md#2-6-setup-wordpress)**.
#### Does it work with Yii? #### Does it work with Yii?
Yes, see **[How to setup Yii](Examples.md#8-setup-yii)**. Yes, see **[How to setup Yii](Examples.md#2-7-setup-yii)**.
#### Does it work with Zend Framework? #### Does it work with Zend Framework?
Yes, see **[How to setup Zend](Examples.md#9-setup-zend)**. Yes, see **[How to setup Zend](Examples.md#2-8-setup-zend)**.
## 4. Troubleshooting ## 4. Troubleshooting

18
docs/Quickstart.md
View File

@ -188,15 +188,15 @@ lrwxrwxrwx 1 cytopia 11 Jun 14 08:29 htdocs -> cakephp/app/webroot/
To quickly find setup instructions for your framework of choice head over to **[Examples](Examples.md)**: To quickly find setup instructions for your framework of choice head over to **[Examples](Examples.md)**:
> 1. [Introduction](Examples.md#1-introduction) > 2. [Project setup](Examples.md#2-project-setup)
> 2. [Setup CakePHP](Examples.md#2-setup-cakephp) > 1. [Setup CakePHP](Examples.md#2-1-setup-cakephp)
> 3. [Setup Drupal](Examples.md#3-setup-drupal) > 2. [Setup Drupal](Examples.md#2-2-setup-drupal)
> 4. [Setup Laravel](Examples.md#4-setup-laravel) > 3. [Setup Laravel](Examples.md#2-3-setup-laravel)
> 5. [Setup Phalcon](Examples.md#5-setup-phalcon) > 4. [Setup Phalcon](Examples.md#2-4-setup-phalcon)
> 6. [Setup Symfony](Examples.md#6-setup-symfony) > 5. [Setup Symfony](Examples.md#2-5-setup-symfony)
> 7. [Setup Wordpress](Examples.md#7-setup-wordpress) > 6. [Setup Wordpress](Examples.md#2-6-setup-wordpress)
> 8. [Setup Yii](Examples.md#8-setup-yii) > 7. [Setup Yii](Examples.md#2-7-setup-yii)
> 9. [Setup Zend](Examples.md#9-setup-zend) > 8. [Setup Zend](Examples.md#2-8-setup-zend)
## 6. Enter the PHP Docker container ## 6. Enter the PHP Docker container