Magento2のスタイル（LESS）変更の方法概要

本記事はMagento Advent Calendar 2015の9日目の記事になります。

← 8日目Magentoでアクセス集中を乗り切るには〜後編〜
10日目Magentoで納品書のレイアウトを変更する →

年末進行作戦行動中の新兵＠Magento日本コミュニティ、@kzkiq2ndです。いつでも必死です。

西軍曹とこつこつと進めているMagento2の日本語化ですが、今月中には日本語化モジュール@Magento日本コミュニティ版が形になりそうな雰囲気です。翻訳中は管理画面などしっかり見ていくわけですが、「こんなオプションあるんだナァ」「これは作り込んでるワ」という発見も多くなかなか楽しくやっております。管理画面の解説はまたそのうち。

さて、本日の話題はMagentoでのLESSです。

LESS

新版Magento2の面白い設計の一つに、LESSを利用している点があります。もちろん、ただLESSを使うだけではなくimportの機能を利用してモジュール毎、パーツ毎にLESSを定義し、後述する用意されたコンパイルオプションを使って一つにまとめる、という方式がデフォルトになりました。

↓Magento UI libraryとしてデフォルトで定義されているLESSの構成（githubリンク)

ズラズラとならんでいますが開発にはこれらを使う前提になります。

まず全体の設計を俯瞰すると、Magento2テーマにおけるスタイルとは、Magento UI libraryのスタイル + モジュール用のLESS + 独自スタイルという積み上げ形式になります。あくまで上書きしながら積み上げるイメージで、つまり開発用blankテーマをベースに切った張ったするしか道はないという意味で、Magento1以上に事前に頭のなかで継承・上書きイメージを思い描く必要があります。特にデザインカンプ式開発フローを採用している場合は、円滑な進行のためにフロントエンドエンジニアから早めの口出しが求められるシステムと言えます。

スタイルにおける基礎部分はMagento UI libraryのLESSが担っています。Magento2のドキュメントの気合いのいれっぷりはここにも表れており、アプリケーション内にもREADMEと各UIパーツ用ドキュメントを配置してあります。本記事では詳しく触れませんが、こんな感じです。

なお、一応CSSも同じようにルールに乗っている限りはバラバラに配置してもまとめてくれるのですが、Magento UI libraryもデフォルトモジュールもLESSを基本的に利用しています。開発者側から見れば細切れになったLESSが散らばっている状態にはなりますが、逆に言えばファイル単位で分けられているが故に用意されたルールの上を歩くならばスタイル汚染が広がりにくく、Git管理にも多少わかりやすく、利用していないモジュールのLESSは読み込まない、上書きも最小限でOK、モジュールにLESSを含めることができるのでモジュール新規追加時も快適という、3のメリットがあるならば1のデメリットは捨て置く感じのMagentoらしい方向性の設計です。

↓blankテーマで定義されているモジュール用のLESS

このディレクトリ構造もルールに基づいています。ヘビー。

LESSコンパイルオプション

デフォルトで用意されたコンパイルオプションは、

1. サーバーサイドでコンパイルしてCSSで配布するプロダクションモード（Magentoキャッシュ運用と同等）
2. クライアント向けLESSコンパイラーであるLESS.jsを利用したデベロッパーモード（常に.lessファイルを配布しブラウザ側でコンパイル。ただしなんか安定しない）
3. Grunt.jsを利用したCLIでのコンパイル（任意のタイミングで実行可能）

となり、「こんだけオプション用意したんだから、十分使えるでしょ？」という自信がドキュメントから透けて見える感じの仕上がりです。主に使われるだろうプロダクションモードとデベロッパーモードは、管理画面もしくはbin/magentoコマンドで切り替えが可能になります。

デベロッパーモードは全ての.lessをそのまんま配信してブラウザ上でコンパイルするというモードになり、Magento1から続く「開発者はキャッシュを切るところから始めるけれど、それをするとむちゃくちゃアプリが重いつらいねむい」という開発スタイルにおいては、スタイル編集時にもある程度の軽さと、LESSコンパイルを待たないで即時反映の便利さがあります。（ただしなんか安定しない）

翻訳のためにアプリケーションをさわっている限りでは、アプリが後ろで何しているのかあまり意識せずとも

• 開発者モードなら即時反映
• プロダクションモードならキャッシュが効く

だけ理解すれば使えるというのは、Magentoの開発者向け設計としては珍しくハードルが低くなったポイントです。もちろん自分でGruntファイルを改造すればなんでもできるのでしょうが、基本的には用意されているモードを使えばGulp vs Grunt戦争（最近聞きませんね）など、開発の本筋ではないが決めないと始まらないポイントを回避できる＆スクリプト用意しなくてよいのはナイスです。

ところで、CSSプリプロセッサ三兄弟SASS（2006）・LESS（2009）・Stylus（2010）の次男のLESSを採用したいきさつは諸説考えられますが、これら3兄弟、日本国内では確か当時熱量がすごかったJSゲーム実装界隈から採用が広まった2011年頃から流行りだし、その後いくつかの「どれをつかうか」議論もあった印象ですが、2015年の今となっては兄弟どれもほとんど同じなのでフロントエンド開発者としてはLESSで特に文句はないはずです。むしろLESS.jsとかいう飛び道具が普通に搭載されているワークフローにMagentoらしさというか、味わいを感じるポイントになっています。（そしてなんか安定しない）

