PostCSS + cssnext と CSS Modules を試す

2017年12月27日 2 開発 , , ,

このあいだ書いた記事の締めで予告したとおり Stylus からの移行先として PostCSS + cssnext を試す。

2017/12/29 追記 : cssnext は CSS.next と呼べるか?

本記事のコメント欄にて @mysticateaさん から指摘され、cssnext の機能すべてを CSS.next と呼ぶのは妥当ではないと判断した。

私が CSS.next だと思っていた CSS Nesting Module は CSS Working Group (以下、csswg) の draft には存在せず上記 issue では cssnext が次世代の規格と宣伝してるけど正式な draft としては提出されてないと書かれてる。

これから提出される可能性はあるものの、現時点の cssnext は csswg draft に完全準拠してるわけではない。CSS.next な機能とそうでないものが混在してる。

とはいえ PostCSS の CSS 構文拡張をプラグイン化するアイディアと cssnext がそこから Babel 的に .next なものを選定する方針は支持したい。よって年明けになるが cssnext 側へ

  • csswg draft とそのステータスを反映するようにしてほしい
  • csswg draft に挙げられているものだけ有効にするモードを追加してほしい
    • csswg draft のステータスがパラメーターになるような感じ
    • 標準化されたものだけ有効とか
    • モード追加としたのは現行 cssnext ユーザー環境を壊さないため

という感じの要望を出す予定。

PostCSS + cssnext

PostCSS は AltCSS の一種となるツール。Stylus や Sass はそれ自体をひとつの言語としているが PostCSS は JavaScript における Babel のようななもので、本体はランタイムに過ぎない。様々なプラグインを組み合わせて好みの変換環境を構築してゆく。

しかし個々のプラグインを調査するのはコストがかかる。また Babel でいう babel-preset-env のように将来の CSS 仕様 (以下、CSS.next) へなるべく準拠して書きたいところ。という要望を叶えるものとして cssnext がある。

cssnext は CSS.next な記法を実現するための PostCSS プラグイン集。以下の記事は対応する仕様と照らし合わせながら解説しており参考になる。

難点として babel-preset-env と異なり、変換対象となる環境を指定できない。たとえば Chrome だけサポートした CSS.next 記法があるとする。そして Web ブラウザーとしても Chrome だけサポートするからそこは変換したくない。このケースだと babel-preset-env では環境の下限を Chrome にすることで無駄な変換を避けられるのだが cssnext にはこの機能がない。

babel-preset-envECMAScript 6 compatibility table に準拠して環境を特定するのだが CSS にはこうした網羅的な環境基準がないため難しいのだろう。現時点では常に CSS3 相当の変換であることを意識する必要あり。

PostCSS CLI による単体利用

PostCSS + cssnext を利用する方法として webpack 前提の記事が散見される。しかし PostCSS は単体で利用可能。いきなり webpack と組み合わせると設定が一気に複雑化して混乱するだけなので、まずは単体で試してみる。

プロジェクト構成

プロジェクト構成は以下。

.
├── package.json
├── postcss.config.js
└── src
    ├── assets
    │   └── index.html
    └── css
        ├── App.css
        ├── Base.css
        ├── Content.css
        ├── Footer.css
        ├── Header.css
        └── Variables.css

src/css へ CSS を格納。これを開発版なら src/assets、リリース版は dist/ に変換して bundle.css というファイル名で出力する。開発版では Source Maps にも対応。

npm

必要な npm をインストール。

$ npm i -D postcss-cli postcss-cssnext postcss-import cssnano

それぞれの役割をまとめる。

npm 役割
postcss-cli PostCSS の CLI 兼、ランタイム。
postcss-cssnext cssnext 用 PostCSS プラグイン集。CSS.next な記法を解釈して変換する。
postcss-import CSS 内の @import を解釈して複数ファイルを結合するための PostCSS プラグイン。CSS.next の範疇から外れるが、便利なので追加。
cssnano CSS を minify するためのツール。プラグインではないが PostCSS の README で minify 用として紹介されているため採用。

postcss.config.js と npm-scripts

