Download the PHP package berecont/contao-scss-compiler-bundle without Composer
On this page you can find all versions of the php package berecont/contao-scss-compiler-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package contao-scss-compiler-bundle
Contao SCSS Compiler Bundle
Ein Backend-Bundle für Contao, mit dem SCSS-Dateien direkt in der Contao-Administration zu CSS kompiliert werden können.
Das Bundle richtet sich an Projekte, in denen Styles komfortabel in SCSS gepflegt, im Frontend jedoch als fertig kompilierte CSS-Datei eingebunden werden sollen.
Features
- SCSS-Quelldatei über den Contao-Dateipicker auswählen
- CSS-Zieldatei über den Contao-Dateipicker festlegen
- Zielpfad und Zieldatei getrennt von der Quelle wählbar
- vorhandene CSS-Zieldateien aktualisieren bzw. überschreiben
- mehrere Compiler-Konfigurationen als eigene Datensätze verwalten
- einzelne SCSS-Konfigurationen direkt im Backend kompilieren
- mehrere konfigurierte Stylesheets zentral verwalten
- optionale Erstellung einer Source Map
- Status- und Fehlermeldungen direkt im Contao-Backend
- Integration als Backend-Modul unter System
Voraussetzungen
- PHP
^8.3 || ^8.4 - Contao
^5.3 || ^5.7 - Composer
Die tatsächlich unterstützten Versionen richten sich zusätzlich nach den Abhängigkeiten, die in der composer.json des Bundles definiert sind.
Installation
Über Composer / Packagist
Sobald das Bundle über Packagist veröffentlicht ist:
Anschließend den Contao Manager bzw. die Datenbankmigration ausführen.
Verwendung
Nach der Installation steht im Contao-Backend unter System das Modul für den SCSS-Compiler zur Verfügung.
Für jede gewünschte Kompilierung wird ein eigener Datensatz angelegt.
Dabei werden im Wesentlichen folgende Angaben definiert:
-
Quelldatei
Die zu kompilierende.scss-Datei. -
Zieldatei
Die CSS-Datei, in welche das Ergebnis geschrieben werden soll. -
Ausgabeformat
Es kann zwischenKomprimiertundFormatiertgewählt werden.Komprimierterzeugt eine*.min.css. - Source Map
Optional kann eine Source Map für die erzeugte CSS-Datei erstellt werden.
Die SCSS-Datei kann anschließend über die entsprechende Aktion im Backend kompiliert werden.
Beispiel
Eine mögliche Projektstruktur:
Eine Compiler-Konfiguration könnte damit beispielsweise folgende Zuordnung enthalten:
Im Seitenlayout von Contao wird anschließend nur noch die erzeugte CSS-Datei eingebunden.
SCSS-Syntax und Sass-Kompatibilität
Welche SCSS-Funktionen verwendet werden können, hängt vom eingesetzten Sass-Compiler bzw. der verwendeten Sass-Implementierung ab.
Insbesondere moderne Dart-Sass-Funktionen wie
werden nicht von jeder PHP-basierten Sass-Implementierung unterstützt.
Falls beim Kompilieren beispielsweise folgende Meldung erscheint:
unterstützt der aktuell eingesetzte Compiler das Sass-Modulsystem mit @use bzw. @forward nicht.
In diesem Fall muss entweder:
- die SCSS-Struktur an die vom Compiler unterstützte Syntax angepasst werden, oder
- eine Sass-Implementierung verwendet werden, die das moderne Modulsystem unterstützt.
Dies ist keine Einschränkung von Contao selbst, sondern des jeweiligen Sass-Compilers.
Hinweise für produktive Projekte
Die generierte CSS-Datei sollte im Contao-Seitenlayout eingebunden werden – nicht die SCSS-Quelldatei.
SCSS-Dateien dienen damit ausschließlich als Entwicklungsquelle:
Dadurch muss im Frontend keine SCSS-Kompilierung während eines Seitenaufrufs stattfinden.
Es empfiehlt sich außerdem, generierte Source Maps nur dann produktiv bereitzustellen, wenn sie tatsächlich benötigt werden.
Dateirechte
Der PHP-/Webserver-Prozess benötigt Schreibrechte für das Verzeichnis der CSS-Zieldatei.
Kann eine Datei nicht erzeugt oder überschrieben werden, sollten daher insbesondere folgende Punkte geprüft werden:
- Existiert das Zielverzeichnis?
- Ist das Verzeichnis für PHP beschreibbar?
- Darf eine bereits vorhandene CSS-Datei überschrieben werden?
- Liegen Quelle und Ziel innerhalb der von Contao verwalteten bzw. erlaubten Verzeichnisse?
Projektstatus
Das Bundle befindet sich in aktiver Entwicklung.
Vor dem produktiven Einsatz empfiehlt es sich, die Kompilierung mit der im jeweiligen Projekt verwendeten SCSS-Struktur und Sass-Syntax zu testen.
Fehler melden
Fehler und Verbesserungsvorschläge können über die Issues des GitHub-Repositories gemeldet werden.
Bei Compiler-Fehlern sind insbesondere folgende Angaben hilfreich:
- Contao-Version
- PHP-Version
- Bundle-Version
- verwendete SCSS-Syntax
- vollständige Fehlermeldung
- möglichst kleines Beispiel, mit dem sich der Fehler reproduzieren lässt
Lizenz
Dieses Projekt ist unter der MIT-Lizenz veröffentlicht. Contao und verwendete Drittanbieter-Bibliotheken unterliegen ihren jeweiligen eigenen Lizenzen.
Entwicklung
Dieses Projekt wurde teilweise mit Unterstützung von KI-Werkzeugen entwickelt. KI-Unterstützung wurde insbesondere bei Code-Generierung, Review und Dokumentation eingesetzt. Konzeption, Integration, Tests und Freigabe erfolgen durch den Autor.
Autor
berecont
Contao Bundle zur komfortablen SCSS-zu-CSS-Kompilierung im Backend.
All versions of contao-scss-compiler-bundle with dependencies
contao/core-bundle Version ^5.3
contao/manager-bundle Version ^5.3
scssphp/scssphp Version ^1.12 || ^2.0