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

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

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


スタイルガイドについて

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

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

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


ESLint プラグイン

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

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

https://github.com/vuejs/eslint-plugin-vue

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

https://qiita.com/ota-meshi/items/85bf17494c8ea0be05d7


この記事を書くきっかけ

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

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

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

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


簡易リファレンス

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

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

※ 一部複数箇所に出てくる内容もあります。


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


命名規則


その他


テンプレート


タグ


プロパティ(属性)


その他


JavaScript


データ


命名規則等


CSS


まとめ

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

コメント

このブログの人気の投稿

投稿時間:2020-07-01 05:34:30 RSSフィード2020-07-01 05:00 分まとめ(37件)

投稿時間:2020-07-01 20:43:40 RSSフィード2020-07-01 20:00 分まとめ(81件)

投稿時間:2020-07-01 08:33:22 RSSフィード2020-07-01 08:00 分まとめ(49件)