PostCSS 用の設定ファイルを定義。ファイル名を postcss.config.js にすると自動認識してくれる。内容は PostCSS よりも postcss-cli の README のほうが詳細に解説してあるので一読を。

module.exports = (ctx) => {
  const PROD = (ctx.env === 'prod')

  return {
    map: PROD ? null : { inline: false },
    plugins: {
      'postcss-import': {},
      'postcss-cssnext': {},
      'cssnano': PROD ? { autoprefixer: false } : false
    }
  }
}

設計思想や記法は webpack っぽい。Object または Functionexport する。Function だと CLI 引数を判定できる。これを利用して package.json の npm-scripts から開発版とリリース版を切り替えている。

{
  "scripts": {
    "build": "postcss ./src/css/App.css -o ./src/assets/bundle.css",
    "watch:css": "postcss ./src/css/App.css -o ./src/assets/bundle.css -w",
    "release:css": "postcss ./src/css/App.css -o ./dist/bundle.css -e prod"
  }
}

CLI の第一引数が CSS のエントリー ポイントになる。postcss-import を追加したので、このファイルから @import をたどって参照が解決される。-o が出力指定。-w でファイル監視 & 変更時の自動変換、-e はその後に指定した文字列を postcss.config.jsFunction に渡してくれる。これは任意だが NODE_ENV で用いられる production に基づき、それを省略した prod とした。

CSS.next + @import で書いてみる。

環境の準備が整ったので CSS.next ならではの機能と @import を使用した CSS を書いてみる。まずはエントリー ポイントになる App.css

@import "./Base.css";
@import "./Header.css";
@import "./Content.css";
@import "./Footer.css";

各 CSS のインポートのみを定義。エントリー ポイント以上のことはしない。こうすると何か問題が起きたとき、読み込み順と CSS 定義のどちらが原因であるかを切り分けやすくなる。個々の CSS が双方にインポートしあわない限り、順番を制御しているのはエントリー ポイントのみとなる。

次に各 CSS で共通使用する変数を定義。名前は Variables.css としておく。今回は色だけだが将来はサイズなども定義することになるだろう。それを踏まえて Colors ではなく Variables とした。

:root {
  --white: #fbfcfa;
  --turquoise: #1abc9c;
  --green_sea: #16a085;
  --emerald: #2ecc71;
  --nephritis: #27ae60;
  --peter_river: #3498db;
  --belize_hole: #2980b9;
  --amethyst: #9b59b6;
  --wisteria: #8e44ad;
  --wet_asphalt: #34495e;
  --midnight_blue: #2c3e50;
  --sun_flower: #f1c40f;
  --orange: #f39c12;
  --carrot: #e67e22;
  --pumpkin: #d35400;
  --alizarin: #e74c3c;
  --pomegranate: #c0392b;
  --clouds: #ecf0f1;
  --silver: #bdc3c7;
  --concrete: #95a5a6;
  --asbestos: #7f8c8d;
}

CSS 変数については MDN の記事がわかりやすい。色の定義と名前は本ブログや自作 Redmine テーマでも使用している Flat UI からもってきた。

これを読み込みつつ、CSS.next の CSS Nesting Module Level 3 を使用した Header.css を定義。

@import "Variables.css";

.header {
  background-color: var(--alizarin);

  & ul {
    margin: 0;
    padding: 0;
  }

  & li {
    text-align: center;
    line-height: 2.5em;
    display: inline-block;

    & a {
      margin: 0;
      width: 10em;
      height: 2.5em;
      color: var(--white);
      border-top: solid 2px var(--alizarin);
      box-sizing: border-box;
      display: inline-block;
      text-decoration: none;

      &:hover {
        border-top: solid 2px var(--sun_flower);
      }
    }
  }
}

Variables.css は他の CSS からも読み込むのだが、結合しても同じものが多重定義されることはないので安心。CSS Nesting Module は Stylus や Sass などでお馴染みの機能。& が直上の Selector を指している。そのため .header 直下で & ul と書けば .header ula に対して &:hover なら a:hover に変換される。これを利用して BEM を簡潔に書くことも可能。

  • 2017/12/29 追記
    • CSS Nesting Module は 2017/12/29 現在、CSS Working Gropu draft には挙げられていません
    • つまり CSS.next の機能とは呼べません
    • cssnext という AltCSS の独自機能となります
    • 元の表現は残しますが、これを CSS.next とする誤解が私以外にも広まるのは好ましくないため、この注記にて補足することにしました

