v1.0.1
Una utilidad CLI para compilar múltiples archivos SCSS en un único archivo CSS para evitar enlazar un millón de archivos CSS dentro de un proyecto. Compilar SCSS utiliza Click para construir su interfaz CLI.
Instalación
pip install compile_scss
Uso
Ejecutar compile_scss
Si compile_scss
se ejecuta sin ninguna opción o bandera, Compilar SCSS buscará en el directorio raíz del proyecto un archivo llamado compile_scss_config.json
, que almacena un objeto JSON con los valores de configuración predefinidos por el usuario.
Si se encuentra un archivo de configuración, Compile SCSS se ejecutará utilizando la configuración encontrada en el archivo JSON. Si no se encuentra un archivo de configuración, se lanzará un Read, Evaluate, Print, Loop (R.E.P.L.) y el usuario tendrá la opción de establecer nuevos valores de configuración con una serie de indicaciones.
Options
--root <PROJECT_ROOT_DIRECTORY>
La opción
--root
permite al usuario especificar el directorio raíz de su proyecto. Compilar SCSS buscará en ese directorio el archivocompile_scss_config.json
. >La ruta por defecto al directorio raíz es
./
, que se traduce en cualquier directorio desde el que se llame acompile_scss
.
--set-config
Si la bandera
--set-config
está presente, la configuración R.E.P.L. se activará por defecto.Si se encontró un archivo de configuración, el usuario tendrá la opción de crear un nuevo archivo de configuración o continuar con los valores encontrados en el archivo de configuración.
Si no se encontró ningún archivo de configuración, el usuario tendrá la opción de crear un nuevo archivo de configuración.
--watch
Si la bandera
--watch
está presente, Compile SCSS observará el directorio SCSS especificado en el archivo de configuración para cualquier cambio y actualizará el archivo CSS en consecuencia.
Configuración
Por defecto, Compile SCSS buscará en el directorio raíz del proyecto un archivo llamado compile_scss_config.json
. El archivo debe estar presente y contener un objeto de configuración válido para que Compile SCSS se ejecute.
El archivo de configuración debe contener cinco claves y sus valores correspondientes:
-
root – El directorio raíz del proyecto. El valor por defecto es
./
-
scss_dir – El directorio SCSS de nivel superior para el proyecto. Este directorio puede contener subdirectorios y tantos archivos SCSS como sea necesario. La ruta
scss_dir
debe conducir a un directorio que contenga al menos un archivo SCSS para que sea una ruta SCSS válida. -
css_dir – El directorio CSS que contiene el archivo CSS principal. Aquí es donde Compile SCSS generará su archivo de salida CSS.
-
css_filename – El nombre deseado del archivo CSS de destino.
El nombre del archivo no debe contener caracteres especiales que no sean guiones o guiones bajos. La extensión del archivo debe estar en minúsculas, pero el nombre del archivo puede contener letras mayúsculas.
Consulte los ejemplos siguientes para conocer los nombres de archivo válidos e inválidos.
-
output_style – El
sass.compile()
de Libsass permite compilar la salida CSS en uno de los cuatro estilos:-
compacto
-
comprimido
-
expandido
-
anidado
-
.
Nombres de archivos CSS válidos e inválidos
Válido
Inválido
Fichero de configuración de ejemplo
{ "root": ".", "scss_dir": "./static/scss", "css_dir": "./static/css", "css_filename": "index.css", "output_style": "expanded"}
Compilar SCSS está todavía en desarrollo. Se ha probado con éxito pero no de forma exhaustiva con:
- Variables
- @import statements
- Funciones (básicas)
- Mixins (básicos)