Przejdź do treści

Przetwarzanie zasobów

Minifikacja

Blockstudio może automatycznie minifikować wszystkie pliki CSS i JS w bloku.

Skompilowane pliki zostaną zapisane w folderze _dist bloku i dodane do kolejki, gdy blok zostanie użyty. Po aktualizacji pliku źródłowego Blockstudio sprawdza, czy istnieje skompilowany plik z tym znacznikiem czasu; jeśli nie, zostanie on utworzony.

W tym celu używana jest biblioteka minify.

Minifikację można włączyć za pomocą ustawienia assets/minify:

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

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

SCSS

Jeśli wolisz pisać style w SCSS, możesz włączyć przetwarzanie SCSS:

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

Spowoduje to włączenie przetwarzania SCSS dla plików .css.

Możesz też użyć rozszerzenia .scss, a style będą automatycznie przetwarzane nawet wtedy, gdy powyższe ustawienie nie jest true.

Ścieżki importu

Podczas korzystania z SCSS można importować inne pliki SCSS. Importy są określane względem pliku, z którego są importowane.

CSS
@import "modules.scss";

Dodatkowo można zdefiniować niestandardowe ścieżki importu za pomocą filtra blockstudio/assets/process/scss/import_paths, co pozwala importować pliki z innych katalogów bez podawania struktury folderów.

W importach można pominąć rozszerzenie .scss; obsługiwane są też pliki częściowe, takie jak _tokens.scss, oraz plik _index.scss z katalogu.

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

Wstęp

Jeśli chcesz udostępnić wspólne funkcje, zmienne, miksy lub narzędzia Sass w każdym pliku SCSS, możesz dodać globalny wstęp przed kompilacją.

Przydaje się to w przypadku frameworków takich jak Bootstrap, w których możesz chcieć korzystać ze wspólnych miksów, na przykład punktów przerwania, bez powtarzania importów w zasobach każdego bloku.

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

W połączeniu z blockstudio/assets/process/scss/import_paths udostępnia to odwołany zakres Sass wszystkim skompilowanym plikom.

Zasoby bloku są kompilowane ponownie po zmianie czasu modyfikacji zależności, w tym plików importowanych przez inne pliki częściowe. Blockstudio śledzi lokalne zależności @import, @use i @forward, w tym zależności wstępu i skonfigurowane ścieżki importu. Wspólne zależności są śledzone tylko raz, a cykle nie powodują zapętlenia podczas wykrywania. Pliki te są również uwzględniane na liście obserwowanych plików pamięci podręcznej środowiska wykonawczego.

Na przykład edycja mixins/_wysiwyg.scss powoduje ponowną kompilację global-styles.scss, jeśli importuje on scss/_wysiwyg.scss, który z kolei importuje ten miks. Zmiany nie wymagają edycji pliku wejściowego. Wbudowane moduły Sass i importy zdalne są wyłączone z lokalnego grafu zależności.

Moduły ES

Wszystkie skrypty (wbudowane i domyślne) w Blockstudio są domyślnie ładowane z włączoną obsługą type="module". Dzięki temu w skryptach bloków można używać składni import bez dodatkowej konfiguracji.

Uwaga

Więcej informacji o modułach ES znajdziesz w dokumentacji internetowej MDN.

Wyobraźmy sobie następujący kod wewnątrz 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")
);

Powyższy przykład utworzyłby komponent za pomocą Preact, importując wszystkie niezbędne komponenty i funkcje z CDN obsługującego ESM, w tym przypadku esm.sh. To podejście jest poprawne, ale wymaga pobierania potrzebnych zasobów z zewnętrznej strony, co grozi niedziałającymi skryptami, jeśli CDN przestanie działać.

Blockstudio oferuje wygodny sposób pobierania modułów ES do bloku, dzięki czemu podczas wdrażania nie trzeba korzystać z zewnętrznych CDN-ów ESM.

Konfiguracja

Aby pobrać moduł do katalogu bloku, użyj prefiksu npm:, a następnie podaj nazwę pakietu i wersję:

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";

Ta składnia jest zgodna z konwencją używania specyfikatora Deno npm.

Uwaga

Starszy prefiks blockstudio/ (e.g., blockstudio/preact@10.15.1) jest nadal obsługiwany ze względu na zgodność wsteczną, ale w nowych projektach zalecamy używanie prefiksu npm:. Szczegóły znajdziesz w przewodniku migracji.

Blockstudio automatycznie sprawdza zmienione pliki .js pod kątem importów i pobiera je do lokalnego katalogu bloku. Pobrane pliki zostaną umieszczone w folderze modules w katalogu bloku.

Przy zapisywaniu plik skryptu zostanie przepisany, aby korzystał z lokalnie hostowanego modułu:

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";

W edytorze podczas podglądu i pracy nad blokiem nadal będzie używany adres URL CDN (Blockstudio korzysta z esm.sh).

Ograniczenia

Wersja

Zazwyczaj można korzystać z modułów z CDN-ów bez numeru wersji. W takim przypadku zawsze używana jest najnowsza wersja. Ponieważ Blockstudio nie zapisuje żadnych informacji w bazie danych, przy korzystaniu z modułów wymagany jest numer wersji.

Te same moduły

Moduły są przypisane do swoich bloków. Nawet jeśli używasz tego samego modułu w tej samej wersji w wielu blokach, Blockstudio nadal pobierze żądany moduł do każdego bloku. Głównym powodem jest to, że bloki powinny być samodzielnymi jednostkami, które można łatwo udostępniać w innych instalacjach i witrynach.

Ponadto ten sam moduł zostanie zażądany dwukrotnie, jeśli oba bloki znajdują się na stronie. Można temu zaradzić, używając script-inline.js zamiast pliku script.js. Blockstudio przepisze każdy import tak, aby wskazywał lokalizację pierwszego wystąpienia modułu, jeśli nazwa i numer wersji są takie same.

CSS Loader

Pliki CSS można też importować, używając tej samej składni co powyżej.

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

Plik CSS zostanie pobrany do folderu modules i automatycznie dodany do kolejki, gdy blok zostanie użyty. Jeśli wersja jest taka sama, do kolejki zostanie dodana tylko jedna wersja pliku CSS, nawet jeśli występuje w wielu blokach.