Назад | Перейти на главную страницу

Почему официальное руководство по стилю Puppet настаивает на выровненных жирных стрелках?

Из http://docs.puppetlabs.com/guides/style_guide.html:

Все жирные стрелки-запятые (=>) в списке атрибутов / значений ресурса должны быть выровнены. Стрелки следует размещать на один пробел перед самым длинным именем атрибута.

Это кажется контрпродуктивным. Возьмем их «плохой» пример:

exec { 'test':
  subscribe   => File['/etc/test'],
  refreshonly => true,
}

Если вы добавили атрибут, имя которого длиннее, чем «refreshonly», вам придется перестроить все эти стрелки, например:

exec { 'test':
  subscribe       => File['/etc/test'],
  refreshonly     => true,
  somenewproperty => whatever,
}

Каждый атрибут в этом ресурсе необходимо будет изменить, чтобы изменить одну строку. Это запутывает историю ревизий и лишает смысла помещать конечную запятую в конце объявления атрибута / значения (в противном случае добавление нового attr / val потребует добавления запятой к предыдущей последней строке, в результате чего две строки быть измененным вместо одного).

Почему официальное руководство по стилю Puppet рекомендует это соглашение?

Большинство соглашений о стилях затрагивают несколько моментов:

  • Улучшение читабельности.
  • Отговаривайте людей от вредных привычек в коде.
  • Призывайте людей к давно принятым практикам (какими бы плохими они ни были).

Выравнивание жирных стрелок - это стиль удобства чтения.