Source Maps と minify

Source Maps を有効にするなら map オプションを指定する。CSS 埋め込みではなく単体ファイルとして出力したいなら

{
  map: PROD ? null : { inline: false }
}

のように inline: false とすればよい。このオプションが無効値だと Source Maps を出力しなくなるのでリリース版ではそうしている。minify は少々、特別で cssnano をインストールして plugins に指定することで実行される。これもリリース版のみとした。

{
  plugins: {
    'postcss-import': {},
    'postcss-cssnext': {},
    'cssnano': PROD ? { autoprefixer: false } : false
  }  
}

cssnano のオプション指定で autoprefixer を無効化している。これは cssnext 側に含まれており、無効化しないと変換時に冗長であると警告される。

Processing src/css/App.cssWarning: postcss-cssnext found a duplicate plugin ('autoprefixer') in your postcss plugins. This might be inefficient. You should remove 'autoprefixer' from your postcss plugin list since it's already included by postcss-cssnext.
Note: If, for a really specific reason, postcss-cssnext warnings are irrelevant for your use case, and you really know what you are doing, you can disable this warnings by setting  'warnForDuplicates' option of postcss-cssnext to 'false'.

この警告は postcss-cssnext のオプションに warnForDuplicates: false を指定することでも無効化できる。しかし本当に警告を表示すべき場合も無効化されてしまう。本来は警告メッセージを読んで個別に対応してゆくべきなのでそうした。

変換してみる

npm-scripts に定義されたコマンドを実行して CSS.next なファイル群をひとつの CSS に変換してみる。コマンドとしては

コマンド 役割
build 開発用。Source Maps あり。単体で変換結果をチェックする場合に使用する。
watch 開発用。Source Maps あり。ファイルを監視して変更を検知したら CSS を自動変換する。browser-sync による Web ブラウザー自動表示も設定している。開発時は通常、こちらを使用する。
release リリース用。Source Maps なし、minify あり。

となるので、それぞれ

$ npm run build
$ npm run watch
$ npm run release

とすればよい。出力されたファイルを見れば適切な変換がおこなわれていることを確認できるはず。

webpack (CSS Modules)

PostCSS + cssnext を webpack で利用することも可能だが、単に CSS を変換するだけなら PostCSS CLI のほうが webpack 依存を避けられて好ましい。どうせ webpack を使うなら領発揮となる CSS Modules を採用してみよう。ということで React + CSS Modules 構成を試す。

React における CSS

Web Components を指向してるライブラリーやフレームワークでは HTML/CSS/JS をどのように組み合わせるかが課題になる。React の場合、HTML/JS は Virtual DOM と JSX (option) で関連付けるのだが CSS については

  • CSS 単体
    • 普通に CSS を定義してそれと関連付ける
    • React コンポーネント側からは className などで CSS クラス名を明示する
    • React コンポーネントの出力も含めた最終的な HTML を想定しながら CSS を定義
    • CSS クラス名の衝突回避は BEM などの命名規則でおこなう
  • CSS in JS
    • React: CSS in JS // Speaker Deck
    • JavaScript の Object として CSS を定義して React コンポーネントと関連付ける
    • CSS は HTML 要素の style 属性に出力される
  • CSS Modules
    • css-modules/css-modules
    • CSSモジュール ― 明るい未来へようこそ | プログラミング | POSTD
    • CSS を JavaScript のモジュールとして扱う
    • CSS は普通に定義、それを JavaScript 側で import する
    • import されたスタイルを React コンポーネントの className に指定することで関連付け
    • CSS はファイルとして出力される
    • CSS ファイル内のクラス名は React コンポーネントとクラス名など (明示的に変更も可能) を元にしたハッシュになる
    • CSS を React コンポーネント単位で分割していれば、この命名規則により自動的に衝突は回避される

がある。私はこれまで CSS 単体を利用してきた。React や webpack などに依存せず、通常の CSS 開発スタイルだけで独立して運用可能なのがその理由。

