Sass Klasör yapısı

2 Eylül 2015

Bir önceki yazımda Sass’a giriş yapmıştık. Bu makale de klasör yapımızın Sass sonrası nasıl olması gerektiğini gösterelim.

Klasör yapısını baştan ayarlamak her zaman iyidir. Her ne kadar ben burada bir yapı sunsam da klasör yapısı geliştiricinin kendi çalışma şartlarına göre esnetip yenilemesi gerekir.

CSS ile kod yazarken dosyaların çok fazla sayıda olması hızı azaltacağı için (HTTP isteklerinin çoğalmasından dolayı) tercih edilmezdi. Ancak Sass ve bezer sistemler derlenip tek CSS çıktısı verdiği için her mantıksal bölüm için bir dosya oluşturmak gerekir. Ayrıca bu dosyaları belirlenen klasörlere taşımak büyük projeler için düzen sağlar.

Kalsör yapısına geçmeden önce CSS’den de bildiğimiz import kuralına değinelim.

Sass’da @import kullanımı

CSS’de de diğer css dosyalarını içeri aktarmak için kullandığımız bu yöntem benzer amaçla ve bazı artı eklemelerle Sass’da da var. CSS’de @import yavaşlığa neden olduğundan dolayı pek tercih edilmezdi. Ancak bu sorunlar Sass’ta olmadığı için burada kullanmakta bir mahsur yok.

Sass import’ta dosya isminin tamamını yazmaya gerek yoktur. Örneğin main.sass dosyasını import ederken

@import "main";

yazmak yeterlidir. .sass / .scss uzantısını yazmaya gerek yok.

Kısmi (partial) Sass dosyaları

Ben Türkçeye kısmi olarak çevirdiğim partial Sass dosyalarını şöyle açıklayabiliriz; Bazı Sass dosyalarının CSS’e çevrilmesine gerek yoktur, diğer Sass dosylarına hizmet eder. Örneğin değişkenler, mixinler vs. Bu dosyalar kısmen derlenir. Diğer Sass dosyaları bu dosyalardaki bilgileri kullanır, ama bu dosyalardaki Sass kodu CSS’e çevrilmez. Kısmı Sass dosyaları alt çizgili ( _ ) ile başlamalıdır. Örnek _variables.sass

$base-font-family: Gibson, Arial, sans-serif;
$base-font-size:   14px;

$spacing-unit:      30px;
$text-color:        #111111;
...

Şeklindeki değişken tanımladığımız Sass dosyasını CSS’e çevirmemiz pek anlam ifade etmez. Ancak bu değişkenleri diğer Sass dosyaları kullanır.

Kısmi Sass dosyalarının import edilirken alt çizginin yazılmasına gerek yoktur.

@import "variables";

Bu ekleme sonucunda Sass derlemesi ile derlediğimizde variables.css dosyası çıkarmaz. Ama biz home.sass dosyamızda $text-color değişkenini kullanabiliriz.

Klasör yapısı

Yaptığım uygulamalardan ve kaynaklar kısmındaki yazıları inceledikten sonra proje boyutlarına göre klasör yapısını oluşturmanın faydalı olacağını düşündüm. Küçük projede klasör yapısı oldukça basit tutulabilecekken, orta halli ve büyük projelerde daha kapsamlı bir klasör yapısının tercih edilmesi önemlidir.

Küçük projeler

_base.sass 
_layout.sass    
home.sass
about-club.sass
join-us.sass

Küçük projelerde klasörlere gerek yok bence. Ortak dosyalar kısmi Sass olarak adlandırılırken (_base ve _layout) her sayfanın farklı Sass dosyaları olabilir.

base.sass: Bu dosya değişkenleri, mixinleri, sıfırlama kodlarını, sprite ve tipografik tanımları içerir. Dosya içinde yorum satırı ile bu bölümler ayrılabilir.

layout.sass: Bu dosya sayfa yapısını oluşturan ana yapıların ve alt yapıların kodlarını içerir. Üst alan (header), alt alan (footer), sol ve/veya sağ alan (side) ve içerik kapsayıcısını içerir. Ayrıca bu alanlar içinde kullanılan küçük yapısal alanlarıda içerir. Menüler, açılır kutular (modal, lightbox), hiyerarşik yerimi (breadcrumb), sayfalama butonları vs.

