А чем мешает md файл в корне плагина?

Syrnik.com

на этой неделе какие-то новые стандарты проверки, видимо, случились.

Чем мешают в корне плагина файлы markdown CHANGELOG или, там, README?


27 апреля 2016
  • Проверки становятся строже и более формализованными — это позволит их автоматизировать в большей степени и поделиться с разработчиками утилитой для самостоятельных проверок кода.

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

  • Syrnik.com 27 апреля 2016 08:08

    и такие инструменты ведь есть. И для unit-тестирования, и для непрерывной интеграции.

    Но это снова возвращает нас к вопросу о поддержке устаревших версий php и поддержке фреймворком различных PSR.

    Ну ок. Будем ждать "утилиту самостоятельной проверки" :-/


  • Eugen Nichikov 27 апреля 2016 08:18

    Если файл запрещён, можно и в блеклист wa.php compress тогда добавить

    http://joxi.ru/Y2LpX7MFnDZLx2?d=1

  • Syrnik.com 27 апреля 2016 08:47

    compress это какая-то утилита, встроенная в wa? типа она там что-то должна проверять, кажется. Оно уже заработало? Я когда последний раз ее пробовал, она падала с жалобами на отсутствие каких-то библиотек PEAR, которые пыталась искать в директории Инсталлера (которого, конечно нет). Больше я ее и не запускал. у меня расово-верный tar отлично справляется.

    Разные createPlugin тоже очень обижаются, что им нельзя писать в wa-config, а даже если и разрешить все равно сздают смешные директории с названием Array. Поэтому и ими не пользуюсь. Создать sh-скриптом структуру несложно.

  • Eugen Nichikov 27 апреля 2016 09:04

    В самом начале Пути я написал своё приложение, которое делало плагины :)

    Но сейчас утилиты wa.php прекрасно справляется. Поговаривают, что даже можно дефолтный конфиг с вендором где-то записать.

    Конкретно compress кроме архивации сейчас пропускает файлы из блеклиста, считает мд5 (.files.md5) и когда-то будет проверять Code Style.

  • Syrnik.com 27 апреля 2016 13:50

    конкретно

    tar czvf plugin.tar.gz plugin/* --exclude-vcs -X ~/webasyst/blacklisted_files.txt

    тоже замечательно пропускает файлы из блеклиста ;)

  • Eugen Nichikov 27 апреля 2016 15:04

    А.... ну эта команда безусловно проще чем

    php wa.php compress app_id/plugins/plugin_id

    Осталось только tar под винду поставить :)

  • Syrnik.com 27 апреля 2016 15:10

    есть такая штука в линухе... .bash_aliases называется.

    function gzipWaPlugin() {
    tar czvf $1.tar.gz $1/* --exclude-vcs -X ~/webasyst/excludes.txt
    }
    alias gzplg=gzipWaPlugin
    

    после этого в консоли можно смело командовать

    gzplg myplugin
  • Syrnik.com 28 апреля 2016 06:09

    Тем не менее, возвращаясь к основной теме, в корне Shop-Script отлично живет README.md :)

    Нужность подобных файлов при установке кода через инсталлер спорная, с учетом того, что их почти никто не видит и еще меньше читает.
  • В архиве, который получает инсталлер? или в GitHub?

    В первом случае таких файлов нет (что и требуется и от архивов сторонних разработчиков), а во втором случае есть.

  • ITFrogs 1 мая 2016 12:04

    Давайте не будем придираться к файлам, необходимым для гитхаба. Легализуйте их пожалуйста.

    А утилитой делитесь. Очень хотелось бы...

  • km 4 мая 2016 07:16

    Ну хз. Гитхаб гитхабом, а продакш отдельно должен быть и без всяких ненужных в нем файлов. Сделайте отдельный сборщик для production версии, который всё делает и кладет в отдельную папку. А версия для разработки с гитом пусть отдельно



Чтобы добавить комментарий, зарегистрируйтесь или войдите