Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationEventAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
313
Help us understand the problem. What are the problem?

posted at

updated at

Organization

小〜中規模サイトのフロントエンド・コーディング規約 CSS・JavaScript編

2021/3/16
初めて記事を書いてから3年以上経過してしまったので、
内容を見直ししました。


関係者が10名以下の小〜中規模案件の開発・保守が多い弊社のCSS・JavaScript規約(にしたい)です。
長くなってしまったコーディング規約もようやく最後です。

↓関連
環境構成編
HTML編

CSS、JavaScript は数年で書き方が変わってしまうので、
定期的に規約の見直しができると理想ですね。

小〜中規模サイトのフロントエンド・コーディング規約 CSS編

ディレクトリ構成

CSSに関するファイルの一般的な例を示します。

ルート
 ├ src ... 作業ディレクトリ
 │ ├ scss
 │ │ ├ lib ... 外部ライブラリなど
 │ │ ├ sprite ... spritesmith などで生成したファイル
 │ │ ├ foundation (base) ... 変数や mixin, function 定義
 │ │ ├ components (module)  ... コンポーネント、モジュール
 │ │ └ page ... ページごとのレイアウト
 │ │
 │ └ styleguide ... style guide生成用ディレクトリ
 │
 ├ htdocs ... リリースディレクトリ
 │ └ css
 ├ config ... 設定ディレクトリ
 │ └ postcss.config.js
 │
 └ .stylelintrc.json ... stylelint 設定

記述ルール

項目 定義内容
文字コード UTF-8
インデント 半角スペース2つ
idセレクタ セレクタ優先順位の計算が面倒になるので id での指定は避ける
要素型(タイプ)セレクタ あとからの修正に弱いので要素型セレクタの指定は控える
ネストの深さ 可搬性が下がるので、ネストの深さは3階層程度に収める
数値 小数点以下は最初の0を省略できる。ただし、animation/transition プロパティでは省略しない
ショートハンド あとからの修正に弱いので不用意にショートハンドプロパティを使わない
特にbackground-size は含めない
line-height 単位はつけない(親要素の値が子要素に相対的に継承できないため)
z-index コンポーネントごとにプリプロセッサの変数で管理する
計算 相対的な値など、算出する値はプリプロセッサの function を使う。もしくは計算過程をコメントで残す
// 非推奨
#class div{
  margin: 10px auto auto 20px;
  padding-right: 4.6875%;
  padding-left: 4.6875%;
  z-index: 101;
  font-size: 0.9em;
  line-height: 18px;
  animation: anime .15s 0s ease-in}
@use "sass:math";

// 推奨(scss記法)
$module_z_index = 100;

.class .child {
  margin-top: 10px;
  margin-left: 20px;
  padding-right: math.percentage(15px / 320px);
  padding-left: math.percentage(15px / 320px);
  z-index: $module_z_index + 1;
  font-size: .9em;
  line-height: (12 / 18); // 1.5
  animation: anime 0.15s 0s ease-in;
}

stylelint

記述ミスを防ぐため、stylelint は行うようにしてください。
ルールは stylelint-config-recommended-scss で十分です。
プロパティの記述順にルールがあると読みやすい & 圧縮効率が良いので
stylelint-order の設定があると良いです。
順番は好みで良いのですが、stylelint-config-rational-order/plugin の順で
並んでいると直感的で見やすいです。

コメント

コメントは一定のルールに習って使い分けていれば大丈夫です。
下記は推奨です。エディターにスニペット登録して使います。

/* ==========================================================================
   CSS セクションコメントブロック
   footer や header などまとまったコンポーネントの見出しに使います
   ========================================================================== */

/* CSS サブ・セクションコメントブロック
   コンポーネントにサブセクションがある場合に使います
   ========================================================================== */

/* コメント */
// ==========================================================================
// scss セクションコメントブロック
// ==========================================================================

// scss サブ・セクションコメントブロック
// ==========================================================================

// コメント

既存ライブラリ・案件の共通リソースとの併用

既存ライブラリやクライアントさん支給の共通リソースを併用する場合は、意図しない上書きや競合を起こさないため下記に注意します。

  • 外部ライブラリは /lib や /vendor などまとまったディレクトリに配置する
  • セレクタの衝突が起きないように、併用する場合は案件特有の接頭辞を追加する
