v1.0.1

Ett CLI-verktyg för att kompilera flera SCSS-filer till en enda CSS-fil för att undvika att länka en miljon CSS-filer i ett projekt. Compile SCSS använder Click för att konstruera sitt CLI-gränssnitt.

Installation

pip install compile_scss

Användning

Kör compile_scss

Om compile_scss körs utan några alternativ eller flaggor, kommer Compile SCSS att leta i projektets rotkatalog efter en fil som heter compile_scss_config.json, som lagrar ett JSON-objekt med användarens fördefinierade konfigurationsvärden.

Om en konfigurationsfil hittas kommer Compile SCSS att köras med hjälp av den konfiguration som finns i JSON-filen. Om ingen konfigurationsfil hittas utlöses en Read, Evaluate, Print, Loop (R.E.P.L.) och användaren har möjlighet att ställa in nya konfigurationsvärden med hjälp av en rad uppmaningar.

Options

--root <PROJECT_ROOT_DIRECTORY>

Med alternativet --root kan användaren ange sitt projekts rotkatalog. Compile SCSS söker i den katalogen efter filen compile_scss_config.json. >

Standardvägen till rotkatalogen är ./, vilket översätts till vilken katalog som helst från vilken compile_scss anropas.

--set-config

Om flaggan --set-config är närvarande, är konfigurationen R.E.P.L. utlöses som standard.

Om en konfigurationsfil hittades har användaren möjlighet att antingen skapa en ny konfigurationsfil eller fortsätta med de värden som finns i konfigurationsfilen.

Om ingen konfigurationsfil hittades har användaren möjlighet att skapa en ny konfigurationsfil.

--watch

Om flaggan --watch finns kommer Compile SCSS att observera SCSS-katalogen som anges i konfigurationsfilen för att se om den har ändrats och uppdatera CSS-filen därefter.

Konfiguration

Som standard letar Compile SCSS i projektets rotkatalog efter en fil som heter compile_scss_config.json. Filen måste finnas och innehålla ett giltigt konfigurationsobjekt för att Compile SCSS ska kunna köras.

Konfigurationsfilen måste innehålla fem nycklar och motsvarande värden:

• root – Projektets rotkatalog. Standardvärdet för detta är ./

• scss_dir – Projektets SCSS-katalog på högsta nivå. Denna katalog kan innehålla underkataloger och så många SCSS-filer som behövs. Sökvägen scss_dir måste leda till en katalog som innehåller minst en SCSS-fil för att vara en giltig SCSS-sökväg.

• css_dir – CSS-katalogen som innehåller den huvudsakliga CSS-filen. Det är här som Compile SCSS kommer att generera sin CSS-utdatafil.

• css_filename – Det önskade namnet på mål-CSS-filen.

  Filennamnet får inte innehålla andra specialtecken än icke-ledande/slutande bindestreck eller understreck. Filtillägget måste vara med små bokstäver, men filnamnet kan innehålla stora bokstäver.

  Se exemplen nedan för giltiga och ogiltiga filnamn.

• output_style – Libsass’ sass.compile() tillåter att CSS-utdata kompileras i en av fyra stilar:

  • kompakt

  • komprimerad

  • utökad

  • nested

Valida och ogiltiga CSS-filnamn

Valid

Invalid

Exempel på konfigurationsfil

{ "root": ".", "scss_dir": "./static/scss", "css_dir": "./static/css", "css_filename": "index.css", "output_style": "expanded"}

Compile SCSS är fortfarande under utveckling. Den har testats framgångsrikt men inte i stor utsträckning med:

• Variabler
• @import statements
• Funktioner (basic)
• Mixins (basic)