Fix: static code analysis into our project

Introducing static code analysis
into our project has made code
reviews more efficient
Noël
NOV 27, 2020
@English Night vol.5
presented by GAOGAO Inc.

Introduction
<?php
/** ellipsis */
class Noel extends BackEnd implements Engineer
{
use Laravel, AWSCloudFormation;
public function performCodeReviews(): object
{/** ellipsis */}
public function focusOnNodeJSInPrivate(): void
{/** ellipsis */}
}

Dynamic Analysis
Static Analysis

Dynamic Analysis
Static Analysis
Works well so far
Never introduced

Dynamic Analysis
PHPUnit on CircleCI
Deploy to
ECS
Trigger Build
Push doc
to Repo
Pull
Request
Pull
Request

Whenever I was working on
the code review on Github
there would be
a bunch of conflicts due to subtle
differences, which include
- indent size differences in the same line
- single quote or double quote
- the differences with the number of whitespaces

How much time can we spare
fixing these nonsense differences ?
More than 10 file
conflicts per PR..!?
Come on !!!!!

We want to focus on thinking about
whether the architecture, the algorithm,
and the naming
are optimized or not.
More than 10 file
conflicts per PR..!?
Come on !!!!!

The stunning solution
has come to us!

Got inspired when assigned
for Vue.js projects
LinterFormatter

Awesome
Developer Experience
Spare yourself the extra time it takes to
indent the code differences.

Let’s move it onto Laravel
・Larastan
・PHPStan (2016)
・PHP CS
・PHP MD (2010)
Linter Candidates

・PHP-CS-Fixer
・Prettier PHP Plugin
Formatter Candidates
Let’s move it onto Laravel

Linter / Larastan
Formatter / PHP-CS-Fixer

Larastan
As for every tool except Larastan,
the parts used Facade and Magick Methods
automatically cause errors even if they
don’t have any problems on Laravel App.
Reasons why we had chosen
these two packages

Reasons why we had chosen
these two packages
Let us care for dependency managers by
simply only using composer and not using
npm or yarn for PHP environment.
PHP-CS-Fixer

Settings
{
// ellipsis
"require-dev": {
// ellipsis
"friendsofphp/php-cs-fixer": "^2.16",
"nunomaduro/larastan": "^0.6.9",
"phpunit/phpunit": "^8.0",
// ellipsis
},
// ellipsis
}
composer.json
Larastan
PHP-CS-Fixer

Notions
Fatal error: Allowed memory size of 1610612736 bytes exhausted
Standard Error
Larastan
services:
php-fpm:
build: // ellipsis
volumes: // ellipsis
environment:
- COMPOSER_MEMORY_LIMIT= -1 /usr/bin/composer
docker-compose.yml
1,610,612,736 bytes = 1.5 * (2^30) GB
PHP can use 128MB memory with default per script,
Composer can internally increase the memory_limit to 1.5 GB.

Explaination Larastan
・the discrepancy of type
・the discrepancy of PHPDoc
・the undefined methods / variables
etc...

Benefits Larastan
・Putting more emphasis on
writing phpdoc than before
・Becoming conscious of the type of
arguments, return values,
(Making up for the lack of PHP)

Results
root@dbdd4a531fc8:/var/www/html# ./vendor/bin/phpstan
analyse
Note: Using configuration file /var/www/html/phpstan.neon.
26/26 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
[OK] No errors
root@dbdd4a531fc8:/var/www/html#
app container
Larastan

Rules PHP-CS-Fixer
https://mlocati.github.io/php-cs-fixer-configurator/#version:2.16

Default
rule set (v2.16)
PhpCsFixerConfig::create()
->setRiskyAllowed(true)
->setRules([
'@PHP56Migration' => true,
'@PHPUnit60Migration:risky' => true,
'@PhpCsFixer' => true,
'@PhpCsFixer:risky' => true,
'header_comment' => ['header' => $header],
'list_syntax' => ['syntax' => 'long'],
])
->setFinder($finder)
;
PHP-CS-Fixer

Results
root@dbdd4a531fc8:/var/www/html# ./vendor/bin/php-cs-fixer
fix --dry-run ./app
Loaded config default.
Using cache file ".php_cs.cache".
1) app/Http/Controllers/PhotoController.php
2) app/Photo.php
3) app/User.php
Checked all files in 0.214 seconds, 14.000 MB memory used
app container
PHP-CS-Fixer

Default
rule set (v2.16)
PHP-CS-Fixer
// ellipsis
'@PHP56Migration' => true,
'@PHPUnit60Migration:risky' => true,
'@PhpCsFixer' => true,
'@PhpCsFixer:risky' => true,
'header_comment' => ['header' => $header],
'list_syntax' => ['syntax' => 'long'],
// ellipsis

PHP-CS-FixerCustomize rule
set example
return PhpCsFixerConfig::create()
->setRiskyAllowed(false)
/* indent_size */
->setIndent(" ")
->setRules([])
->setFinder();
// For example
'@PSR2' => true,
'concat_space' => ['spacing' => 'one'],

A peaceful time of
code review
has come at last

Whenever I was working on
the code review on Github
Just important conflicts
come up !
We can concentrate on reviewing more efficiently.

I’m supposed to post this as an
article in the Laravel Advent
Calendar on Qiita in Japanese

All free images credited by:
https://publicdomainq.net/tag/%E8%83%8C%E6%99%AF%EF%BC%88%E3%82%A4%E3%83%A9
%E3%82%B9%E3%83%88%EF%BC%89/?ssort=_ratings_score-pm&sdir=desc
https://iconbu.com/illust/3484
http://creativefreaks.net/%E3%83%95%E3%83%AA%E3%83%BC%E7%B4%A0%E6%9D%90/
https://www.stockio.com/free-vector/data-analysis-2
https://www.vectorstock.com/royalty-free-vector/young-man-worried-avatar-character-icon-vector-302
65520

Thanks a bunch
for listening up
to this Lightning Talk.
@ingenieur_noel

Fix: static code analysis into our project

Recommended

More Related Content

What's hot (20)

Similar to Fix: static code analysis into our project (20)

Recently uploaded (20)

Fix: static code analysis into our project