compile-scss 1.0.1

, Author

v1.0.1

Ein CLI-Dienstprogramm zum Kompilieren mehrerer SCSS-Dateien in eine einzige CSS-Datei, um die Verknüpfung von einer Million CSS-Dateien in einem Projekt zu vermeiden. Compile SCSS verwendet Click, um seine CLI-Schnittstelle zu konstruieren.

Installation

pip install compile_scss

Benutzung

Ausführen compile_scss

Wenn compile_scss ohne Optionen oder Flags ausgeführt wird, sucht Compile SCSS im Stammverzeichnis des Projekts nach einer Datei namens compile_scss_config.json, die ein JSON-Objekt mit den vom Benutzer vordefinierten Konfigurationswerten speichert.

Wenn eine Konfigurationsdatei gefunden wird, wird Compile SCSS unter Verwendung der in der JSON-Datei gefundenen Konfiguration ausgeführt. Wenn keine Konfigurationsdatei gefunden wird, wird ein Read, Evaluate, Print, Loop (R.E.P.L.) ausgelöst und der Benutzer hat die Möglichkeit, neue Konfigurationswerte mit einer Reihe von Aufforderungen zu setzen.

Options

--root <PROJECT_ROOT_DIRECTORY>

Die --rootOption erlaubt es dem Benutzer, das Stammverzeichnis seines Projekts anzugeben. Compile SCSS sucht dann in diesem Verzeichnis nach der compile_scss_config.json-Datei. >

Der Standardpfad zum Stammverzeichnis ist ./, was dem Verzeichnis entspricht, aus dem compile_scss aufgerufen wird.

--set-config

Wenn das --set-config-Flag vorhanden ist, wird die Konfiguration R.E.P.L. standardmäßig ausgelöst.

Wurde eine Konfigurationsdatei gefunden, hat der Benutzer die Möglichkeit, entweder eine neue Konfigurationsdatei zu erstellen oder mit den in der Konfigurationsdatei gefundenen Werten fortzufahren.

Wenn keine Konfigurationsdatei gefunden wurde, hat der Benutzer die Möglichkeit, eine neue Konfigurationsdatei zu erstellen.

--watch

Wenn das Flag --watch vorhanden ist, beobachtet Compile SCSS das in der Konfigurationsdatei angegebene SCSS-Verzeichnis auf Änderungen und aktualisiert die CSS-Datei entsprechend.

Konfiguration

Standardmäßig sucht Compile SCSS im Stammverzeichnis des Projekts nach einer Datei namens compile_scss_config.json. Die Datei muss vorhanden sein und ein gültiges Konfigurationsobjekt enthalten, damit Compile SCSS ausgeführt werden kann.

Die Konfigurationsdatei muss fünf Schlüssel und entsprechende Werte enthalten:

  • root – Das Stammverzeichnis des Projekts. Der Standardwert hierfür ist ./

  • scss_dir – Das SCSS-Verzeichnis der obersten Ebene für das Projekt. Dieses Verzeichnis kann Unterverzeichnisse und so viele SCSS-Dateien wie nötig enthalten. Der scss_dir-Pfad muss zu einem Verzeichnis führen, das mindestens eine SCSS-Datei enthält, um ein gültiger SCSS-Pfad zu sein.

  • css_dir – Das CSS-Verzeichnis, das die Haupt-CSS-Datei enthält. Hier erzeugt Compile SCSS seine CSS-Ausgabedatei.

  • css_filename – Der gewünschte Name der CSS-Zieldatei.

    Der Dateiname darf keine anderen Sonderzeichen als nicht führende/abschließende Bindestriche oder Unterstriche enthalten. Die Dateierweiterung muss klein geschrieben werden, der Dateiname kann jedoch Großbuchstaben enthalten.

    Gültige und ungültige Dateinamen sind in den folgenden Beispielen aufgeführt.

  • output_style – Libsass‘ sass.compile() erlaubt es, die CSS-Ausgabe in einem von vier Stilen zu kompilieren:

    • kompakt

    • komprimiert

    • expandiert

    • verschachtelt

Gültige und ungültige CSS-Dateinamen

Gültig

Ungültig

Beispielkonfigurationsdatei

{ "root": ".", "scss_dir": "./static/scss", "css_dir": "./static/css", "css_filename": "index.css", "output_style": "expanded"}

Compile SCSS ist noch in der Entwicklung. Es wurde erfolgreich, aber nicht ausführlich getestet mit:

  • Variablen
  • @import-Anweisungen
  • Funktionen (basic)
  • Mixins (basic)

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.