PHPLint, CodeSniffer, Psalm

Проверка корректности кода с PHPLint. Валидация и корректировка стиля кода с CodeSniffer. Подключение статических анализаторов.

Скрытый контент
Комментарии (37)
Arunas

Спасибо :)

Ответить
Arunas

команда make init не заработала, ошибка: Generating autoload files ocramius/package-versions: Generating version class... ocramius/package-versions: ...done generating version class docker run --rm -v /api:/app -w /app alpine chmod 777 var chmod: var: No such file or directory Makefile:26: recipe for target 'api-permissions' failed make: *** [api-permissions] Error 1

Ответить
Arunas

На Линукс Ubuntu 18.04 всё ок, видимо, какие то не поладки в видовс, с вагрантом...

Ответить
Ruslan

Еще однин мученик на винде :) Скажите как вы организовали свою работу, особенно где у вас установлен PhpStorm? как прокинули портя в Винду?

Ответить
Arunas

Никаких мучений не испытываю. C Виндовс 10 про (там PhpStorm): Vagrant UP...-> VM (Ubuntu 16 голый - там инсталируем docker-compose и др.) -> вид 192.168.56.101:8081, 192.168.56.101:8080. В PhpStorme VM достигаем через ssh (C:\Users\arsku\projects\lPggCH\puphpet\files\dot\ssh\id_rsa)... и т.д.

Ответить
Ruslan

я так понимаю докер вы не используете, поэтому и мучений нет :)

Ответить
Arunas

Docker у меня не в Винде, а в VM (которую запускаю с Vagrant), Vagrant позволяет работать с тем-же каталогами и от Виндовса (там PhpStorm и вид в Crome через 192.168.56.101) и от Линукса (там же Docker и др). Дайте емайл - скину скрин-шот (извините за ошибки...)

Ответить
Ruslan

Vagrant and VirtualBox моя рабочая среда :) , в смысле для работы. tvjelgava@gmail.com И Vgrantfile скиньте, хочу посмотреть какие порты пробрасываете.

Сильно тормозит такой набор?

Ответить
Arunas

Пока не тормозит. с Vagrantfile не заморачиваюсь. Скинул.

Ответить
Arunas

Интересно, как Вы без Виндовс задействуете работу с кассовими апаратами и др. бизнес приборими (им надо ActiveX), ведь в магазинах, офисах стоит ВИНДОВС :)

Ответить
Ruslan

Я вас цельком поддерживаю MS Word никто не отменял. Просто я давно присматриваеюсь к Докеру и не видел в нем особой пользы, но сейчас всё проясняется и мне бы хотелось его использовать. Думал вы тоже с этим бьётесь и можно было обменятся опытом.

Ответить
Arunas

после make up, команды: make lint и make analyze прошли успешно.

Ответить
Александр

У меня у одного видео при просмотре подвисает?

Ответить
Юлия Елисеева

У меня всё нормально воспроизводится. Может, у вас скорость интернет-соединения низкая?

Ответить
Александр

Сейчас все хорошо даже на 2х скорости. Но вчера вечером даже на нормальной скорости были подвисания.

Ответить
Александр

Что вы думаете по поводу анализатора phan ? от творца php, пишут что он единственный настоящий статический анализатор - так как строит синтаксическое дерево при анализе. Но он сложноват в настройке.

Ответить
Ruslan

У меня под Виндой линтер ругается : End of line character is invalid; expected "\n" but found "\r\n"

Если делать деплой git-ом, то это заменятся автоматически, должен ли я это сообщение добавить в игнор, или всё таки нужно фиксить?

Ответить
Дмитрий Елисеев

Настройте в редакторе использование "\n" для файлов.

Ответить
Sergei

Дмитрий, позвольте получить от вас комментарий, что за phpspec, что за зверь такой, почему мы его не используем и чем он отличается от mockery? Спасибо.

Ответить
Дмитрий Елисеев

Mockery - это независимая библиотека для создания моков и стабов вместо createMock и createStab.

PHPSpec как Behavior Driven тестовый фреймворк позволяет записывать юнит-тесты через описание поведения кода более человекочитаемым языком.

BDD подход мы будем использовать для написания приёмочных тестов.

Ответить
Андрей

Дмитрий, у меня после добавления "squizlabs/php_codesniffer" или "overtrue/phplint" в composer.json и запуска make api-composer-install не происходит установки этих библиотек через Composer.

Composer выводит сообщение:

Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
Warning: The lock file is not up to date with the latest changes in composer.json. You may be getting outdated dependencies. It is recommended that you run `composer update` or `composer update <package name>`.
Nothing to install or update.

При запуске composer install и при наличии файла composer.lock не проверяются изменения в файле composer.json. Приходится запускать вручную composer update.

Что вы можете посоветовать в данном случае?

Ответить
Дмитрий Елисеев

Да, в lock-файле сохраняется хэш зависимостей из файла composer.json. И при ручном изменении это ломается. Так что добавляйте зависимости в файл не вручную, а через require:

composer require --dev overtrue/phplint

Иначе если правите вручную, то придётся запускать composer update, чтобы хэш персчитался. Но это обновит все пакеты.

Ответить
Yaroslav

Добрый день, Дмитрий! Спасибо за отличное руководство!

Недавно стал использовать Убунту для разработки и постоянно сталкиваюсь с ошибками которых не было на Виндовс. Самые частые из них - ошибки доступа к файлам. Приходится переназначать владельца, группу, права. И в связи с этим вопрос:

api-permissions:

docker run --rm -v ${PWD}/api:/app -w /app alpine chmod 777 var

Многие пишут, что выдавать 777 не очень хорошо.

Для api использовал Laravel, там есть директория storage. Для неё пришлось продублировать chmod 777 с флагом -R. Иначе не работало.

