CSS Modules をもっと試す

February 20, 2018開発CSS Modules, JavaScript, React, Sass, webpack

業務プロジェクトへ CSS Modules 導入を検討中。しかし JS/CSS ともに大きく設計変更されるため、いきなり採用するのは怖い。というわけで、そこそこの規模と複雑さを持つ examples-electron/audio-player で試してみた。このプロジェクトは Electron 製の簡易音楽プレーヤーになる。JS/CSS まわりはこんな感じ。

JavaScript
- AltJS は Babel と babel-preset-env、ES.next 範疇の機能と構文のみ使用、ターゲット設定は electron なので少し古い Chorome 相当になる
- View は React
- Flux は material-flux、いずれ redux か mobx あたりへ乗り換える予定
- Bundler は webpack
- Electron の Main/Renderer プロセスともに Bundle/Transpile 対象
CSS
- AltCSS は Stylus
- Bundler/Transpiler ともに stylus で完結
- CSS クラスは BEM、定義で楽するため Stylus のネスト機能に強く依存している
- IcoMoon で生成した Icon Font を利用

このような環境に CSS Modules (with Sass) を導入して遭遇した問題や対策を記録する。

webpack.config.js

Sass を試すの CSS Modules (with Sass) + webpack 構成を踏襲しながら少し修正。Babel や package.json は CSS Modules とあまり関係ないので webpack.config.js のみ掲載。webpack v3 の設定になる。近くリリースされるという webpack v4 で変更が必要になるかもしれないけど、CSS Modules 部分はそのまま維持できると思う。

import WebPack from 'webpack'
import MinifyPlugin from 'babel-minify-webpack-plugin'
import ExtractTextPlugin from 'extract-text-webpack-plugin'

export default (env) => {
  const MAIN = env && env.main
  const PROD = !!(env && env.prod)

  return {
    target: MAIN ? 'electron-main' : 'web',
    entry: MAIN ? './src/js/main/App.js' : './src/js/renderer/App.js',
    output: {
      path: PROD ? `${__dirname}/dist/src/assets` : `${__dirname}/src/assets`,
      filename: MAIN ? 'main.js' : 'renderer.js'
    },
    devtool: PROD ? '' : 'source-map',
    node: {
      __dirname: false,
      __filename: false
    },
    module: {
      rules: [
        {
          test: /\.js$/,
          exclude: /node_modules/,
          use: {
            loader: 'babel-loader'
          }
        },
        {
          test: /\.scss$/,
          use: ExtractTextPlugin.extract([
            {
              loader: 'css-loader',
              options: {
                modules: true,
                localIdentName: PROD ? '[hash:base64]' : '[name]-[local]-[hash:base64:5]',
                url: false,
                importLoaders: 1,
                sourceMap: !(PROD),
                minimize: PROD ? { autoprefixer: false } : false
              }
            },
            {
              loader: 'sass-loader',
              options: {
                outputStyle: PROD ? 'compressed' : 'expanded',
                sourceMap: !(PROD)
              }
            }
          ])
        }
      ]
    },
    plugins: PROD ? [
      new MinifyPlugin({
        replace: {
          'replacements': [
            {
              'identifierName': 'DEBUG',
              'replacement': {
                'type': 'numericLiteral',
                'value': 0
              }
            }
          ]
        }
      }, {}),
      new WebPack.DefinePlugin({
        'process.env.NODE_ENV': JSON.stringify('production')
      }),
      new ExtractTextPlugin({ filename: 'bundle.css' })
    ] : [
      new ExtractTextPlugin({ filename: 'bundle.css' })
    ]
  }
}

デバッグ用 CSS クラス名

CSS Modules は CSS クラス名を自動的にハッシュ化してくれるのだが、このままだと DevTools から確認したいときに困る。Source Maps があれば元のスタイルを参照できるものの、HTML 要素の class 属性から React コンポーネントを人間が識別するのは難しい。よって css-loader の options を工夫する。

{
  localIdentName: PROD ? '[hash:base64]' : '[name]-[local]-[hash:base64:5]'
}

デバッグ時は [name]-[local]-[hash:base64:5] としておく。生成されたクラス名は AudioPlayerControl-player-1sCWC のような感じとなり人間にもわかりやすい。終端のハッシュでユニークさも担保される。モジュールとクラス名だけでユニークさを保証できるならハッシュを外してもよい。私は保険のためにつけてる。

リリース版についてはお好みで。私はエンドユーザー仕向けなので実装の詳細は見せないほうがよいと考えており、それを明示するための難読化としてハッシュ化することにした。エンドユーザーに開発の協力をあおぐとしてもデバッグ版を提供すればよい。

Sass の `@import` と CSS Modules の注意点