スタイルの編集の概観

Magento2の標準テーマの一つblankを継承した子テーマでカートボタンの色を上書きする手順を紹介します。ここで紹介するものは基本的に公式DevDocsの内容なので、本記事の立ち位置はオマケつきの意訳です。

それと「子テーマの作りかた」の知識が別途必要なので、ここでの解説はあくまで手順の紹介です。「コピペでできる〜」とかではないです。

デフォルトのボタン色を

こうします。

しかしすごください服ですねコレ。

Step0. 前提知識：継承・上書き

Magentoの開発者向け設計の根幹にある概念「継承・上書き」が勿論でてきます。コレに関してはMeet Magento Japan 2015でお話したり、Magento1の内容として前回のアドベントカレンダー記事にもちょっと書いていますので、必要あればそちらを参照してください（そのうちきっちりまとめるつもりもあります）

Step1. 子テーマを作る

まずは親テーマblankを継承した子テーマOrangeCo/orangeをつくります。子テーマの作成にも作法がありますが、いまのところは「子テーマをつくる」という理解で進めます。

子テーマorangeに最低限必要な構成

子テーマの作法に関する公式のDevDocsはこちらからどうぞ。

Step2. 上書き.lessを作る

子テーマOrangeCo/orangeは設定された親テーマBlankのLESSを全て継承していますが、ファイルの位置と名前によって子テーマのファイルが最優先で読み込まれ、この解説の場合BlankのLESSを部分的に上書きします。

ファイルの位置と名前ルールは相変わらず、というかM2でさらに細かくなっていますが、この解説では以下の位置にLESSを追加します。

app/design/frontend/OrangeCo/orange/web/css/source/_theme.less

ルールはたくさんありますが、上記の位置に_theme.lessを配置すると、lib/web以下にあるデフォルトLESS変数を上書きできます。

一つファイルを追加するためにたくさんディレクトリが必要

Step3. LESSを編集する

app/design/frontend/OrangeCo/orange/web/css/source/_theme.less

に変数、

//  Primary button
@button-primary__color: @color-white;
@button-primary__hover__color: @color-white;
@button-primary__background: @color-orange-red1;
@button-primary__hover__background: @color-orange-red4;
@button-primary__border: 1px solid @color-orange-red2;
@button-primary__hover__border: 1px solid @color-orange-red2;

を書いて保存する。ここでは全て変数に変数を当てはめていますが、これらはすべてMagento UI libraryにデフォルトで設定されている変数定義を使っています。

Step4. テーマを適用し、キャッシュを更新する

1. 作った子テーマOrangeをまず適用します。

管理画面で「店舗」>「設定」>「デザイン」>「デザインテーマ」でOrangeを選び、「設定を保存」します。

2. キャッシュを更新します。

Magento2が自動的に更新が必要なことを教えてくれますが、
管理画面で「システム」>「キャッシュ管理」>「キャッシュストレージをリフレッシュする」を選び、キャッシュを更新します。

ストーレジ...

するとBlankの_theme.lessに変わって新しい変数が組み込まれます。

定義されたLESS変数とディレクトリルールを覚えてしまえばなんてことはないのですが、覚えるまでが大変というMagentoらしさは健在です。

Tips. デバッグ

Magento2リリースちょっと前のDevDocsには、

修正個所を見つける方法は、CSSのクラス名とモジュールの位置を把握して全ファイル検索すればOKじゃない？

とかいうなかなかファンキーな内容があった気がするのですが、今はLESS.jsのconfigで元ファイル・ライン情報を出力する方針になっている模様です。

詳しくはStyles debuggingに記載されていますが、

lib/web/less/config.less.js

を編集して、less.jsのオプションを有効にするとのことです。

備考：M2は非開発者にとってスタイル変更すらも難しい

ちょっとした感想ですが、Magento2はスタイル変更も↑こんな状態で、また別の設計や手順も含め、もはや職業開発者でない方が自分でやろうとしてやれるだろう範囲は、ずいぶん手前で超えてしまっています。たとえ挑戦してみようと決心されたとしても何から何までハードルが高めの心折設計です。もちろん、HTML書けたら職業開発者だった頃から考えれば、そうでない方の持てる技術というものは時代にあわせて変化しますし、野生のプロもいますし日本語情報も増えるはずですが、Magento2の諸々の設計やニュアンスを見る限り、

Magento2を使う = 訓練された開発会社を呼ぶ

という線を公式がきっちり引いた印象です。開発者個人としては月額3000円以下で独ドメECを提供するサービスがある中で、そんなんじゃ月のインフラ代金にもならない良くも悪くもハイスペックなMagento2という棲み分けには興味が尽きませんが、これに関してはまたゆっくりと考えていこうかと思います。

明日は、、

再び@macsetoさんお願いいたします！