v1.0.1

Et CLI-værktøj til at kompilere flere SCSS-filer til en enkelt CSS-fil for at undgå at linke en million CSS-filer i et projekt. Compile SCSS anvender Click til at konstruere sin CLI-grænseflade.

Installation

pip install compile_scss

Brug

Kør compile_scss

Hvis compile_scss køres uden nogen indstillinger eller flag, vil Compile SCSS søge i projektets rodmappe efter en fil ved navn compile_scss_config.json, som gemmer et JSON-objekt med brugerens foruddefinerede konfigurationsværdier.

Hvis der findes en konfigurationsfil, kører Compile SCSS ved hjælp af den konfiguration, der findes i JSON-filen. Hvis der ikke findes nogen konfigurationsfil, udløses en Read, Evaluate, Print, Loop (R.E.P.P.L.), og brugeren har mulighed for at indstille nye konfigurationsværdier med en række prompt-meddelelser.

Options

--root <PROJECT_ROOT_DIRECTORY>

Med indstillingen --root kan brugeren angive sit projekts rodmappe. Compile SCSS vil søge i denne mappe efter compile_scss_config.json-filen. >

Standardvejen til rodmappen er ./, hvilket kan oversættes til den mappe, hvorfra compile_scss kaldes.

--set-config

Hvis --set-config-flaget er til stede, er konfigurationen R.E.P.L. som standard udløses.

Hvis der blev fundet en konfigurationsfil, har brugeren mulighed for enten at oprette en ny konfigurationsfil eller fortsætte med de værdier, der findes i konfigurationsfilen.

Hvis der ikke blev fundet nogen konfigurationsfil, vil brugeren have mulighed for at oprette en ny konfigurationsfil.

--watch

Hvis --watch-flaget er til stede, vil Compile SCSS observere den SCSS-mappe, der er angivet i konfigurationsfilen, for eventuelle ændringer og opdatere CSS-filen i overensstemmelse hermed.

Konfiguration

Som standard vil Compile SCSS kigge i projektets rodmappe efter en fil med navnet compile_scss_config.json. Filen skal være til stede og indeholde et gyldigt konfigurationsobjekt, for at Compile SCSS kan køre.

Konfigurationsfilen skal indeholde fem nøgler og tilsvarende værdier:

• root – Projektets rodmappe. Standardværdien for denne er ./

• scss_dir – Projektets SCSS-mappe på øverste niveau. Denne mappe kan indeholde undermapper og så mange SCSS-filer som nødvendigt. Stien scss_dir skal føre til en mappe, der indeholder mindst én SCSS-fil, for at være en gyldig SCSS-sti.

• css_dir – CSS-mappen, der indeholder den vigtigste CSS-fil. Det er her, Compile SCSS genererer sin CSS-uddatafil.

• css_filename – Det ønskede navn på CSS-målfilen.

  Filenavnet må ikke indeholde andre specialtegn end ikke-førende/afsluttende bindestreger eller understregninger. Filudvidelsen skal være med små bogstaver, men filnavnet kan indeholde store bogstaver.

  Se eksemplerne nedenfor for gyldige og ugyldige filnavne.

• output_style – Libsass’ sass.compile() gør det muligt at kompilere CSS-output i en af fire stilarter:

  • komprimeret

  • komprimeret

  • udvidet

  • nested

Valide og ugyldige CSS-filnavne

Valide

Invalid

Eksempel på konfigurationsfil

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

Compile SCSS er stadig under udvikling. Det er blevet testet med succes, men ikke omfattende med:

• Variabler
• @import statements
• Funktioner (grundlæggende)
• Mixins (grundlæggende)