Плагин для gulp — собираем файлы по кусочкам

    Недавно встала задача сверстать сайт не просто быстро, а очень быстро.

    Поэтому было принято решение развернуть gulp-проект (до сегодняшнего дня я еще никогда не прибегал к его помощи) и сосредоточиться непосредственно на кодинге. К сожалению, этого оказалось недостаточно.

    В процессе верстки стало понятно, что огромные полотна html- и js-кода с каждой строчкой все больше и больше замедляют процесс верстки. Если честно, данная проблема возникала и раньше, а сегодня встала особенно остро.

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

    Порывшись в интернете, нашел плагин gulp-rigger. Получаса хватило для того, чтоб понять, что это совсем не то, что нужно:

    • во-первых, странная обработка имен файлов. Почему-то, он не может работать с файлами .html (именно так), возможно есть и другие ограничения — не изучал;
    • во-вторых (и наиболее важно), что он не умеет работать рекурсивно — если попробуете подключить таким образом файл, в котором уже есть подключение другого файла, вывалится ошибка.

    Стало понятно, что моих проблем он решить не может.

    Поэтому был изучен необходимый минимум и написан собственный плагин для gulp — gulp-pagebuilder.

    Вышеназванные проблемы rigger он решает. Использование максимально просто. Допустим, имеем директорию с html-исходниками src, файлы собираются в build

    Таск для галпа будет выглядеть примерно так:

    var gulp = require('gulp'),
        pagebuilder = require('gulp-pagebuilder'));
    
    gulp.task('default', function () {
        return gulp.src('src/*.html')
            .pipe(pagebuilder('src'))
            .pipe(gulp.dest('build/'));
    });
    


    pagebuilder('src') — сюда мы передаем директорию с исходниками, относительно которой будут искаться подключаемые файлы

    В исходном файле подключаем другой файл:

    <div class="someclass" >
        [snp tpl="some/block/in/src/somefile.html" class="foo bar" tag="sometag" content="bla bla bla" ]
    </div>
    


    Причем, параметры, которые можно передавать и использовать в подключаемом сниппете (отсюда и сокращение [snp… ]), могут быть совершенно любые — class, tag и прочие. Главное, чтоб tpl указывал на существующий файл, в противном случае ничего не подключится.

    Подключаемый файл выглядит примерно так

    <div class="otherclass {class}" data-tag="{tag}" >
        Some content, {content}
    </div>
    


    В случае успешной сборки результирующий файл будет выглядеть следующим образом:

    <div class="someclass" data-tag="sometag" >
        <div class="otherclass foo bar" >
            Some content, bla bla bla
        </div>
    </div>
    


    Плагин работает с любыми текстовыми форматами, инклудить с его помощью можно и js

    Плагин доступен в npm, код выложен на github.

    Исправлять ошибки/замечания и причесывать код до нормального вида буду позже, когда появится время. Также буду рад любому фидбеку
    Есть ли в плагине необходимость и стоит ли его поддерживать дальше?

    Только зарегистрированные пользователи могут участвовать в опросе. Войдите, пожалуйста.

    Метки:
    Поделиться публикацией
    Похожие публикации
    Комментарии 26
    • +7
      А что было не взять готовый шаблонизатор, который уже умеет это все и еще чуть-чуть? Для CSS полно прекрасных препроцессоров, для JS — browserify/systemjs.
      Всегда искренне поражают люди, которые могут, например, за полдня набросать плагин к гальпу, но не знают, что задача уже решена.
      • 0
        webpack systemjs browserify requirejs в доп.
        • 0
          При всей моей любви к RequireJS — SystemJS умеет все то же самое (подгрузка без сборки + AMD + сборка + плагины для транспиляции) плюс CommonJS и ES6 — и тоже на лету. Про вебпак ничего не могу сказать, но киллер-фич не вижу.
          • –1
            hot module replacement — не киллер фича?
            а то, что всё (стили, изображения и тд) — это тоже модули? и их так же можно подключать, заменять и так далее
            • –1
              Для меня лично вау-фактор — да, но не киллер-фича. И вот почему:

              1) Только для react
              2) живая перегрузка стилей без обновления страницы есть давно
              3) зачем вообще это нужно? Мелкие проблемы отсеиваются еще на стадии юнит-тестов, крупные решаются дебагом: бряк, вотчи, пошаговое выполнение, медитации, вот это всё.
              • 0
                Чего? Только для react? У нас проект на angular и всё это работает.
                • +1
                  Ну предположим. Оффсайт как-то невнятно раскрывает эту тему, а сторонники обычно примерно той же степени адекватности, что и метеорщики и кроме восторженных воплей типа «оно собирает все мои скрипты и стили» ничего извлечь нельзя.
              • 0
                И что? Картинки вообще меняются полтора раза за жизнь проекта. Ливрелоад для стилей есть давно.
                • 0
                  Суть вебпака в том, что всё — модуль. Это и есть киллер-фича.
                  • 0
                    Ну, предположим, красивая концепция. А в практическом плане это что дает? Кроме лив-релоада картинок.
                    В галпе вот все — это поток. Потоки можно трансформировать налету, не записывая на диск, это дает прирость в скорости при сложных, многоступенчатых операциях.
                    • +1
                      То что он весь проект разбивает на чанки и подгужает по надобности.

                      В моих сумасшедших проектах если все собрать разом то будет так мегабайт 30.
                      А так пока в админку не войдешь, то библиотеки для графиков не подгузятся. Условно говоря.
                      • 0
                        В 30 мегов верится с трудом, но подгрузка чанками хорошая вещь, согласен. Но вопли о «модулях» и о их горячей замене как-то не раскрывают этот вопрос.
                        • 0
                          Вопли у вас в голове. С вами же нормально разговаривают. Зачем вы человека обижаете?
                          • 0
                            Внятное объяснение, чем хороши модули, я услышал только от вас. До тех пор мне пытались продать либо то, что давно есть, либо то, что не нужно.
                            А вот эту реплику я не могу назвать нормальным разговором.
                            • 0
                              В любом случае. Давайте оставим вопросы адекватности на стороне. Давайте жить дружно. Никто тут никому ничего не продает.

                              Каждому нужно что-то свое. Сложно на глаз определить что кому подойдет.
                              • 0
                                Давайте жить дружно.

                                Омг, конечно, давайте! Всего-то нужно было сразу ответить, чем так хорош вебпак, или дать ссылку, где это рассказывается.
                                • +4
                                  Извините, если это было резко. Просто я неадекватный.
                                  • +1
                                    Я тоже бывают резким, простите, если что.
        • +3
          Я просто оставлю это здесь:
          http://jade-lang.com/
          https://github.com/phated/gulp-jade
          • 0
            Jade, nunjuks, handlebars с экстендами + пару плагинов исключительно для инклуда есть в npm :)
            • 0
              Почему-то, он не может работать с файлами .html

              //= partials/client_profile.html

              Вот прямо сейчас у меня в проекте с rigger, всё работает, вы о чем?
              • 0
                Не сработает так:
                //= partials/.html
              • 0
                Автору вряд ли удастся получить одобрение, без понимания почему нужно возвращать поток с задачи

                gulp.task('default', function () {
                    [return] gulp.src('src/*.html')
                        .pipe(pagebuilder('src'))
                        .pipe(gulp.dest('build/'));
                });
                

                Уже раз пятый об этом пишу…

                Надо было сначала спросить на тостере, а то выглядит очень нелепо.
                Что бы получить правильный ответ — нужно задать правильный вопрос.
                Хотите чему-то научится или разобраться — зачем об это статьи писать?
              • 0
                Можно воспользоваться таже модулем — gulp-x-includer
                Вот так вставлять куски html кода, также он может работать с css и js

                <!-- include "./partials/_header.html" -->
                
                <div class="b-wrapper ">
                    <!-- include "./partials/header.html" -->
                
                …
                
                • +1
                  вот извращение… все решается одним jade'ом =/

                  Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.