7
8

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Vue.js #2Advent Calendar 2018

Day 24

Vue.js スタイルガイド 分野別簡易リファレンス

Last updated at Posted at 2018-12-23

こちらは Vue.js #2 Advent Calendar 2018 の 24 日目です。

スタイルガイドについて

本家 Vue.js スタイルガイドはこちら

これは、「Vue.js はこのように (書くべき|書いたほうがいい)ですよー」というものをまとめた、大変ありがたいドキュメントです。

公式が書いているソースコードは全てこれに則って書かれています(そのはずです)。そして、全世界の Vue.js ユーザもこれになるべく近い形でコーディングするべきです。

ESLint プラグイン

こちらもありがたいことに、全てではないものの、スタイルガイドに則っているかをチェックしてくれる ESLint プラグインがあります。

機械的にチェックできるものは機械にやらせましょう!

今回のアドベントカレンダーで、プラグインのコラボレーターの方が記事を書かれています。チェケラ!

この記事を書くきっかけ

コンポーネント外・テンプレートから呼ばれないメソッドの命名規則について、一部のローカルルールで「メソッド名の先頭に_をつける」というものがあるかと思います。

そちらを採用しようとしたところ、実は Vue.js スタイルガイドで禁止されていたため、「これは案外知られていない・意外なルールがあるのでは?」と思いました(しかも優先度 A)。

スタイルガイドを広めるということと、「今北一業」で一覧できるリファレンスがあると捗るなと感じたので、自分で書いてしまえと思った次第です。

また、さらっと調べた限りでは公式と同じ書き方をしているページしか見つけられなかったので、自分なりにわかりやすく、分野別に編集したものを書いてみようと思います。

簡易リファレンス

内容(優先度) としています。

自分がぱっと見で理解できるように書いたので、分かりづらい部分もあるかと思いますが、ご了承ください。(逆に「自分ならこう書く!」といったリファレンスを作るのもありです!)
※ 一部複数箇所に出てくる内容もあります。

コンポーネント・ファイル

命名規則

その他

テンプレート

タグ

プロパティ(属性)

その他

JavaScript

データ

命名規則等

CSS

まとめ

誰が見てもわかりやすく書くために、できるだけ公式のスタイルガイドに則った開発をしていきましょう!

7
8
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
7
8

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?