[{"document_url": "https://vuejsfeed.com/blog/official-style-guide-for-vue-specific-code", "unformatted_src": "https://vuejs.org/images/tmvuejs2.png", "src": "https://vuejs.org/images/tmvuejs2.png", "formatted_filename": "tmvuejs", "alt_text": "The Majesty of Vue.js 2", "rendered_height": 67}, null, {"document_url": "https://vuejsfeed.com/blog/official-style-guide-for-vue-specific-code", "unformatted_src": "https://d2jq2hx2dbkw6t.cloudfront.net/593/vuejs-official-style-guide.jpg", "src": "https://d2jq2hx2dbkw6t.cloudfront.net/593/vuejs-official-style-guide.jpg", "formatted_filename": "vuejs official style guide", "alt_text": "Blog image"}, null, {"document_url": "https://vuejsfeed.com/blog/official-style-guide-for-vue-specific-code", "unformatted_src": "https://i.imgur.com/nZmHsjA.png", "src": "https://i.imgur.com/nZmHsjA.png", "formatted_filename": "nZmHsjA"}, null, {"document_url": "https://vuejsfeed.com/blog/official-style-guide-for-vue-specific-code", "unformatted_src": "/img/majesty-vuejs-2.png", "src": "https://vuejsfeed.com/img/majesty-vuejs-2.png", "formatted_filename": "majesty vuejs", "alt_text": "The Majesty of Vue.js"}, null]

Official Style Guide for Vue-specific code

style guide for Vue.js

An official style guide (beta) for Vue-specific code has been released. Chris Fritz announced the style guide on Twitter.

Chris Fritz announced style guide

You can find it under the Learn list on the homepage of vuejs.org. This guide comes before version 2.5 of Vue, planned to be released in this October. The Beta version of the guide can help developers avoid common errors and pitfalls by dividing rules into four categories. This is meant to be the best reference when building your projects but the team has made some comments about this guide:

However, we don’t believe that any style guide is ideal for all teams or projects, so mindful deviations are encouraged based on past experience, the surrounding tech stack, and personal values. For the most part, we also avoid suggestions about JavaScript or HTML in general. We don’t mind whether you use semicolons or trailing commas. We don’t mind whether your HTML uses single-quotes or double-quotes for attribute values. Some exceptions will exist, however, where we’ve found that a particular pattern is helpful in the context of Vue.

Also, Chris Fritz said in one reply: Just keep in mind it's a living document and in beta, so it's likely to go through some changes in the next month especially.

Rule Categories

The rules fall into four categories A, B, C, & D, from higher priority to lowest.

Priority A: Essential

These rules help prevent errors, so learn and abide by them at all costs. Exceptions may exist, but should be very rare and only be made by those with expert knowledge of both JavaScript and Vue.

Priority B: Strongly Recommended

These rules have been found to improve readability and/or developer experience in most projects. Your code will still run if you violate them, but violations should be rare and well-justified.

Priority C: Recommended

Where multiple, equally good options exist, an arbitrary choice can be made to ensure consistency. In these rules, we describe each acceptable option and suggest a default choice. That means you can feel free to make a different choice in your own codebase, as long as you’re consistent and have a good reason. Please do have a good reason though! By adapting to the community standard, you will: train your brain to more easily parse most of the community code you encounter be able to copy and paste most community code examples without modification often find new hires are already accustomed to your preferred coding style, at least in regards to Vue

Priority D: Use with Caution

Some features of Vue exist to accommodate rare edge cases or smoother migrations from a legacy code base. When overused, however, they can make your code more difficult to maintain or even become a source of bugs. These rules shine a light on potentially risky features, describing when and why they should be avoided.

Soon, we’ll also provide tips for enforcement. Sometimes you’ll simply have to be disciplined, but wherever possible, we’ll try to show you how to use ESLint and other automated processes to make enforcement simpler.

Visit the page and share your feedback with the team!







