CSSコーディングスタイル

作成中です - Mitsuhiro Yoshida (トーク)

概要 Overview

範囲

このドキュメントではMoodleコードを扱う開発者のためのスタイルガイドラインを説明します。純粋にコードレイアウトのメカニズムおよびMoodleのための私たちの選択についてのみ説明します。

ゴール

一貫したコーディングスタイルはどのような開発プロジェクトにおいても重要であり、特に多くの開発者が関わる場合はなおさらです。標準的なスタイルではコードが読みやすく理解しやすいものとなるため、全体的な品質向上にもつながります。

私たちが目指す目標概要:

• 簡潔性
• 可読性
• ツールの利便性

便利なツール

私たちはコーディングスタイルへの適合性を確認するため、stylelintを使用しています。また、stylefmtはCSSを自動的に再フォーマットするために使用できます - 詳細はLintingをご覧ください。

ファイルネーミング

通常、CSSファイルはプラグイン内で

styles.css

というファイル名になります。

テーマのファイル名はテーマデザイナの希望に沿ったものにできますが、以下に従ってください:

• 小文字および「-」で単語を区切ること。
• 可能な限り簡潔にすること。
• 説明的であること。
• CSSファイルの場合は

  style/
  

  フォルダ、LESSファイルの場合は

  less/
  

  のフォルダに置くこと。

ブロック

• 各セレクタは1行にまとめてください。セレクタのリストにカンマがある場合、カンマの後に改行を入れてください。
• プロパティと値のペアはそれぞれの行を4つの半角スペースでインデントして最後にセミコロンを付けてください。
• 閉じブレースは開始セレクタと同じレベルのインデントを使用する必要があります。
• ブロック間は1行空けてください。

正しい

@media only screen and (min-width: 768px) {
    .selector-one,
    .selector-two {
        color: #fff;
        background-color: #000;
    }
}

間違い

.selector_one, .selector_two { color: #fff; background-color: #000; }

セレクタ Selectors

• Always use lower case and underscores or hyphens. Hyphens are preferred.
• 必ず小文字およびアンダースコアまたはハイフンを使用してください。ハイフンの使用を推奨します。
• Names should be made of simple English words.
• 名称は簡単な英単語で構成されるべきである。
• Verbosity is encouraged: names should be as illustrative as is practical to enhance understanding.
• 表現力を重視します。理解を深めるため、名称はできるだけ例示的にしてください。
• Use semantic names: names tell what this is instead of what should it look like.
• 意味のある名称の使用: 名称はどのように見えるのかではなく、これが何であるのか伝えてください。
• Avoid using IDs. They are far more difficult to maintain and override.
• IDの使用は避けてください。IDを使用した場合、メンテナンスおよびオーバーライドが極めて困難になります。
• Do not over-qualify your rules by combining a tagname with a class or ID.
• タグネームとクラスまたはIDを組み合わせて過度にルールを限定しないでください。

正しい Correct

.selector_name {
    color: #fff;
}

.selector-name {
    color: #fff;
}

間違い Incorrect

div#selName {
    color: #fff;
}

.Color-White {
    color: #fff;
}

プロパティおよび変数 Properties and values

• Should be separated by a colon and a single space, do not minify them.
• Should be lowercase, except for font names and vendor-specific properties.
• For color codes, lowercase is preferred and a shorthand whenever possible.
• For color codes, if you use HSLA or RGBA, always provide a hex fallback.
• Use shorthand (except when overriding styles) for background, border, font, list-style, margin, and padding values.
• Do not use

  !important
  

  . If there is no alternative something is wrong with the CSS you are trying to override.
• Prefixed vendor-specific properties pairs should appear directly before the generic property they refer to.

単位 Units

• Allowed CSS units are px, rem, and em.
• Do not declare the unit when the value is 0.

正しい Correct

.something {
    margin-top: 0;
    font-size: 1.25em;
}

間違い Incorrect

.something {
    margin-top: 0px;
    font-size: 1pt;
}

ドキュメンテーションおよびコメント Documentation and comments

Following the general Coding style, comments should start with a capital letter and end with a period.

A block-style comment at the top of the CSS file should explain the purpose of the rules in the file.

/**
 * File base.css.
 * Contains base styles for theme basic.
 */

Block-style comments can also be used to denote a section in a CSS file where all rules pertain to a specific component, view, or functionality:

/**
 * SCORM Navigation Sidebar.
 */

Use single-line comments to provide more information to other developers about a single rule or small subset of rules:

/* Required because YUI resets add a black border to all tables */

プログレッシブエンハンスメント Progressive enhancement

• Fallbacks should always be provided. For example, provide a background color fallback to background images and gradients.
• Use vendor prefixes only when the supported browser in question does not support the unprefixed property.
• The standard property should come after the vendor-prefixed property.

