v1.0.1

Een CLI hulpprogramma voor het compileren van meerdere SCSS bestanden in een enkel CSS bestand om het linken van een miljoen CSS bestanden binnen een project te vermijden. Compile SCSS maakt gebruik van Click om zijn CLI interface te construeren.

Installatie

pip install compile_scss

Gebruik

Uitvoeren compile_scss

Als compile_scss wordt uitgevoerd zonder opties of vlaggen, zoekt Compile SCSS in de hoofdmap van het project naar een bestand met de naam compile_scss_config.json, waarin een JSON-object wordt opgeslagen met de door de gebruiker vooraf gedefinieerde configuratiewaarden.

Als een configuratiebestand wordt gevonden, zal Compile SCSS de configuratie uit het JSON bestand gebruiken. Als er geen configuratiebestand wordt gevonden, wordt er een R.E.P.L. (Read, Evaluate, Print, Loop) gestart en heeft de gebruiker de mogelijkheid om nieuwe configuratiewaarden in te stellen met een reeks prompts.

Options

--root <PROJECT_ROOT_DIRECTORY>

De --root optie stelt de gebruiker in staat om de root directory van het project op te geven. Compile SCSS zal in die directory zoeken naar het compile_scss_config.json-bestand. >

Het standaardpad naar de hoofddirectory is ./, wat overeenkomt met de directory van waaruit compile_scss wordt aangeroepen.

--set-config

Als de vlag --set-config aanwezig is, wordt de configuratie R.E.P.L. standaard worden geactiveerd.

Als een configuratiebestand is gevonden, heeft de gebruiker de keuze om ofwel een nieuw configuratiebestand te maken of door te gaan met de waarden die in het configuratiebestand zijn gevonden.

Als er geen configuratiebestand is gevonden, kan de gebruiker een nieuw configuratiebestand maken.

--watch

Als de vlag --watch aanwezig is, zal Compile SCSS de SCSS-directory die in het configuratiebestand is opgegeven, observeren op eventuele wijzigingen en het CSS-bestand dienovereenkomstig bijwerken.

Configuratie

In de standaardinstelling zoekt Compile SCSS in de hoofdmap van het project naar een bestand met de naam compile_scss_config.json. Het bestand moet aanwezig zijn en een geldig configuratie-object bevatten om Compile SCSS te kunnen uitvoeren.

Het configuratiebestand moet vijf sleutels en bijbehorende waarden bevatten:

• root – De hoofddirectory van het project. De standaardwaarde hiervoor is ./

• scss_dir – De SCSS-directory op het hoogste niveau voor het project. Deze map kan submappen en zo veel SCSS-bestanden bevatten als nodig is. Het scss_dir-pad moet naar een map leiden die ten minste één SCSS-bestand bevat om een geldig SCSS-pad te zijn.

• css_dir – De CSS-directory die het belangrijkste CSS-bestand bevat. Dit is waar Compile SCSS het CSS uitvoerbestand zal genereren.

• css_filename – De gewenste naam van het CSS doelbestand.

  De bestandsnaam mag geen speciale tekens bevatten, behalve niet-leidende streepjes of underscores. De bestandsextensie moet kleine letters zijn, maar de bestandsnaam mag hoofdletters bevatten.

  Zie de voorbeelden hieronder voor geldige en ongeldige bestandsnamen.

• output_style – Met Libsass’ sass.compile() kan CSS-uitvoer in een van vier stijlen worden gecompileerd:

  • compact

  • gecomprimeerd

  • uitgebreid

  • nested

Valide en ongeldige CSS bestandsnamen

Valid

Invalid

Exemplaar configuratiebestand

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

Compile SCSS is nog in ontwikkeling. Het is succesvol maar niet uitgebreid getest met:

• Variabelen
• @import statements
• Functies (basis)
• Mixins (basis)