Sass の SCSS 内で @import するとその単位で参照が解決される。これと CSS Modules を組み合わせる場合は注意が必要。例えば Test.scss に

.test {
  color: red;
}

を定義して Content.scss と Footer.scss がそれぞれ @import したとする。これらを更に JavaScript から参照すると Test.scss の内容が Content.scss と Footer.scss で個別に展開されてから CSS Modules に結合されるため

/* Content.scss から @import "Test.scss" した部分 */
._3lCv-t9tW054o8vckddf2y {
  color: red;
}

/* Footer.scss から @import "Test.scss" した部分 */
._15Cb513oAuCYe4NCm3MT69 {
  color: red;
}

のように重複してしまう。CSS Modules は JavaScript からの参照解決だけを担当してモジュール内の参照は考慮しないようだ。

これを避けるために共用したい SCSS は CSS セレクターとして有効な定義をせず、変数や Mix-In に限定すればよい。そもそも CSS セレクターを参照しても利用する方法がないわけで、継承とか合成ならば Sass として @mixin と @extend が提供されている。

CSS Modules の結合順とグローバル

CSS Modules の結合は JavaScript 側の参照順となる。CSS Modules を利用しようと考える時点で JS/CSS は疎結合になっているだろうから、普段は順番を意識することはない。しかし例えば

<html> や <body> などのスタイルを CSS 全体で一度だけ定義したい
アイコンフォントは個別に参照せずグローバルに一度だけ定義したい

ということもあるだろう。これを実現してみる。

まずは CSS の参照位置。これは JavaScript 側のエントリーポイント冒頭にする。例えば App.js がエントリーポイントなら

import './App.scss'

// 以下、エントリー ポイント処理...

のように読み込む。JavaScript 側で直に参照するものはないため from は不要。考え方としては babel-polyfill に近い。これで App.scss に定義されたスタイルは CSS の先頭に展開される。

次にグローバルな CSS クラス名。これは css-modules/css-modules の README で解説されているとおり :global で囲む。例えば .app というクラス名をハッシュ化せず維持したいなら以下のようにすればよい。

:global {
  .app {
    width: 100%;
    height: 100%;
    background-color: $color_white;
  }
}

これはサードパーティ製 CSS 内のハッシュ化を防ぐためにも使える。

:global {
  @import "~library.css";
}

こうすれば対象となる CSS 内に定義されたクラス名が維持される。配布形態が npm なら ~モジュール名 とすることで node_modules 配下のパスを省略も可能。

ただしこの機能にはバグがある。2018/2 時点の css-loader だと :global 内に font-face があると { font-face {} } のように余計なブラケットで囲まれてしまう。そのため font-awesome を対象にすると CSS が壊れてしまう。

アイコンフォントのクラス名

アイコンフォントを利用する場会は前述の問題があるため font-face は :global に囲えない。よってアイコンの CSS クラス名を維持するならそこだけを :global に囲み font-face はむき出しにする必要がある。CSS クラス名を維持せずハッシュ化を許容するとしても別問題がある。

例えば

[class^="icon-"], [class*=" icon-"] {
  font-family: "icon";
  speak: none;
  font-style: normal;
  font-weight: normal;
  font-variant: normal;
  text-transform: none;
  line-height: 1;

  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
}

.icon-rew:before {
  content: "\e800";
}

.icon-warning:before {
  content: "\e801";
}

のようにセレクター名で共通部分を定義する場合、そこを維持しなければならない。これは「デバッグ用 CSS クラス名」の項で書いたように css-loader の localIdentName を工夫すれば解決可能ではある。しかしこの方法だと全 CSS クラス名に影響するため設計的に好ましくない。またアイコンフォントは複数箇所から同時に利用したくなるだろうし、その場合は性質としてグローバルだ。

よって font-face 以外は :global でまるごと保護する方が運用しやすい。React コンポーネント側はそのまま直値で CSS クラス名を指定する。

`font-face` の `url` 参照

font-face の参照で src:url() にローカルの相対パスを指定した場合、css-loader の処理時点で参照が解決されなければならない。そのため

.
├── assets
│   ├── index.html
│   └── fonts
│       ├── icon.eot
│       ├── icon.svg
│       ├── icon.ttf
│       └── icon.woff
└── js
    ├── App.js
    └── App.scss

のような構成で以下のように定義しているとエラーになる。

@font-face {
  font-family: "icon";
  src:url("fonts/icon.eot");
}

CSS の出力先が assets/ であっても css-loader は CSS から参照されているものを直に解決しようとするため、App.scss から fonts/icon.eot が見えないといけない。これを防ぐためには css-loader の options へ url: false を設定する。これで src: url() の参照を無視してくれる。自前でアイコンフォントを用意するなら、これとグローバル指定を組み合わせて CSS のエントリーポイントへまとめて定義するとよい。

`@charset "UTF-8"` 問題

