Een module om SASS on-the-fly te compileren en/of op te slaan in CSS-bestanden met behulp van node-sass

Het doel van dit project is tweeledig:

  1. Een bibliotheek leveren die SASS-bestanden kan compileren bij het laden van de pagina wanneer NODE_ENV=development wordt gebruikt om de ontwikkelingstijd te verkorten (on-the-fly)
  2. Het compileren en opslaan van SASS-bestanden naar CSS-bestanden mogelijk maken op alle andere omgevingen wanneer, bijvoorbeeld, de applicatie start of met een npm script

Inhoudsopgave

  • Vereisten
  • Installatie
  • Voorbeeld Gebruik
  • Usage
  • API
  • Release notes
  • Maintainer

Eisen

Deze module is getest met Node.js >= 10. Het zou kunnen werken met Node.js <= 9, maar is niet getest.

Installeren

npm install --save compile-sass

Voorbeeldgebruik

Hieronder volgen een paar voorbeelden van hoe u het in een echte applicatie kunt gebruiken:

  • Setup: Node.js / TypeScript
  • Configuratie: Node.js / TypeScript
  • Integratie in de app: Node.js / TypeScript

Gebruik

Voor on-the-fly compileren

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

Let op de compileSass.setup die verschilt van de TypeScript-variant!

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

Met opties

TypeScript
CommonJS

Let op de compileSass.setup die verschilt van de TypeScript-variant!

Opties

Voor het compileren en opslaan als statische CSS bestanden

API

compileSass()

Retourneert de gecompileerde SASS als een string.

compileSassAndSave()

Compileert het gegeven SASS-bestand en slaat het op in de gegeven directory.

compileSassAndSaveMultiple()

Compileert meerdere SASS-bestanden die in de “bestanden”-optie zijn gedefinieerd. Ze moeten allemaal in de map staan die is gedefinieerd in de “sassPath” optie. De CSS bestanden worden opgeslagen in de directory die is gedefinieerd in de “cssPath” optie.

setupCleanupOnExit()

Verwijdert de doorgegeven directory wanneer de app wordt verlaten. Het idee is om de directory door te geven waar uw gecompileerde CSS-bestanden staan, zodat ze kunnen worden verwijderd wanneer de app wordt verlaten en opnieuw worden gecompileerd wanneer de app start.

Release Notes

1.1.1

  • Veiligheidsupdates

1.1.0

  • Een functie toevoegen om paden op te lossen die zijn doorgegeven aan @import en beginnen met ~
  • Veiligheidsupdates
  • Een bug oplossen waarbij de node-sass opties die zijn doorgegeven tijdens de setup niet altijd werden gebruikt

1.0.5

  • Een kritieke beveiligingskwetsbaarheid verhelpen

1.0.4

  • Beveiligingsupdates
  • Update node-sass
  • Update hoek 5 naar @hapi/hoek 9

1.0.3

  • De kapotte 1.0.2 release

1.0.2

  • Veiligheidsupdates
  • Update node-sass

1.0.1

  • Optimaliseer wat wordt meegeleverd als het pakket wordt gepubliceerd (geen test bestanden meer!)
  • Verhelp een paar gebroken links in de Readme
  • Inclusief LICENSE

1.0.0

  • Volledige herschrijving met TypeScript
  • Inclusief typings voor TypeScript
  • Inclusief geautomatiseerd testen voor betere stabiliteit