かつて CSS in JS を検討した際は style 属性に出力されるため CSS ファイルのキャッシュにのらないのと style 属性の制限により疑似要素、擬似クラスが利用できない点を気にして見送った。CSS Modules はこれらの弱点を克服しているのだが webpack など特定のツールに強く依存する点が受け入れられなかった。

しかし Web Components 指向として HTML/CSS/JS をセットであつかうなら、ファイルとしても併置してあるほうが管理しやすい。例えば Header というコンポーネントなら

Header.css
Header.js
Header.test.js

のように構成されていてほしい。

CSS 単体でも Stylus や postcss-import で参照解決すれば、同等の構成を実現可能ではある。しかし CSS エントリー ポイントとの関係を意識しなければならないし、併置しても React コンポーネントとの関連付けは CSS クラス名になるので疎結合で設計的に半端だし、とイマイチだ。

ならばいっそ CSS Modules に舵を切るほうがよいのでは?といことでそうしてみる。

プロジェクト構成

プロジェクト構成は以下。

.
├── package.json
├── postcss.config.js
├── webpack.config.babel.js
└── src
    ├── assets
    │   └── index.html
    └── js
        ├── App.js
        └── components
            ├── App.js
            ├── Content.css
            ├── Content.js
            ├── Footer.css
            ├── Footer.js
            ├── Header.css
            ├── Header.js
            └── Variables.css

ファイル出力の仕様については PostCSS CLI 版と同じ。webpack 設定が追加されて CSS が React コンポーネントに併置しているのが大きな特徴。

npm

必要な npm をインストール。webpack と CSS 関連だけ。PostCSS CLI で説明したものと Babel 系は割愛。

$ npm i -D webpack css-loader postcss-loader extract-text-webpack-plugin

それぞれの役割をまとめる。

npm 役割
webpack Bundler。JavaScript や CSS の参照を解決、指定されたファイル単位にまとめて出力する。
css-loader webpack loader。CSS の参照を解決してくれる。
postcss-loader webpack loader。PostCSS に基づく CSS 変換を担当。
extract-text-webpack-plugin webpack plugin。css-loaderpostcss-loader の出力を受けて CSS ファイル化する。

postcss.config.js

PostCSS と webpack は Source Maps 出力など機能的に被るところがある。そのため主従をしっかり決めて一方へ寄せるのが大切。今回は PostCSS を従として必要最小の設定にとどめる。そのため postcss.config.js の定義は実にシンプル。

module.exports = {
  plugins: {
    'postcss-import': {},
    'postcss-cssnext': {}
  }
}

PostCSS は CSS.next 変換のみに徹し、Source Maps と minify の指定は webpack 側でおこなう。

webpack.config.babel.js

webpack の設定は以下。JavaScript 分も含まれているため長いが、すべて掲載してから CSS 関連を解説する。

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

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

  return {
    entry: './src/js/App.js',
    output: {
      path: PROD ? `${__dirname}/dist` : `${__dirname}/src/assets`,
      filename: 'bundle.js',
      publicPath: '/'
    },
    devtool: PROD ? '' : 'source-map',
    module: {
      rules: [
        {
          test: /\.js$/,
          exclude: /node_modules/,
          use: {
            loader: 'babel-loader'
          }
        },
        {
          test: /\.css$/,
          use: ExtractTextPlugin.extract([
            {
              loader: 'css-loader',
              options: {
                modules: true,
                importLoaders: 1,
                sourceMap: !(PROD),
                minimize: PROD ? { autoprefixer: false } : false
              }
            },
            'postcss-loader'
          ])
        }
      ]
    },
    devServer: {
      contentBase: './src/assets'
    },
    plugins: PROD ? [
      new WebPack.DefinePlugin({
        'process.env.NODE_ENV': JSON.stringify('production')
      }),
      new MinifyPlugin({
        replace: {
          'replacements': [
            {
              'identifierName': 'DEBUG',
              'replacement': {
                'type': 'numericLiteral',
                'value': 0
              }
            }
          ]
        }
      }, {}),
      new ExtractTextPlugin({ filename: 'bundle.css' })
    ] : [
      // development
      new ExtractTextPlugin({ filename: 'bundle.css' })
    ]
  }
}