アイコンフォントの定義で content: "\e800"; のように非 ASCII 文字を指定すると sass-loader が気を利かせて @charset "UTF-8"; を挿入してくれる。しかし「Sass の @import と CSS Modules の注意点」で書いた問題を考慮しなければならない。

例えば <html> や <body> などのスタイルを Base.scss、アイコンフォント系を Icon.scss に定義したとしよう。これらをエントリーポイントになる App.scss で

@import "Base.scss";
@import "Icon.scss";

のように読み込んだ場合、

html, body {
  width: 100%;
  height: 100%;
  margin: 0;
  padding: 0;
}

@charset "UTF-8";
@font-face {
}

という感じで出力される。Icon.scss で初めて非 ASCII 文字が登場したため、このファイルを展開する位置に @charset "UTF-8"; が挿入されてしまった。これは @charset で解説されているとおり CSS として不正である。

対策するなら

順番を意識して慎重に @import する
グローバルなものはファイル分割せず、エントリーポイントで直に定義する

ことになる。私は設計的に単純な後者を採用した。直に定義するとファイルが長くなる懸念はある。しかし CSS Modules を採用しているならグローバルは少なくなるはず。そうでないならコンポーネントやモジュールの分割に問題があるため、設計を見直したほうがいい。

npm の font-awesome を利用するなら？

npm の font-awesome を利用するなら、ここまで書いたアイコンフォントに絡む問題をすべて解決しなければならない。

CSS クラス名の維持

CSS クラス名を維持する場合は :global で font-face が壊れる問題を対策する。そのためには npm で配布されたファイルを加工する必要がある。font-face 以外を :global で囲むことになるだろう。これは npm 管理の観点からおこなうべきではない。配布されたものをそのまま利用できないなら、npm を採用する意味がない。

`font-face` の `src:url()` 問題

font-face の src:url() 問題について。これは大まかに二つの対策がある。

url-loader で参照解決して出力 CSS に base64 文字列としてフォントファイルを埋め込む
参照をスキップさせて CSS 出力先へフォントファイルを都度コピーする

1 は CSS ファイルが巨大になる問題あり。これを許容できるなら Bundler という観点として正当な方法といえる。2 は出力された CSS から参照できればよい点は好ましいのだけど font-awesome の font-face 定義は

@font-face {
  font-family: 'FontAwesome';
  src: url('../fonts/fontawesome-webfont.eot?v=4.7.0');
  src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'), url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');
  font-weight: normal;
  font-style: normal;
}

のように ../fonts/ を参照しているため、出力先でこの構造を再現しなければならない。例えば

.
├── index.html
├── css
│   └── bundle.css
└── fonts
    ├── FontAwesome.otf
    ├── fontawesome-webfont.eot
    ├── fontawesome-webfont.svg
    ├── fontawesome-webfont.ttf
    ├── fontawesome-webfont.woff
    └── fontawesome-webfont.woff2

こんな感じ。Bundler で単一 CSS ファイルを出力していると、それひとつだけ格納するフォルダーを用意するのは抵抗がある。webpack loader/plugin を駆使してパスを書き換える手もあるだろうけど font-awesome の定義変更に影響されるため微妙。

`@charset "UTF-8"` 問題

font-awesome の @import を全 CSS の先頭にもってくればよい。

これは制約になるためコミットログだけでなくコメントでソース自体に明記しておいたほうがよい。第三者が @import 周りを整理しようとして事故らないためにも。

そもそも Bundler と相性よくない

font-awesome を Bundler と組み合わせて利用したい需要はそれなりにあるようで、

といった記事で対策が紹介されている。しかし特定 npm の設計による問題を解決するために特別な npm や設定を用意するのは泥縄ではないか。問題が問題を呼んでいる。依存も増えるし労に見合わない。

よって私が Font Awesome を利用するとしたら npm ではなく静的リソースとして直に組み込む。fonts/ を好みの場所に置き、CSS も書き換える。Releases - FortAwesome を見るに更新頻度はさほどでもないし、手動で管理しても大した手間ではないだろう。なお npm 版は CSS/SCSS/LESS ファイルをまとめて提供してくれるため、手動で組み込むための元ネタとしてインストールする価値はある。

Babel や Sass のように Font Awesome が公式に webpack loader/plugin をサポートしてくれることへ期待している。

JS/CSS の配置

CSS Modules を採用することで CSS は特定の React コンポーネント専用になる。よって JS/CSS は併置すると運用しやすい。例えばこんな感じで。

.
├── AlbumListContainer.js
├── AlbumListContainer.scss
├── AlbumListHeader.js
└── AlbumListHeader.scss

