Un módulo para compilar SASS al vuelo y/o guardarlo en archivos CSS usando node-sass

El objetivo de este proyecto es doble:

  1. Proporcionar una biblioteca que pueda compilar archivos SASS en la carga de la página cuando se utiliza NODE_ENV=development con el fin de reducir el tiempo de desarrollo (on-the-fly)
  2. Para permitir la compilación y el ahorro de archivos SASS a los archivos CSS en todos los demás entornos cuando, por ejemplo, la aplicación se inicia o con un script npm

Tabla de contenidos

  • Requisitos
  • Instalación
  • Ejemplo Uso
  • Uso
  • API
  • Notas de la versión
  • Mantenedor

Requisitos

Este módulo está probado con Node.js >= 10. Podría funcionar con Node.js <= 9, pero no está probado.

Instalar

npm install --save compile-sass

Ejemplo de uso

Los siguientes son un par de ejemplos de cómo se puede utilizar en una aplicación de la vida real:

  • Configuración: Node.js / TypeScript
  • Configuración: Node.js / TypeScript
  • Integración en la app: Node.js / TypeScript

Uso

Para la compilación sobre la marcha

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

¡Atención al compileSass.setup que difiere de la variación de TypeScript!

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

Con opciones

TypeScript
CommonJS

¡Atención al compileSass.setup que difiere de la variación de TypeScript!

Opciones

Para compilar y guardar como archivos CSS estáticos

API

compileSass()

Devuelve el SASS compilado como una cadena.

compileSassAndSave()

Compila el archivo SASS dado y lo guarda en el directorio dado.

compileSassAndSaveMultiple()

Compila múltiples archivos SASS definidos en la opción «files». Todos ellos deben estar ubicados en el directorio definido en la opción «sassPath». Los archivos CSS se guardarán en el directorio definido en la opción «cssPath».

setupCleanupOnExit()

Elimina el directorio pasado cuando se sale de la aplicación. La idea es pasar el directorio donde están tus archivos CSS compilados, para que puedan ser borrados cuando se salga de la aplicación y recompilados cuando ésta se inicie.

Notas de la versión

1.1.1

  • Actualizaciones de seguridad

1.1.0

  • Añadir una función para resolver las rutas pasadas a @import que empiezan por ~
  • Actualizaciones de seguridad
  • Corregir un error por el que no siempre se utilizaban las opciones node-sass pasadas durante la configuración

1.0.5

  • Corregir una vulnerabilidad de seguridad crítica

1.0.4

  • Actualizaciones de seguridad
  • Actualizar node-sass
  • Actualizar hoek 5 a @hapi/hoek 9

1.0.3

  • Corregir la versión rota 1.0.2

1.0.2

  • Actualizaciones de seguridad
  • Actualizar node-sass

1.0.1

  • Optimizar lo que se incluye al publicar el paquete (¡no más archivos de prueba!)
  • Corregir un par de enlaces rotos en el Readme
  • Incluir LICENSE

1.0.0

  • Realizar una reescritura completa con TypeScript
  • Incluir tipificaciones para TypeScript
  • Incluir pruebas automatizadas para mejorar la estabilidad