.selector {
    background-color: #444; /* Fallback for browsers that don't support gradients. */
    filter: progid:DXImageTransform.Microsoft.gradient(startColorStr='#444', EndColorStr='#999'); /* IE6-IE9. */
    background-image: -webkit-gradient(linear, left top, left bottom, from(#444), to(#999)); /* Safari 4+, Chrome. */
    background-image: -webkit-linear-gradient(top, #444, #999); /* Chrome 10+, Safari 5.1+, iOS 5+. */
    background-image: -moz-linear-gradient(top, #444, #999); /* Firefox 3.6. */
    background-image: -ms-linear-gradient(top, #444, #999); /* IE10. */
    background-image: -o-linear-gradient(top, #444, #999); /* Opera 11.10+. */
    background-image: linear-gradient(top, #444, #999); /* W3C Standard. */
}

ブラウザハック Browser Hacks

• Do not use any browser-specific hacks. Moodle provides a more appropriate way to write browser-specific CSS using classes that are added to the body element. For example:

.ie7 .forum-post {
    min-height: 1px;
}

• It is not necessary to include hacks for versions of browsers that Moodle core does not provide support for (e.g. IE8 in Moodle 3.0).

プラグイン Plugins

In plugins, the file names can be:

• styles.css (Recommended)
• styles_<theme name>.css (Not recommended, reserved to 3rd party plugins)

プラグインではファイル名は以下のようにできます:

• styles.css (推奨)
• styles_<テーマ名>.css (非推奨、サードパーティ製プラグインに限ります)

必要最小限 Barebones

Plugins should define the strict minimum, no text sizes, colours, etc ... those should belong to the theme and not be hardcoded in plugins to allow for easy theming. Of course, this requires Moodle core to provide re-usable classes to style the elements. As Moodle 2.7 has made Bootstrap 2 by default we can start using their classes, but we should make sure that there is a sensible fallback for themes not extending bootstrapbase, such as base.

右から左へ Right-to-left

Since Moodle 3.2, most of the work is automatically done for developers.

自動フリッピング Auto flipping

Using the tool RTLCSS-PHP, the styles are automatically flipped when the language is right-to-left. However, as there always are a few exceptions, special comments can be added to the CSS files to prevent rules from being flipped, etc...

Here is an example.

.hello-world {
    margin-left: 10px;
    /*rtl:ignore*/
    padding-left: 10px;

    background: url('logo.png') 0 0 no-repeat;
    /*rtl:raw:
    background-image: url('logo-rtl.png');
    */

    color: blue;
}

Will become:

.hello-world {
    margin-right: 10px;
    padding-left: 10px;

    background: url('logo.png') 0 100% no-repeat;
    background-image: url('logo-rtl.png');

    color: blue;
}

For more information on the special comments, refer to the documentation of the tool RTLCSS-PHP.

注意事項 Caveats

It is important to note that the special comments must NOT end a file or a rule block. All comments not preceding a block, or a rule are ignored. Or in other words: currently the comments must always precede a statement, they will not work if they are not followed by anything.

Also note that comments in SCSS or LESS will often not produce the desired effect. When dealing with SCSS and LESS, ensure that your special RTL comments are attached to pure CSS statements: no

@extend

, indented rules, etc...

テキストの方向を強制する Forcing the text direction

Whilst

.dir-rtl

should not be used any more, we've added

.text-ltr

which allows developers to force the direction of the text to left-to-right. This is especially needed for forms fields like: URLs, OS level Folders paths & apps, theme hex colors, English DB field names, emails, English text, numbers, regular expression patterns, symbols, code snippets or configuration samples.

LESS

LESS works like CSS with some extra features. It should follow the CSS guidelines.

変数 Variables

• They should use camelCase to follow Bootstrap 2 that is used in core.
• As for CSS selectors, use semantic names: names tell what this is instead of what should it look like.
• As Bootstrap 2 does, do not add the word "Color" to variables for _background_ or _border_ and their derivatives.
• Declaring new variables should be done sparingly, too many variables kill the purpose of using them. If you declare one, try to set its default value from another one.
• Do not declare more variables than necessary. E.g.: If the background color and border color are likely to always be the same, prefer one variable.

正しい Correct

@textColor: red;
@wellBackground: #ccc;
@tableBackground: blue;
@blockBackground: @wellBackground;
@calendarGroupEvent: #f90;

間違い Incorrect

@text-color: red;
@wellBackground: #ccc;
@tableBackgrounColor: blue;
@blockBackground: #ccc;
@calendarGroupEventBackground: #f90;
@calendarGroupEventBorder: #f90;

セレクタ Selectors

• Selectors should be encapsulated rather than duplicated.

正しい Correct

div {
    .something {
        color: red;
        a {
            color: blue;
        }
    }
    .something-else a {
        color: green;
    }
}

間違い Incorrect

div .something {
    color: red;
}
div .something a {
    color: blue;
}
div .something-else a {
    color: green;
}

値およびプロパティ Values and properties

• Colours, font sizes, etc... should never be hardcoded. You should, where possible, use a variable instead.
• The use of 'mixins' is encouraged instead of duplicating values and properties.

正しい Correct

.error {
    font-size: @fontSizeSmall;
    color: @errorText;
    padding: 1em;
    background-color: @errorBackground;
}
div .form-error {
    .error;
}

間違い Incorrect

.error {
    font-size: 12px;
    color: red;
    padding: 1em;
    background-color: white;
}
div .form-error {
    font-size: 12px;
    color: red;
    padding: 1em;
    background-color: white;
}

テーマ「Clean」および「More」 Themes Clean and More

Clean theme should, where possible, not contain any CSS or LESS content. More theme, in comparison, inherits CSS styles for the logo from Clean theme, but also contains a small amount of LESS as an example for when customising a theme. Both Clean and More inherit fully all the CSS from their parent theme 'Bootstrap Base'. Cleanテーマは可能な限りCSSまたはLESSのコンテンツを含まないようにしています。それに比べてMoreテーマはロゴのCSSスタイルをCleanテーマから継承していますが、テーマのカスタマイズ時の例として少量のLESSも含んでいます。CleanおよびMoreは親テーマである「Bootstrap Base」からすべてのCSSを完全に継承しています。

謝辞 Credits

This document was drawn from the following sources:

1. The WordPress CSS Coding Standards

関連情報

• コーディングスタイル
• Javascriptコーディングスタイル
• コーディング