Перейти к содержимому

Обработка ресурсов

Минификация

Blockstudio может автоматически минифицировать все файлы CSS и JS в блоке.

Скомпилированные файлы сохраняются в папке _dist блока и подключаются при его использовании. После изменения исходного файла Blockstudio проверяет, существует ли скомпилированный файл с соответствующей меткой времени; если нет, создаёт его.

Для этого используется библиотека minify.

Минификацию можно включить с помощью настройки assets/minify:

PHP
add_filter('blockstudio/settings/assets/minify/css', function() {
  return true;
});

add_filter('blockstudio/settings/assets/minify/js', function() {
  return true;
});

SCSS

Если вы предпочитаете писать стили на SCSS, можно включить обработку SCSS:

PHP
add_filter('blockstudio/settings/assets/process/scss', function() {
  return true;
});

Это включит обработку SCSS для файлов .css.

Также можно использовать расширение .scss — тогда стили будут обрабатываться автоматически, даже если указанная выше настройка не true.

Пути импорта

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

CSS
@import "modules.scss";

Кроме того, с помощью фильтра blockstudio/assets/process/scss/import_paths можно задать пользовательские пути импорта, чтобы импортировать файлы из других каталогов без указания структуры папок.

В импортах можно опускать расширение .scss и указывать частичные пути, например _tokens.scss, или файл _index.scss в каталоге.

PHP
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
  $paths[] = get_template_directory() . '/scss';
  return $paths;
});

Прелюдия

Чтобы общие функции Sass, переменные, миксины и утилиты были доступны в каждом файле SCSS, перед компиляцией можно добавить глобальную прелюдию.

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

PHP
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
  return '@import "functions";' . "\n"
    . '@import "variables";' . "\n"
    . '@import "mixins";';
}, 10, 3);

В сочетании с blockstudio/assets/process/scss/import_paths это делает доступными для каждого скомпилированного файла все ссылки на Sass.

Ресурсы блоков компилируются заново при изменении времени модификации зависимости, в том числе файлов, импортированных другими частичными файлами. Blockstudio отслеживает локальные зависимости @import, @use и @forward, включая зависимости прелюдии и настроенные пути импорта. Общие зависимости отслеживаются один раз, а циклические ссылки не приводят к бесконечному поиску. Эти файлы также включаются в список наблюдения кэша среды выполнения.

Например, при изменении файла mixins/_wysiwyg.scss файл global-styles.scss компилируется заново, если он импортирует scss/_wysiwyg.scss, который, в свою очередь, импортирует этот миксин. Для применения изменений не нужно редактировать входной файл. Встроенные модули Sass и удалённые импорты исключены из графа локальных зависимостей.

ES-модули

Все скрипты в Blockstudio — встроенные и стандартные — по умолчанию загружаются с применённым к ним type="module". Поэтому в скриптах блоков можно использовать синтаксис import без дополнительной настройки.

Примечание

Подробнее об ES-модулях читайте в документации MDN.

Представим, что следующий код находится внутри script.js:

JavaScript
import { h, render } from "https://esm.sh/preact@10.15.1";
import htm from "https://esm.sh/htm@3.1.1";
import confetti from "https://esm.sh/canvas-confetti@1.6.0";

const html = htm.bind(h);

function App(props) {
  confetti();
  return html`<h1>Hello ${props.name}!</h1>`;
}

render(
  html`<${App} name="Hello from Preact!" />`,
  document.querySelector("#element")
);

Пример выше создаст компонент с помощью Preact, импортировав все необходимые компоненты и функции из ESM-совместимого CDN, в данном случае esm.sh. В этом подходе нет ничего плохого, но для него необходимо запрашивать нужные ресурсы с внешнего сайта, и скрипты могут перестать работать, если CDN будет недоступен.

Blockstudio позволяет удобно загружать ES-модули в блок, устраняя необходимость во внешних CDN для ESM в рабочей среде.

Настройка

Чтобы загрузить модуль в каталог блока, используйте префикс npm:, за которым следуют название и версия пакета:

JavaScript
import { h, render } from "npm:preact@10.15.1";
import htm from "npm:htm@3.1.1";
import confetti from "npm:canvas-confetti@1.6.0";

Этот синтаксис соответствует соглашению Deno по указанию npmспецификатора.

Примечание

Устаревший префикс blockstudio/ (e.g., blockstudio/preact@10.15.1) по-прежнему поддерживается для обратной совместимости, но для новых проектов мы рекомендуем префикс npm:. Подробнее — в руководстве по миграции.

Blockstudio автоматически проверяет изменённые файлы .js на наличие импортов и загружает их в локальный каталог блока. Загруженные файлы помещаются в папку modules в каталоге блока.

При сохранении файл скрипта будет переписан для использования локально размещённого модуля:

JavaScript
import { h, render } from "./modules/preact/10.15.1.js";
import htm from "./modules/htm/10.15.1.js";
import confetti from "./modules/canvas-confetti/1.6.0.js";

В редакторе при предварительном просмотре и работе с блоком по-прежнему будет использоваться URL CDN (Blockstudio использует esm.sh).

Ограничения

Версия

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

Одинаковые модули

Модули привязаны к своим блокам. Даже если в нескольких блоках используется один и тот же модуль одной версии, Blockstudio всё равно загрузит запрошенный модуль в каталог каждого блока. Это связано главным образом с тем, что блоки должны быть самодостаточными единицами, которыми легко делиться и которые можно переносить на другие сайты и установки.

Кроме того, один и тот же модуль будет запрошен дважды, если на странице присутствуют оба блока. Эту проблему можно решить, используя script-inline.js вместо файла script.js. Blockstudio перепишет каждый импорт, указав путь к первому экземпляру модуля, если его название и версия совпадают.

Загрузчик CSS

Также можно импортировать файлы CSS, используя тот же синтаксис, что и выше.

JavaScript
import "npm:swiper@11.0.0/swiper.min.css";

Файл CSS будет загружен в папку modules и автоматически подключён при использовании блока. Если версия совпадает, будет подключена только одна версия файла CSS, даже если он есть в нескольких блоках.