今回の構成では CSS の参照と出力について JavaScript 側の設定に影響される。そもそも CSS Modules を採用した時点で設計的にも JavaScript と密結合になるわけだから、そのようなものと受け入れよう。これを前提として CSS 関連だけ整形抜粋。

{
  module: {
    rules: [
      {
        test: /\.css$/,
        use: ExtractTextPlugin.extract([
          {
            loader: 'css-loader',
            options: {
              modules: true,
              importLoaders: 1,
              sourceMap: !(PROD),
              minimize: PROD ? { autoprefixer: false } : false
            }
          },
          'postcss-loader'
        ])
      }
    ]
  },
  plugins: [
    new ExtractTextPlugin({ filename: 'bundle.css' })
  ]
}

extract-text-webpack-plugin が重要な働きをする。module.rules では .css ファイルに対して extract メソッドを呼び出している。これは既存の loader を利用して参照解決や変換を実行するためのもの。引数の型が何通りかあるのだけど今回は Array で loader を列挙する方式を採用。順番としては css-loader に参照を解決させてから postcss-loader で CSS 変換という流れになる。

CSS Moduels を利用する場合は css-loader のオプションに modules: true, importLoaders: 1 を指定する。PostCSS CLI でおこなっていた cssnano による minify もこの loader 内で実行される。minimizetrue を指定すると有効、Object の場合は有効かつ cssnano へ渡すオプションになる。

plugins で出力する CSS ファイルを指定。ディレクトリーは JavaScript 側と同じ場所になる。

extract-text-webpack-plugin の README にも解説されているが、複数の CSS ファイルを出力したければ newextract-text-webpack-plugin インスタンスを複数生成し、個別に extract メソッドを呼んだうえで plugins にこれらを列挙指定すればよい。Bootstrap のように巨大な CSS フレームワークとアプリ独自部分をわけるときなどに便利な機能である。

CSS と React コンポーネントの関連付け

まずは CSS を定義。Header.css とする。

.header {
  & ul {
  }

  & li {
    & a {
      &:hover {
      }
    }
  }
}

cssnext によりネストも処理できる。これを同じディレクトリーに併置された React コンポーネント Header.js から読み込んで関連付ける。

import React from 'react'
import Styles from './Header.css'

const Item = ({label, url}) => {
  return (
    <li>
      <a href={url}>{label}</a>
    </li>
  )
}

const Header = (props) => {
  const items = props.items.map((item, index) => {
    return <Item key={index} label={item.label} url={item.url} />
  })

  return (
    <nav className={Styles.header}>
      <ul>
        {items}
      </ul>
    </nav>
  )
}

読み込まれた Object には CSS 側のクラス名をもつプロパティーが定義されているので Styles.header のように参照してコンポーネントの className へ指定する。変換された CSS は以下のようになる。

._1g566qHWQaY0sftP77Euo- {
}

._1g566qHWQaY0sftP77Euo- ul {
}

._1g566qHWQaY0sftP77Euo- li {
}

._1g566qHWQaY0sftP77Euo- li a {
}

._1g566qHWQaY0sftP77Euo- li a:hover {
}

クラス名がハッシュになっている。長いので掲載しないが JavaScript 側の変換結果でもこのハッシュが className と関連付けられていることを確認できた。なおハッシュになるのはクラス名だけで要素名などは維持される。

CSS Modules を利用する時点でモジュール単位にスコープが作られるようなものだから、クラスをネストする意味は薄い。例えば以下のようにネストしたなら

.footer {
  & .copyright {
  }
}

変換結果は

._3Krd9752YE1I4ymIQ2tziV {
}

._3Krd9752YE1I4ymIQ2tziV ._32zVUKNOjqIf8Jr8ZonGQT {
}

となるため React コンポーネント側でも

import React from 'react'
import Styles from './Footer.css'

const Footer = (props) => {
  return (
    <footer className={Styles.footer}>
      <p className={Styles.footer + ' ' + Styles.copyright}>Copyright © {props.copyright}</p>
    </footer>
  )
}

