Руководство по стилю
Это официальное руководство по стилю для кода на Vue. Если вы видите Vue в проекте, это руководство поможет избежать ошибок, "велосипедов" и анти-паттернов. Однако, мы не считаем, что любое такое руководство является идеалом для всех команд или проектов, поэтому приветствуются разумные отклонения, основанные на прошлом опыте, окружающем вас технологическом стеке и личных ценностях.
По большей части мы также избегаем предложений насчет JavaScript и HTML в целом. Мы не против, если вы используете точку с запятой или висячую запятую. Мы не против, если ваш HTML использует одинарные или двойные кавычки для значений атрибутов. Однако есть и исключения, когда мы обнаружили, что тот или иной паттерн полезен в контексте Vue.
По итогу, мы разделили правила на четыре категории:
Категории правил
Правила приоритета А: Основные (Предотвращение ошибок)
Эти правила помогают избегать ошибок, поэтому выучите и соблюдайте их во что бы то ни стало. Исключения могут присутствовать, но очень редко и совершаться теми, кто обладает высокой экспертизой насчет JavaScript и Vue.
Правила приоритета B: Настоятельно рекомендуются
Эти правила помогают улучшить читаемость и/или опыт разработчика в большинстве проектов. Ваш код все равно выполнится, если вы их нарушите, но эти нарушения должны быть редкими и обоснованными.
Правила приоритета C: Рекомендуются
При наличии нескольких одинаково хороших вариантов можно сделать произвольный выбор, чтобы обеспечить консистентность. В этих правилах мы описываем каждый приемлемый вариант и предлагаем выбор по умолчанию. Это означает, что вы можете выбрать разный вариант в собственной кодовой базе, пока вы соблюдаете консистентность и у вас есть веская причина. Пусть у вас будет действительно веская причина! Приспосабливаясь к стандарту общества, вы сможете:
- Гораздо проще понимать большинство кода сообщества, который вы встретите
- Копировать и вставлять большое количество примеров кода сообщества без дальнейшей модификации
- Чаще находить сотрудников, которые уже привыкли к предпочитаемому стилю кода, по крайней мере, в отношении Vue
Правила приоритета D: Используйте с осторожностью
Vue предоставляет некоторые возможности, которые обеспечивают "плавный" процесс миграции с устаревшей кодовой базы и учитывают редкие случаи. Если их использовать слишком часто, они могут сделать код сложно поддерживаемым или могут быть источниками багов. Эти правила "освещают" рисковые возможности Vue, объясняя, где и почему их стоит избегать.