/* 非推奨 */
.button {}
/* 推奨 */
.myProject_button {}

ツール

プリプロセッサ

汎用性の高さから sass(Dart sass) を推奨しています。
@use に早めに慣れておいてください。

ポストプロセッサ

下記の処理はポストプロセッサ(PostCSS)で行ってください。

  • ベンダープリフィックスの追加
  • 使っていない CSS のパージ
  • 圧縮(minify, gzip化)

CSS設計手法

これまでは MCSS や FLOCSS のような遡上できないレイヤー構造の設計で作ってくることが多かったのですが、

  • 明確な一定の記述ルールに従っている
  • コンポーネントの可搬性が高い
  • コンポーネントの親子構造・状態がクラス名から判断できる
  • 追加・修正・再編集・破棄の影響が最小限になるように考えられている

設計手法なら何でもよいと思っています。

ECSS のようにファイルが大きくなっても共通要素でまとめず、ページの機能単位で管理していく方法や、
vue.js や riot.js のようにコンポーネントごとに HTML, CSS, JavaScript をカプセル化する作り方もあるので
案件に適した設計手法を採用してください。

スタイルガイド

複数人でコーディングする場合はもちろん、社内でのUI調整にもスタイルガイドがあると便利です。

デザイン決定が

  • コーダーの意思が反映されないアジャイル的なもの
  • 進行が遅れている場合

は、無理に用意しなくてもかまいません。

1ページに基本的なコンポーネントが網羅されているものでもいいのですが、
複数人開発では storybook が便利でした。

そのほか

Tailwind CSS

プロトタイプ開発にとても便利な Tailwind CSS ですが、
個人的には使わなくていいかな、と思います。

base, components, utilities を読み込むととにかく コンパイル時間が長い。。
使うユーティリティクラスも限定的なので恩恵が少ないと感じました。

小〜中規模サイトのフロントエンド・コーディング規約 JavaScript編

ディレクトリ構成

JavaScriptに関するファイルの一般的な例を示します。
TypeScript での作業を推奨しています。

ルート
 ├ src ... 作業ディレクトリ
 │ └ ts (js)
 │   ├ lib ... 外部ライブラリ
 │   ├ component  ... コンポーネント化したテンプレート
 │   └ module  ... モジュール
 │     └ common ... サイト共通モジュール
 │
 ├ htdocs ... リリースディレクトリ
 │ └ js
 ├ test ... JSテストディレクトリ
 │
 ├ .babelrc
 ├ .eslintrc.js
 └ tsconfig.json

記述ルール

項目 定義内容
文字コード UTF-8
インデント 半角スペース2つ
変数・関数名 予約語を使わない。camelCase を推奨
クラス名 1文字目は大文字にする
初期化 リテラルで行う
三項演算子 使っても良い
// 非推奨
var case = new Array(); // case は予約語
class animal {} // クラスの1文字目は大文字にする
// 推奨
const caseList: caseType[] = [];
class Animal {}

コメント

他人にも読みやすいように、適切なところにコメントを入れるようにして下さい。
TypeScript で書くことで引数や戻り値の内容把握が楽になったのですが、
クラスやメソッドの前には jsDoc の形式でコメントをつけるようにすると
コードレビューがしやすくなります。

/**
 * 概要を記述。
 * 下記の引数、戻り値にはどんな型が入るか明らかにする
 * @param {string} arg 引数の説明
 * @return {string} 戻り値の説明
 */
function returnStrings(arg: string): string {
  return String(arg);
}

コメントのいれ方も程度が難しいのですが、下記を参考にしてみてください。

リーダブルコードまとめをざっと見るのもおすすめです:grin:

文法から意味のある規約

上記以外で JavaScript の仕様上、推奨される規約は下記のまとめを参考にしてください。

アセット管理、トランスパイラ、AltJS

読み込むライブラリが複数存在していたり、コンポーネント管理の開発が合理的だったら webpack を使用することを推奨しています。

webpack

複数の出力されるファイルから共通のモジュールを読み込む場合はoptimization.splitChunksで管理してください。

babel

最新の core-js を使ってください。
webpack の babel-loader で TypeScript のトランスパイルまで行ってしまうと
設定が楽です。

AltJS

