CSS (Sass) のコーディングルール #CSS #Sass version 4

2016/03/16 19:21 by zk33 zk33
  :追加された部分   :削除された部分
(差分が大きい場合、文字単位では表示しません)
#HTML #SCSS / #SASS の #コーディングルール
2016/3月現在の個人的(あるいはテンマド社の)CSS/SCSSコーディングについてのルール

# 目指すこと

* 開発時に「迷う」「考える」部分を極力減らしつつ、できるだけ一貫したCSSを書けるようにする
* 必要最小限のルールセットで、最大限の効果


# ルール

## 前提

### SASSではなく、SCSSの記法を使う

単純に学習コストが低く、JSライブラリ付属のCSSなど、既存のCSSなどもコピペで貼り付ければ済むので、取り込みやすいからです

## 命名規則

### IDを使用しない

他の場所でカスケードしてスタイルを上書きしようとした時に障害になるので、IDは一切使用しません。

### 初期化/リセット的なことをする部分以外で、タグに対してスタイル当てない

```scss:BAD  
.some-class ul{
  color:red;
}
```
```scss:GOOD 
.some-class-items{
  color:red;
}
```

面倒でも全部クラスを割り振ります。
例外として、たとえばMarkdownパーサが出力するHTMLなど、クラスの割り当てられない部分で、かつタグにスタイルを指定するのが妥当な部分は除きます。

タグの構造は制作していく中で「あ、やっぱりこっちのがいいかも」って変えることがよくあるので、その際に書き換えが発生しにくくするためです

### クラス名はハイフン区切りで全て小文字

大文字小文字を両方使って書く前提にすると、必ず大文字小文字のタイプミスでスタイルが当たらなくてうんうん悩む時間が発生するので、大文字は一切使いません。

### JSから使うクラスは「.x-」で始め、CSS側でそのクラスは絶対に使わない

JSで使っているクラスなので変更に注意が必要、ということを明示するために特別なクラスを指定します。
また、JSでのDOM操作と、CSSでのスタイル指定はできるかぎり切り離しておいたほうがよいので、「.x-」のついたクラスに対してスタイルを当てることは絶対にしないようにします。
後述の「.mode-」のついたクラスでコントロールします。

## JSで使うIDは「x」で始め、CSS側でそのIDは絶対に使わない

っていうかIDをそもそもCSSで書かないので関係ないといえばない。

### JSとのやりとりは「.mode-」というクラスで行う



## クラスのネストは2段階まで、を基本とする

## ファイル分け

### クラス名の接頭辞と、そのクラスの書かれたファイル名を一致させる

どのクラスがどのファイルに書かれているか、が瞬時にわかるようになります。
sourcemapなどに頼る必要が発生したら負けです。

なお、「_x.scss(あるいは_x-hoge.scss)」と「_mode.scss(あるいは_mode-hoge.scss)」は上述のJSとのやりとりで使う予約語的なものなので、作成禁止です。


### SASSの変数名はスネークケースで書く

単純に、SASSだと「-」(マイナス)が演算子としても機能するので、それとの区別をつけてるため、ハイフンは使いません。

### SASSの変数名も、ファイル名と一致させる

唯一の例外として、下記のとおり「$g_」で始まるものだけルールが違います

### SASSのグローバル変数は「_vars.scss」に書き、「$g_」で始める



## レスポンシブ対応

今のところ以下のようなコードでやる方向です。

```scss:_mixins.scss
```

※もっとスマートにわかりやすく書ける方法があれば知りたい

# その他

## BEMなどを使わない理由

ルールとして過剰に複雑なことと
モジュールのつもりで書いていたものの中のパーツをモジュール化したくなったり、








      

2016/3月現在の個人的(あるいはテンマド社の)CSS/SCSSコーディングについてのルール

目指すこと

  • 開発時に「迷う」「考える」部分を極力減らしつつ、できるだけ一貫したCSSを書けるようにする
  • 必要最小限のルールセットで、最大限の効果

ルール

前提

SASSではなく、SCSSの記法を使う

単純に学習コストが低く、JSライブラリ付属のCSSなど、既存のCSSなどもコピペで貼り付ければ済むので、取り込みやすいからです

命名規則

IDを使用しない

他の場所でカスケードしてスタイルを上書きしようとした時に障害になるので、IDは一切使用しません。

初期化/リセット的なことをする部分以外で、タグに対してスタイル当てない

.some-class ul{
  color:red;
}
BAD
.some-class-items{
  color:red;
}
GOOD

面倒でも全部クラスを割り振ります。
例外として、たとえばMarkdownパーサが出力するHTMLなど、クラスの割り当てられない部分で、かつタグにスタイルを指定するのが妥当な部分は除きます。

タグの構造は制作していく中で「あ、やっぱりこっちのがいいかも」って変えることがよくあるので、その際に書き換えが発生しにくくするためです

クラス名はハイフン区切りで全て小文字

大文字小文字を両方使って書く前提にすると、必ず大文字小文字のタイプミスでスタイルが当たらなくてうんうん悩む時間が発生するので、大文字は一切使いません。

JSから使うクラスは「.x-」で始め、CSS側でそのクラスは絶対に使わない

JSで使っているクラスなので変更に注意が必要、ということを明示するために特別なクラスを指定します。
また、JSでのDOM操作と、CSSでのスタイル指定はできるかぎり切り離しておいたほうがよいので、「.x-」のついたクラスに対してスタイルを当てることは絶対にしないようにします。
後述の「.mode-」のついたクラスでコントロールします。

JSで使うIDは「x」で始め、CSS側でそのIDは絶対に使わない

っていうかIDをそもそもCSSで書かないので関係ないといえばない。

JSとのやりとりは「.mode-」というクラスで行う

クラスのネストは2段階まで、を基本とする

ファイル分け

クラス名の接頭辞と、そのクラスの書かれたファイル名を一致させる

どのクラスがどのファイルに書かれているか、が瞬時にわかるようになります。
sourcemapなどに頼る必要が発生したら負けです。

なお、「_x.scss(あるいは_x-hoge.scss)」と「_mode.scss(あるいは_mode-hoge.scss)」は上述のJSとのやりとりで使う予約語的なものなので、作成禁止です。

SASSの変数名はスネークケースで書く

単純に、SASSだと「-」(マイナス)が演算子としても機能するので、それとの区別をつけてるため、ハイフンは使いません。

SASSの変数名も、ファイル名と一致させる

唯一の例外として、下記のとおり「$g_」で始まるものだけルールが違います

SASSのグローバル変数は「vars.scss」に書き、「$g」で始める

レスポンシブ対応

今のところ以下のようなコードでやる方向です。

_mixins.scss

※もっとスマートにわかりやすく書ける方法があれば知りたい

その他

BEMなどを使わない理由

ルールとして過剰に複雑なことと
モジュールのつもりで書いていたものの中のパーツをモジュール化したくなったり、