【GatsbyJS製ブログ】SCSS & CSS Modulesで快適CSS開発環境を作る

ようやく開発環境が整ってきましたが、まだまだ快適開発環境への欲は尽きません。ということで、Gatsby製ブログをカスタマイズする記事第3弾は、以前より興味津々だったSCSSとCSS Modulesを使ってSCSSをブログに当てていきたいと思います。

Gatsbyで実際に運用しているブログはこちらです。ぜひ、のぞいてみてください!

この記事はこんな人にオススメ
  • GatsbyでSCSSを便利に使いたい!
  • CSS Modulesっていうのがあるらしいけど何?美味しいの?
目次

SCSSとは

SCSSとは、簡単に言うとCSSを管理しやすい形で書けるようにした構文です。以下のようなメリットがあります。

  • 入れ子で書けるので、「こいつの子要素になぜこんなスタイルが効いてるんだ!」と迷子探しする必要がなくなる。
  • 変数を利用できる。
  • 四則演算、関数利用ができる。
  • ミックスイン、継承ができる。

一方、デメリットは

  • コンパイルが必要になる。

くらいでしょうか?上記であげた変数、四則演算などを利用するための学習コストはかかりますが、それ以上に管理コスト削減のメリットが遥かに大きいと思います。

「SCSSってなに?」という人は、以下のリンクで具体例と一緒に説明しています。

CSS Modulesとは

CSSをベタ書きした経験がある人はわかると思いますが、クラス名を付けるときにかなり大変な思いをします。特に私は「とりあえずやってみよう!」タイプで、以前HTMLとCSSをベタ書きしてブログを作るということをしていたのですが(当然、PHPでページネーションを実装するあたりで面倒になりWordPressに切り替えましたが)、当時面倒だなぁと思っていたのが正にこれでした。

「タイトルにスタイルを適応したいけれど、.titleは使ってるなぁ。.article-title?いや、これもさっき使ったか。.card-article-title?くらいか?まぁこれなら大丈夫か。他で使ってなかったよな?クラス名なげぇなぁ…。」

これが非常に面倒でした。命名規則とかも勉強したのですが、あまり根本的な解決になってないような気がして結局自分が付けたいようにクラス名を付けていました。

前置きが長くなりましたが、CSS Modulesとは、部品ごとにCSSを当てる、というコンセプトで設計されたものです。ファイル名を「***.module.css」(***は当てたい部品の名前)として作成し、JSファイルの方でインポートしてやれば、そのJSファイルにだけCSSが当たるという簡単&管理しやすい書き方になります。

試しに、以下の図のようにヘッダーとフッターに同じクラス名を宣言してみます。

headerとfooterに同じクラス名を指定してみる

結果は次のようになります。

それぞれのパーツ毎にCSSが適応されている

確かに同じ「titleText」というクラス名を宣言していますが、import文で該当のCSSファイルを読み込むことで、そのCSSファイルにあるクラスの設定だけが当たっていることがわかります。これで、ファイルさえ分けてしまえばクラス名の被りを気にせずに宣言し放題です。

クマ

パーツ毎にJSファイルとCSSをセットで作成して管理できるので、わかりやすい!便利!

余談①

公式docを読んでいたら、「cssは普通kebab case(例、.title-textのようにハイフンで繋ぐ)だけど、classNameの方は普通camel case(例、titleTextのように単語の区切りを大文字にする)で書くだろ?でもGatsbyのCSS Modulesはそこを上手いこと変換してくれるんだぜ?」(意訳)と書いていたので試してみました(上の図ではその形で書いています。JSファイルとCSSファイルでクラス名の形が違っているのが確認できます)。確かに読み込めるんですが、一つずつクラスを読まないといけないのですごく面倒です。2度と使わないと誓いました。代わりに次のようにして読み込むと楽ちんです。

import styles from '../styles/header.modules.css'  //stylesとしてCSSの全てのクラスを読み込む
…
<div className={styles.title}>  //styles.(クラス名)でCSSの方のクラス指定をする
 …
</div>

余談②

上の図ではCSSファイルをインポートしていましたが、次に紹介するSCSSをインポートしても大丈夫でした。

import styles from '../styles/header.modules.scss'  //SCSSファイルでも大丈夫

BearFruitのマスコットキャラ「クマ」がLINEスタンプになりました!

プログラマーの心に刺さる、「プログラミングあるある」。毎日使いたくなること間違いなし!

GatsbyでSCSS&CSS Modulesを利用できる環境を作る

Gatsbyでは、デフォルトでCSS Modulesが利用できるので、実質Sass(SCSS)が実行できる環境を作ればよいです。「node-sass」「sass」と「gatsby-plugin-sass」のプラグインで簡単にSass環境を構築できます。ターミナルで以下のコマンドを実行。

$ npm install --save sass gatsby-plugin-sass
クマ

npmでインストールしたけど、「yarn add」でも大丈夫。

※ 2022年4月3日追記

私が環境構築したときには問題なかったのですが、

クマ

ブログネタ用にGatsbyブログを一つ立ち上げよう!

ということで、上記のnode-sassをインストールしてgatsby developをした際に

  ModuleError: Module Error (from ./node_modules/sass-loader/dist/cjs.js):
  Node Sass version 7.0.1 is incompatible with ^4.0.0 || ^5.0.0 || ^6.0.0.

というエラーが出てしまいました

調べてみると、node-sassは使えなくなっていて、上記のように「sass」を使わなければならないようです。

もし、node-sassをインストールしてしまった、もしくはnode-sass周りで上記のようなエラーが出る場合は、次のコマンドでnode-sassをアンインストール、sassをインストールしましょう。

$ npm uninstall node-sass
$ npm install sass

次にgatsby-config.jsを編集します。pluginにgatsby-plugin-sassを指定してあげます。

plugins: [
…
  `gatsby-plugin-sass`,
]

あとは普通にSCSSファイルを書くだけ。簡単。SCSSを保存しただけでSCSS→CSSのコンパイルまでしてくれるスグレモノ。

クマ

でも、上記のようにGatsbyはSCSSを直接読み込める…結局どうCSSファイルを適応していくのが正解なのだろうか。

まとめ

Gatsby製ブログにSass(SCSS)とCSS Modulesを適応して、快適なCSS作成環境を整えてみました。プログラミングはこういう保守管理が効率化(しかもかなりバカにならない)に直結するので、しっかりと考えることは重要ですね。次回は、フォントの変更を行なっていきたいと思います。

今の仕事に満足していますか?やりがい、給料、ワークライフバランス…現状に不満を持ったり嘆いているのはもったいないと思います。

今の時代、海外のようにキャリアアップのために活動していくのは、志の高い人には必然とも言えます。動かない人は、それなりの人生を歩むしかありません…。「面倒だ」という人はそれでもいいでしょう。しかし、少しずつでも前向きに活動する人は、最終的に「面倒だ」という人よりも遥かに充実したキャリアを歩むことができます

そこで、これからのキャリアを見据えた相談をしてみませんか?実力派エージェントが、今の仕事環境より、もっと高待遇の職場選びをサポートしてくれます!

あなたへオススメ!
よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!
目次