Moduł do kompilacji SASS w locie i/lub zapisywania go do plików CSS przy użyciu node-sass

Cel tego projektu jest dwojaki:

  1. Dostarczenie biblioteki, która może kompilować pliki SASS przy ładowaniu strony, gdy używa NODE_ENV=development w celu zmniejszenia czasu rozwoju (on-the-fly)
  2. Umożliwienie kompilacji i zapisywania plików SASS do plików CSS na wszystkich innych środowiskach, gdy np, aplikacji lub za pomocą skryptu npm

Table of Contents

  • Wymagania
  • Instalacja
  • Przykład Usage
  • Usage
  • API
  • Release Notes
  • Maintainer

Wymagania

Ten moduł jest testowany z Node.js >= 10. Może działać z Node.js <= 9, ale nie jest testowany.

Install

npm install --save compile-sass

Example Usage

Poniżej znajduje się kilka przykładów, jak można go użyć w prawdziwej aplikacji:

  • Setup: Node.js / TypeScript
  • Konfiguracja: Node.js / TypeScript
  • Integracja z aplikacją: Node.js / TypeScript

Użycie

Do kompilacji w locie

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

Zwróć uwagę na compileSass.setup, który różni się od wariantu TypeScript!

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

Z opcjami

TypeScript
CommonJS

Zwróć uwagę na compileSass.setup, który różni się od odmiany TypeScript!

Opcje

Do kompilacji i zapisywania jako statyczne pliki CSS

API

compileSass()

Zwraca skompilowany SASS jako ciąg znaków.

compileSassAndSave()

Kompiluje podany plik SASS i zapisuje go w podanym katalogu.

compileSassAndSaveMultiple()

Kompiluje wiele plików SASS zdefiniowanych w opcji „files”. Wszystkie one muszą znajdować się w katalogu zdefiniowanym w opcji „sassPath”. Pliki CSS zostaną zapisane w katalogu zdefiniowanym w opcji „cssPath”.

setupCleanupOnExit()

Usuwa przekazany katalog, gdy aplikacja jest zamykana. Chodzi o to, aby przekazać katalog, w którym znajdują się skompilowane pliki CSS, aby mogły zostać usunięte, gdy aplikacja zostanie zamknięta i ponownie skompilowane, gdy aplikacja się uruchomi.

Release Notes

1.1.1

  • Uaktualnienia bezpieczeństwa

1.1.0

  • Dodaje funkcję rozwiązywania ścieżek przekazywanych do @import, które zaczynają się od ~
  • Aktualizacje bezpieczeństwa
  • Poprawia błąd, w którym opcje node-sass przekazywane podczas konfiguracji nie zawsze były używane

1.0.5

  • Zlikwidować krytyczną lukę w zabezpieczeniach

1.0.4

  • Uaktualnienia bezpieczeństwa
  • Uaktualnienie node-sass
  • Uaktualnienie hoek 5 do @hapi/hoek 9

1.0.3

  • Poprawić zepsute wydanie 1.0.2

1.0.2

  • Aktualizacje bezpieczeństwa
  • Update node-sass

1.0.1

  • Optymalizacja tego, co jest dołączane, gdy pakiet jest publikowany (koniec z plikami testowymi!)
  • Popraw kilka niedziałających linków w Readme
  • Załącz LICENSE

1.0.0.0

  • Całkowite przepisanie z TypeScript
  • Dołączenie typowania dla TypeScript
  • Dołączenie automatycznego testowania dla lepszej stabilności