という感じでわざわざスペースを挟んで結合しなければならない。設計としてもひとつのモジュールに同じクラス名が重複するのは好ましくないため、クラスはすべてルートに定義するほうがよいだろう。前述の li ならば可変長であることは自明でわざわざクラスをつける意義が薄いから、ネストして要素名で定義する。という感じで使い分けてゆこうと考えている。

変換してみる

変換用の npm-scripts コマンドは PostCSS CLI 版と同じなので割愛。

テキスト エディター

PostCSS + cssnext で CSS を書く際、テキスト エディターの補助があると生産性が向上する。Atom なら

を入れるとよい。language-postcss が PostCSS の構文強調、pigments は CSS 内の color 系を実際の色として強調表示してくれる。これらの組み合わせなのか pigments のパワーなのか分からないが CSS 変数に定義された色も参照先でちゃんと表示してくれる。なにげにすごい。

vscode の場合は

のいずれかを選ぶ。PostCSS syntax は名前のとおり PostCSS の構文強調。

postcss-sugarss-language は前者をベースにしてインテリセンスなどを追加したもの。ただしこちらは標準だと .css を対象としないため vscode のユーザー設定に

{
  "files.associations": {
    "*.css": "postcss"
  }
}

を追加する必要あり。以降は .css でも反応してくれる。vscode-icons を使用していれば vscode のエクスプローラー上でも .css が PostCSS アイコンに変わるので目安になる。

なお残念なことに vscode だと Atom のように CSS 変数の色は強調されない。Color Highlight が Atom でいう pigments かもと期待して入れてみたが CSS 変数には対応しておらず、たまに描画が崩れることもあったのでやめた。これは諦めるしかないようだ。将来に期待している。

まとめ

AltCSS としての PostCSS + cssnext と、それを CSS Modules に組み合わせる方法を試した。

Stylus なら同等の機能を単体で実現可能だが CSS.next 準拠の点で PostCSS + cssnext のほうが好ましい。標準的な記法を採用しておけばツールを捨てたり乗り換えるものが容易になる。Stylus が CSS.next 準拠してくれればよいのだけど、開発の熱は下がってるようだし難しいだろう。

CSS Modules は導入こそ面倒だが Web Components として思い描いてる構成像に近くて運用しやすそう。私はユニット テストもコードと同じディレクトリに併置しているのだが、関係するものを近くに集約すると実に便利である。密結合だからおのずとそれらを往復することが多くて、ならば近いほうがよい。CLI であれ GUI のツリー ビューであれ、近ければ往復しやすくなる。

CSS Modules を採用した場合、ページ全体とコンポーネントの CSS をどう分割するかが課題となる。今回のサンプルだと body, html のスタイルを最初に読み込まれるコンポーネントの CSS に定義したのだが、これは入出力ともにわけたほうがよいのかもしれない。

グラフィック デザイナーとの協業については一考の余地あり。

JavaScript と CSS が併置されていることに抵抗を感じるかもしれない。これまで CSS だけ注視していればよかったのだが、側に自分がいじらなさそうなファイルが置いてあるというのはストレスになるだろう。これは慣れてもらうしかないか。あと React なら SFC (Stateless Functional Components) にしておくとほぼ HTML 相当に単純化されるからグラフィック デザイナーの忌避感が減りそう。これはグラフィック デザイナーの領分についての話でもある。

グラフィック デザイナーから HTML/CSS の断片を提供してもらい、それを SFC + CSS Modules のセットにするのもよい。Sketch ならそういう書き出しも可能だしパーツ分解しやすそうだから、無理に CSS を定義してもらうより効率的かもしれない。断片として管理することを前提とした作業スタイルについて考えたい。


COMMENTS

  • mysticatea
    2017年12月28日 1:59 PM 返信

    CSS Nesting Module Level 3 なるものを CSS.next と呼ぶのは違う気がします。それの存在を CSS Working Group は知らないみたい[^1]ですし、リンク先は 2015 年から更新されてなさそうですし。

    仕様が安定している Alt CSS 言語よりずっと危険そうな香り。

    [^1]: https://github.com/w3c/csswg-drafts/issues/998

REPLY

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です