併置することで JavaScript 側から参照するときの相対パスが短くなる。ファイル名は一緒にして拡張子だけ変えると関連していることがわかりやすい。ただし同名ゆえに参照する際は拡張子まで記述すること。拡張子を省略すると参照している自身と区別できないので。

CSS クラスのネストについて

CSS Modules を利用しない場合、CSS クラスはすべてグローバルになることを前提に名前衝突を避けるため様々な工夫が必要だった。私も命名規則として BEM (Block Element Modifier) を採用していた。しかしベタに書いてゆくと

.button {}
.button--state-success {}
.button--state-danger {}

のようになってダルいため Stylus のネスト機能を使って

.button {
  &--state {
    &-success{}
    &-danger {}
  }
}

のように定義していた。CSS Modules を利用するなら衝突を気にする必要がないため、ネストさせず

.button {}
.success {}
.danger {}

のように書けばよい。モジュール分割されることでその単位のコンテキストが明示されるから従属しているものを簡素なクラス名にしても通じる。この例であればファイル名が Button.scss なら .button を .container や .base といった基礎部分をあらわすようにしてもよいだろう。

DOM 要素、擬似要素、擬似クラスに関しては CSS Modules の範疇外だが、これらも

.button {
  img {}
  &:hover {}
}

とするよりは

.button img {}
.button:hover {}

のように CSS 標準で書くほうがよいのかもしれない。これについては私もどうするか迷っている。しかし CSS 標準に寄せておけば CSS Modules や Sass への依存度をなるべく下げることでツールを捨てやすくなる。CSS を第三者と共有する際にも前提知識が CSS 標準の範疇で済むため混乱が起きにくいだろう。というわけで新たに書くならネストなしを採用する予定。

CSS Modules と CSS in JS について

React コンポーネントと CSS を連携させる手段として CSS Modules の他に CSS in JS という勢力がある。これらの違いについては古い記事だけど以下がわかりやすい。

特に後者ではそれぞれの弱点をとりあげていて納得感もある。しかし私は Free-Style の弱点で触れられている

CSS Modules は CSS で書くので、「いつでも引き返せる」みたいな安心感は CSS Modules の方が強いと思う

を重視するため CSS Modules を選ぶことにした。CSS in JS は Free-Style 以外にもいくつかあって、これも古い記事になるけど

Reactと一緒に使う時のCSS in JSのライブラリ選定とか所感とか - Qiita

が参考になる。で、この「いくつかあって」というのが問題。

CSS の Property/Value 記法は JavaScript オブジェクトの Key/Value と似ているため、ほぼそのまま書けそうに思える。しかし擬似要素や擬似クラスなどは対応しそうな構文がないため、諦めるか特別な記法を持ち込むことになる。そしてこの対策がツール間でまちまちなのだ。依存すると引き返すのが難しくなる。

CSS in JS を利用する動機として JavaScript から動的に変更しやすいというのがある。これについては外観に関わるものなら値そのものを書き換えるより CSS クラスを変更する従来式で十分だと考えてる。

静的でよければ Sass や Stylus にも変数はあるので外観プリセット切り替えのような目的には対応できる。動的なものとしても CSS 標準で calc などが控えてる。ならばわざわざ JavaScript 側でがんばらなくてよいのでは？というのが私の見解。

高機能なのはわかるけど、それなしに CSS 標準へ寄せて運用できるならそうしたい。この辺、CSS in JS について解説してる記事を読んでもピンとこなかったところなので識者の意見をうかがいたい。

アカベコマイリ

HEAR NOTHING SEE NOTHING SAY NOTHING

CSS Modules をもっと試す

webpack.config.js

デバッグ用 CSS クラス名

Sass の `@import` と CSS Modules の注意点

CSS Modules の結合順とグローバル

アイコンフォントのクラス名

`font-face` の `url` 参照

`@charset "UTF-8"` 問題

npm の font-awesome を利用するなら？

CSS クラス名の維持

`font-face` の `src:url()` 問題

`@charset "UTF-8"` 問題

そもそも Bundler と相性よくない

JS/CSS の配置

CSS クラスのネストについて

CSS Modules と CSS in JS について

CSS Modules をもっと試す

webpack.config.js

デバッグ用 CSS クラス名

Sass の @import と CSS Modules の注意点

CSS Modules の結合順とグローバル

アイコン フォントのクラス名

font-face の url 参照

@charset "UTF-8" 問題

npm の font-awesome を利用するなら？

CSS クラス名の維持

font-face の src:url() 問題

@charset "UTF-8" 問題

そもそも Bundler と相性よくない

JS/CSS の配置

CSS クラスのネストについて

CSS Modules と CSS in JS について

Sass の `@import` と CSS Modules の注意点

アイコンフォントのクラス名

`font-face` の `url` 参照

`@charset "UTF-8"` 問題

`font-face` の `src:url()` 問題

`@charset "UTF-8"` 問題