v1.0.1

Narzędzie CLI do kompilacji wielu plików SCSS do pojedynczego pliku CSS, aby uniknąć łączenia miliona plików CSS w projekcie. Compile SCSS wykorzystuje Click do skonstruowania swojego interfejsu CLI.

Instalacja

pip install compile_scss

Użycie

Run compile_scss

Jeśli compile_scss zostanie uruchomione bez żadnych opcji lub flag, Compile SCSS będzie szukać w katalogu głównym projektu pliku o nazwie compile_scss_config.json, który przechowuje obiekt JSON z predefiniowanymi wartościami konfiguracyjnymi użytkownika.

Jeśli plik konfiguracyjny zostanie znaleziony, Compile SCSS uruchomi się używając konfiguracji znalezionej w pliku JSON. Jeśli plik konfiguracyjny nie zostanie znaleziony, zostanie wywołany proces Read, Evaluate, Print, Loop (R.E.P.L.), a użytkownik będzie miał możliwość ustawienia nowych wartości konfiguracyjnych za pomocą serii monitów.

Options

--root <PROJECT_ROOT_DIRECTORY>

Opcja --root pozwala użytkownikowi określić katalog główny projektu. Compile SCSS przeszuka ten katalog w poszukiwaniu pliku compile_scss_config.json. >

Domyślną ścieżką do katalogu głównego jest ./, co przekłada się na dowolny katalog, z którego wywoływany jest compile_scss.

--set-config

Jeśli flaga --set-config jest obecna, konfiguracja R.E.P.L. zostanie domyślnie uruchomiona.

Jeśli znaleziono plik konfiguracyjny, użytkownik będzie miał możliwość albo utworzenia nowego pliku konfiguracyjnego, albo kontynuowania pracy z wartościami znalezionymi w pliku konfiguracyjnym.

Jeżeli nie znaleziono pliku konfiguracyjnego, użytkownik będzie miał możliwość utworzenia nowego pliku konfiguracyjnego.

--watch

Jeżeli flaga --watch jest obecna, Compile SCSS będzie obserwować katalog SCSS określony w pliku konfiguracyjnym pod kątem wszelkich zmian i odpowiednio zaktualizuje plik CSS.

Konfiguracja

Domyślnie, Compile SCSS będzie szukał w katalogu głównym projektu pliku o nazwie compile_scss_config.json. Plik ten musi być obecny i zawierać poprawny obiekt konfiguracyjny, aby Compile SCSS mógł zostać uruchomiony.

Plik konfiguracyjny musi zawierać pięć kluczy i odpowiadające im wartości:

• root – Katalog główny projektu. Domyślną wartością jest ./

• scss_dir – Katalog SCSS najwyższego poziomu dla projektu. Ten katalog może zawierać podkatalogi i tyle plików SCSS, ile potrzeba. Ścieżka scss_dir musi prowadzić do katalogu zawierającego co najmniej jeden plik SCSS, aby była poprawną ścieżką SCSS.

• css_dir – Katalog CSS zawierający główny plik CSS. To jest miejsce, gdzie Compile SCSS wygeneruje swój plik wyjściowy CSS.

• css_filename – Pożądana nazwa docelowego pliku CSS.

  Nazwa pliku nie może zawierać znaków specjalnych innych niż myślniki i podkreślniki. Rozszerzenie pliku musi być małe, ale nazwa pliku może zawierać duże litery.

  Zobacz poniższe przykłady poprawnych i niepoprawnych nazw plików.

• output_style – sass.compile() Libsass’ pozwala na kompilację wyjścia CSS w jednym z czterech stylów:

  • compact

  • compressed

  • expanded

  • nested

.

Prawidłowe i nieprawidłowe nazwy plików CSS

Prawidłowe

Nieprawidłowe

Przykładowy plik konfiguracyjny

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

Kompiluj SCSS jest wciąż w fazie rozwoju. Został przetestowany pomyślnie, ale nie w szerokim zakresie z:

• Zmienne
• @import statements
• Funkcje (podstawowe)
• Mieszaniny (podstawowe)

.