Это нормально или есть другие варианты?

Ответить
Дмитрий Елисеев

Для локальной разработки ставить 777 нормально, так как php-fpm и php-cli работают от разных пользователей и иначе не смогут записывать в общую примонтированную через volumes папку c var.

А в продакшеновских Dockerfile уже можно ставить конкретные chown и chmod для пользователя www-data в php-fpm и при желании для app в php-cli, если там создаём пользователя вроде app как в будущем 59-ом эпизоде.

Ответить
slo_nik

Добрый вечер, Дмитрий.

Запустил проверку проекта psalm-ом.

Возникла проблема, не пойму как решить.

Проект на Symfony, по Вашему примеру https://github.com/ElisDN/demo-project-manager

Psalm выдаёт ошибки для src/Security/UserProvider и src/Security/UserChecker

> ERROR: ParamNameMismatch - src/Security/UserProvider.php:54:47 - Argument 1 of App\Security\UserProvider::refreshUser has wrong name $identity, expecting $user as defined by Symfony\Component\Security\Core\User\UserProviderInterface::refreshUser (see https://psalm.dev/230)
public function refreshUser(UserInterface $identity): UserInterface

> ERROR: ParamNameMismatch - src/Security/UserChecker.php:34:49 - Argument 1 of App\Security\UserChecker::checkPostAuth has wrong name $identity, expecting $user as defined by Symfony\Component\Security\Core\User\UserCheckerInterface::checkPostAuth (see https://psalm.dev/230)
public function checkPostAuth(UserInterface $identity): void

Посмотрел в документации, там есть такая рекомендация.

https://psalm.dev/docs/running_psalm/issues/ParamNameMismatch/#config-allownamedargumentcallsfalse

В конфигурации psalm пробовал добавлять данные параметры - не помогло.

Как победить эти ошибки

Ответить
Дмитрий Елисеев

Прочитать текст ошибки:

Argument 1 of UserProvider::refreshUser has wrong name $identity, expecting $user as defined by UserProviderInterface::refreshUser

и переименовать параметр так, как он назван в методе интерфейса.

Ответить
slo_nik

Это понятно, как самый простой вариант.

Но можно ли как-то решить по-другому?

Ответить
Дмитрий Елисеев

Просто переименовать $identity в $user, чтобы стало правильно.

Зачем делать по-другому?

Ответить
slo_nik

В данном случае интересно, почему рекомендации из документации не сработали?

В чём может быть причина?

Вы же не зря в примере переименовывали параметр? Как я понимаю для удобства чтения кода и понимания, что именно находится в переменной.

Ответить
Дмитрий Елисеев

В данном случае интересно, почему рекомендации из документации не сработали?

Может из-за приписки о классе A.

Вы же не зря в примере переименовывали параметр?

Назвал для однообразия, чтобы всё у меня называлось identity.

А сейчас скорее назову $user по имени UserInterface, чтобы было технически корректно.

Ответить
slo_nik

Значит при использовании Psalm лучше избегать именования ради однообразия?

Ответить
Дмитрий Елисеев

Значит, что при наследовании классов и реализации интерфейсов надо всегда придерживаться оригинальных сигнатур методов, чтобы не было неожиданностей в будущем. А Psalm лишь помогает сразу находить такие несовпадения.

Ответить
slo_nik

Я уже это понял.

Но, поставил "чистый" Symfony ради эксперимента. Запустил Psalm - те же ошибки)))

В проекте поставил уровень ошибок psalm 4.

Для fetcher-ов получаю такую ошибку.

Too many arguments for method Doctrine\DBAL\Query\QueryBuilder::select

В самих fetcher-ах в select() передаю несколько аргументов, на это и ругается.

Если передать эти аргументы массивом, то psalm доволен.

Но в самом QueryBuilder для select() в комментарии предупреждение

USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument.

Поискал в документации к psalm как можно решить данную проблему, но пока не нашёл.

Как можно отключить реагирование psalm на такие "ошибки"?

Ответить
Дмитрий Елисеев

Можно подавить эту ошибку TooManyArguments конкретно для этого метода select.

Ответить
slo_nik

Благодарю.

В общем конфигурационном файле я подавил ошибку, но подумал, что если где-то я передам действительно большее число аргументов, то это будет плохо, поэтому интересовался как точечно подавить ошибку. Буду разбираться с этим.

Ещё вот такая ошибка возникает, никак не пойму, что именно psalm не нравится.

MissingDocblockType - src/DataFixtures/Location/City/CityFixtures.php:29:9 - Misplaced variable

Ошибка возникает в файлах fixtures.

Вот пример

public function load(ObjectManager $manager)
{
    /**
     * @var $firstCompany Company
     * @var $secondCompany Company
     */
    $firstCompany = $this->getReference(CompanyFixtures::FIRST_COMPANY);
    $secondCompany = $this->getReference(CompanyFixtures::SECOND_COMPANY);

    /*.....*/
}

В этом случае тоже можно подавить ошибку, или можно как-то дать понять psalm, что именно в docblock описано?

Ответить
Дмитрий Елисеев

поэтому интересовался как точечно подавить ошибку

Там как раз указано, как подавить только для одного метода через referencedMethod.

Ошибка возникает в файлах fixtures.

Ставьте тип перед переменной, а не после:

/**
 * @var Company $firstCompany
 * @var Company $secondCompany
 */
Ответить
slo_nik

Да, я уже понял и поменял местами тип.

Там как раз указано, как подавить только для одного метода через referencedProperty

Как раз так и сделал.

Благодарю ещё раз.

Ответить
Зарегистрируйтесь или войдите чтобы оставить комментарий

Или войти через:

Google
GitHub
Yandex
MailRu