型を定義するため TypeScript の利用を推奨します。

JavaScript コード生成前後の処理

  • SorceMap の生成(リリース版は除く)
  • Lint を通す
  • 圧縮する(Uglify, gzip化。production ビルドだけでいい)

lint、型チェック

lint

eslint は必ず行ってください。
webpack で保存のたびに eslint が実行されるようにすると便利です。
eslint のルールは airbnb-base が入っていると、
非効率な書き方を指摘してくれるので好きです。
.eslintrc の extend の記述の順番で @typescript-eslint/recommended と併用ができます。

型チェック

Babel では TypeScript の型チェックができないので、
別途行う必要があります。

husky を使って git のコミット前に型チェックを行うように設定すると漏れがなくなります。

ライブラリ

案件でよく使っているもの

案件でよく使っているライブラリです。
必要に応じてカスタムビルドを行うなど、サイズを調整しつつ利用してください。

使用ライブラリ選定について

使用するライブラリはなるべく下記の項目を基準にして選定してください。

  • 広く動作確認が行われている
  • 多機能すぎない

テスト

  • 不安なところ
  • 複雑になってしまったところ

は、出力結果が確認できるテストをコードに残すようにしてください。
(自動化はできる範囲で実装していきましょう!)

その前に、「テストしやすい単位で機能を開発しているか」を意識することは
とても大切だと思っています。
クリーンアーキテクチャの考え方がとても参考になるのですが、
言葉が難しいのと従来の HTML と JavaScript だとレイヤーがずれてしまうので
フロントエンドでは下記のポイントを抑えてもらえると良いと思います。

  • DOM に関わる処理とデータの処理部分はできるだけ分ける
  • 関数は機能を絞り、役割を明確にする
  • データの保存、取得は独立した関数にする

テスティングフレームワークは Jest が使いやすかったです。

JavaScript Tips

JavaScript を書くうえで、こうしたほうが良い、というのをまとめました。

セレクターの取得

JavaScript の queryselector などでセレクターを取得する時、
できるだけ CSS のクラス名を避けたほうが良いです。

<!-- 非推奨 -->
<button class="button">ボタン</button>

<style>
.button {
  display: inline-block;
}
</style>

<script>
const btn = document.querySelectorAll('.button');
</script>
<!-- 推奨 -->
<button class="button" data-role="submit">ボタン</button>

<script>
const btn = document.querySelectorAll('[data-role="submit"]');
</script>
  1. CSS のクラス名を変えた場合、Javascript にも変更を適用しなくてはいけない
  2. 同じスタイルを反映させるためにクラス名を使いまわした時、JavaScript イベントハンドラも一緒にくっついてきてコーディングの自由度が下がる

という欠点があるためです。

高頻度イベント処理を最適化する

スクロールやリサイズなど連続して発火するイベントで、DOM のレイアウトプロパティにアクセスするとブラウザの処理能力が落ちます。
そのため、下記の最適化を行ってください。

  1. イベント検知と描画ロジックを分ける書き方をする
  2. イベントの間引き(throttle, debounce)を行う

処理が遅くなる理由

layers.png

画像:ブラウザの仕組み: 最新ウェブブラウザの内部構造

JavaScript で DOM レイアウトプロパティにアクセスすると、
JavaScript インタプリタの処理が中断され、レンダリングエンジンにレイアウトの再計算を求めます。
レイアウト計算結果が戻ってから JavaScript の処理が再開されるので、
スクロールなどで高頻度に DOM にアクセスすると
レンダリングエンジン - JavaScript インタプリタでの処理が増え、
結果として描画(レイアウト処理後に行われる)が遅くなります。

throttle, debounce

throttle は連続発生したイベントの、間引きになります。
scroll イベント向きです。

debounce は指定時間内に起こったイベントの最後のタイミングで処理されます。
resize や touchmove で使われます。

requestAnimationFrame などを使って自前で実装しても良いのですが、
throttle-debounce という npm パッケージが使いやすいです。

intersection observer

スクロールに連動した DOM 要素の変更(パララックスとか lazyload )が
かなり効率化できるようになります。
IE11 には非対応ですが、モダンブラウザで広く使えるようになりました。
(でも iOS safari 12.1 以前が未対応は注意)

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
313
Help us understand the problem. What are the problem?