Sayfalar: Anasayfa ve alt sayfa için ayrı sass dosyaları. Çıktıları ayrı ayrı her sayfaya eklemek mantıklı.

Orta ve büyük çaplı projeler

Genelde projeler bu kategoriye giriyor. Küçük diye başlayan bir çok proje zamanla orta veya büyük ölçekli bir projeye dönüşebiliyor. Kod düzenini sağlamak için her mantıksal alan ayrı bir Sass dosyası olarak kullanmakta yarar var. Benim eriştiğim son yapı aşağıdaki gibidir.

./base
|-- _fonts.sass
|-- _mixins.sass
|-- _reset.sass
|-- _sprites.sass
|-- _variables.sass

./components
|-- _modal.sass
|-- _navigation.sass

./layout
|-- _footer.sass
|-- _header.sass
|-- _layout.sass

./pages
|-- _home.sass
|-- _about.sass
|-- _join-us.sass
|-- _offers.sass

./vendors
|-- _colorpicker.sass
|-- _jquery.ui.core.sass
|-- _swiper.sass

main.sass

Küçük projelerde dosyalar içinde birleştirdiğimiz birimleri tek tek ayrı sass dosyası olarak oluştururuz. Ayrıca bunların dışında bir iki klasörde daha eklememiz gerekti.

base klasörü: Değişken, mixin, renk ve yazı tipi gibi genel tanımların ve sıfırlama dosyasını içeren klasördür.

layout klasörü : Ana yapıyı oluşturuan dosyaları içerir. Örneğin header, footer, sidebar vs.

components klasörü : Ana yapı dışında kalan küçük yapıları içeren klasördür. Kullanıcı arayüzü (UI) öğelerini içeren sass dosyaları vardır. Örneğin, modal, lightbox, breadcrumb vs.

pages: Sayfaların her biri için oluşturulan sayfaya özel kodların bulunduğu sass dosyaları içerir. Örneğin anasayfa (home.sass), hakkımızda, iletişim vs.

vendors: Kullandığımız eklentilerin sass dosyalarını koyduğumuz klasör. Burada şöyle bir durum var. Eğer eklentileri bower ile ekliyorsak eklentileri _bower_components içindeki CSS dosyasını değiştirmeden kendi projemizde eklentinin CSS’lerini ezdiğimiz dosyayı barandırmak mantıklı olacaktır.

main.sass: Yukarıdaki tüm dosyaları içeren ana dosyadır. Bu dosya derlenerek tek bir css dosyasını oluşturur.

Projeye göre bu klasör sayısı değişebilir. İlgili projedeki durumlara göre klasör açılabilir ve silinebilir. Zamanla en iyi klasör yapınızı bulacağınız düşünüyorum.

main.sass dosyamız aşağıdaki gibi olacaktır.

@import "base/variables";
@import "base/mixins";
@import "base/reset";
@import "base/sprites";
@import "base/fonts";

@import "layout/layout";
@import "layout/header";
@import "layout/footer";

@import "components/modal";
@import "components/navigation";
@import "components/top_navigation";

@import "vendors/colorpicker";
@import "vendors/jquery.ui.core";
@import "vendors/swiper";
    
@import "pages/home";
@import "pages/offers-detail";
@import "pages/about";
@import "pages/join-us";
@import "pages/notifications";

Dikkat ettiyseniz .sass uzantılarını ve alt çizgileri (_) yazmadık. Sizde yorum kısmında kendi klasör yapınızı paylaşırsanız bir birimizden alabilecğeimiz yapıları kopyalayarak daha iyiye ulaşabiliriz.

Kalın sağlıcakla.

Kaynaklar

Sublime Text'te dosya tipine göre hızlı erişim

Son haftalarda Visual Studio Code ile kod yazıyorum. Güzel yanları var ama Sublime Text'in hızını bulamadım. Henüz Sublime'a geri dönmüş ...… Devamını oku

Responsive design patterns principles

13 January 2017 tarihinde yayınlandı.

jQuery DOM manipülasyonu metotlarında callback kullanmak

12 January 2017 tarihinde yayınlandı.