Ein Modul, um SASS on-the-fly zu kompilieren und/oder in CSS-Dateien zu speichern, wenn node-sass

Das Ziel dieses Projekts ist ein zweifaches:

  1. Eine Bibliothek bereitzustellen, die SASS-Dateien beim Laden einer Seite kompilieren kann, wenn NODE_ENV=development verwendet wird, um die Entwicklungszeit zu reduzieren (on-the-fly)
  2. Die Kompilierung und Speicherung von SASS-Dateien in CSS-Dateien in allen anderen Umgebungen zu ermöglichen, wenn z.B., die Anwendung startet oder mit einem npm-Skript

Inhaltsverzeichnis

  • Anforderungen
  • Installation
  • Beispiel Verwendung
  • Anwendung
  • API
  • Versionshinweise
  • Maintainer

Anforderungen

Dieses Modul wird mit Node.js >= 10. Es könnte auch mit Node.js <= 9 funktionieren, ist aber nicht getestet.

Installieren

npm install --save compile-sass

Anwendungsbeispiele

Im Folgenden finden Sie einige Beispiele, wie Sie es in einer realen Anwendung verwenden können:

  • Setup: Node.js / TypeScript
  • Konfiguration: Node.js / TypeScript
  • Einbindung in die App: Node.js / TypeScript

Nutzung

Für on-the-fly Kompilierung

TypeScript
import compileSass from 'compile-sass';
app.use('/css/:cssName', compileSass());
CommonJS

Achtung auf die compileSass.setup, die sich von der TypeScript Variante unterscheidet!

const compileSass = require('compile-sass');
app.use('/css/:cssName', compileSass.setup());

Mit Optionen

TypeScript
CommonJS

Achtet auf die compileSass.setup, die sich von der TypeScript-Variante unterscheidet!

Optionen

Zum Kompilieren und Speichern als statische CSS-Dateien

API

compileSass()

Gibt das kompilierte SASS als String zurück.

compileSassAndSave()

Kompiliert die angegebene SASS-Datei und speichert sie im angegebenen Verzeichnis.

compileSassAndSaveMultiple()

Kompiliert mehrere in der Option „files“ definierte SASS-Dateien. Sie müssen sich alle in dem in der Option „sassPath“ definierten Verzeichnis befinden. Die CSS-Dateien werden in dem in der Option „cssPath“ definierten Verzeichnis gespeichert.

setupCleanupOnExit()

Löscht das übergebene Verzeichnis, wenn die Anwendung beendet wird. Die Idee ist, das Verzeichnis zu übergeben, in dem sich die kompilierten CSS-Dateien befinden, so dass sie beim Beenden der App gelöscht und beim Start der App neu kompiliert werden können.

Versionshinweise

1.1.1

  • Sicherheitsupdates

1.1.0

  • Funktion hinzufügen, um an @import übergebene Pfade aufzulösen, die mit ~
  • Sicherheitsupdates
  • Behebt einen Fehler, bei dem die während der Installation übergebenen node-sass Optionen nicht immer verwendet wurden

1.0.5

  • Behebt eine kritische Sicherheitslücke

1.0.4

  • Sicherheitsupdates
  • Update node-sass
  • Update hoek 5 auf @hapi/hoek 9

1.0.3

  • Fixieren der fehlerhaften Version 1.0.2

1.0.2

  • Sicherheitsupdates
  • Update node-sass

1.0.1

  • Optimierung dessen, was bei der Veröffentlichung des Pakets enthalten ist (keine Testdateien mehr!)
  • Fixierung einiger defekter Links in der Readme
  • Einfügen von LICENSE

1.0.0

  • Komplette Neuschreibung mit TypeScript
  • Typisierungen für TypeScript einfügen
  • Automatisierte Tests für bessere Stabilität einfügen