compile-scss 1.0.1

, Author

v1.0.1

Egy CLI segédprogram több SCSS fájl egyetlen CSS fájlba történő összeállításához, hogy elkerüljük a millió CSS fájl összekapcsolását egy projekten belül. A Compile SCSS a Click-t használja a CLI-felületének felépítéséhez.

Telepítés

pip install compile_scss

Használat

Futtatás compile_scss

Ha a compile_scss mindenféle opció vagy flag nélkül fut, a Compile SCSS a projekt gyökérkönyvtárában keres egy compile_scss_config.json nevű fájlt, amely egy JSON objektumot tárol a felhasználó által előre megadott konfigurációs értékekkel.

Ha talál egy konfigurációs fájlt, a Compile SCSS a JSON fájlban található konfigurációval fog futni. Ha nem talál konfigurációs fájlt, akkor egy Read, Evaluate, Print, Loop (R.E.P.P.L.) lép működésbe, és a felhasználónak lehetősége lesz új konfigurációs értékeket beállítani egy sor felszólítással.

Options

--root <PROJECT_ROOT_DIRECTORY>

A --root opció lehetővé teszi a felhasználó számára, hogy megadja a projekt gyökérkönyvtárát. A Compile SCSS ebben a könyvtárban fogja keresni a compile_scss_config.json fájlt. >

A gyökérkönyvtár alapértelmezett elérési útja a ./, ami azt a könyvtárat jelenti, ahonnan a compile_scss meg van hívva.

--set-config

Ha a --set-config jelző jelen van, a konfiguráció R.E.P.L. alapértelmezés szerint elindul.

Ha találtak egy konfigurációs fájlt, a felhasználónak lehetősége van új konfigurációs fájlt létrehozni, vagy a konfigurációs fájlban talált értékekkel folytatni.

Ha nem találtak konfigurációs fájlt, a felhasználónak lehetősége lesz új konfigurációs fájl létrehozására.

--watch

Ha a --watch jelző jelen van, a Compile SCSS figyeli a konfigurációs fájlban megadott SCSS könyvtárat a változásokra, és ennek megfelelően frissíti a CSS fájlt.

Konfiguráció

A Compile SCSS alapértelmezés szerint a projekt gyökérkönyvtárában keresi a compile_scss_config.json nevű fájlt. A fájlnak jelen kell lennie, és érvényes konfigurációs objektumot kell tartalmaznia ahhoz, hogy a Compile SCSS fusson.

A konfigurációs fájlnak öt kulcsot és a megfelelő értékeket kell tartalmaznia:

  • root – A projekt gyökérkönyvtára. Ennek alapértelmezett értéke ./

  • scss_dir – A projekt legfelső szintű SCSS könyvtára. Ez a könyvtár tartalmazhat alkönyvtárakat és annyi SCSS-fájlt, amennyi szükséges. A scss_dir útvonalnak legalább egy SCSS-fájlt tartalmazó könyvtárba kell vezetnie ahhoz, hogy érvényes SCSS-útvonal legyen.

  • css_dir – A fő CSS-fájlt tartalmazó CSS könyvtár. A Compile SCSS itt fogja létrehozni a CSS kimeneti fájlját.

  • css_filename – A cél CSS-fájl kívánt neve.

    A fájlnév nem tartalmazhat speciális karaktereket, kivéve a nem vezető/követő kötőjeleket és az aláhúzásokat. A fájlkiterjesztésnek kisbetűsnek kell lennie, de a fájlnév tartalmazhat nagybetűket.

    Az érvényes és érvénytelen fájlneveket lásd az alábbi példákban.

  • output_style – A Libsass sass.compile() lehetővé teszi a CSS-kimenet összeállítását a négy stílus egyikében:

    • kompakt

    • kompresszált

    • expanded

    • nested

.

Érvényes és érvénytelen CSS fájlnevek

érvényes

érvénytelen

Példa konfigurációs fájl

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

A SCSS összeállítása még fejlesztés alatt áll. Sikeresen, de nem széleskörűen teszteltük:

  • Változók
  • @import utasítások
  • Funkciók (alap)
  • Mixinek (alap)

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.