Автор оригинала: FreeCodeCamp Community Member.
Артем Сапегин
Раньше я думал, что стиль персонального кода – это хорошо для программиста. Он показывает, что вы являетесь зрелым разработчиком, который знает, какой хороший код должен выглядеть.
Мои профессора колледжа сказали мне, что знают, когда некоторые из моих одноклассников использовали свой код в своей работе из-за другого стиля кода. Теперь я думаю, что это потому, что мой код по крайней мере как минимум отформатирован, и все остальные были беспорядком.
С тех пор я провел много времени спорить стиль кода и настроить инструменты для его применения. Пришло время для изменения.
Несколько примеров
После прочтения Камень программистов Я положил брекеты, как это в течение длительного времени:
if (food === 'pizza'){ alert('Pizza ;-)'); }else{ alert('Not pizza ;-(');}Но тогда я понял, что я могу быть единственным, кто сделал это таким образом в предельном сообществе. Все остальные используют этот стиль:
if (food === 'pizza') { alert('Pizza ;-)'); } else { alert('Not pizza ;-(');}Или это:
if (food === 'pizza') { alert('Pizza ;-)'); }else { alert('Not pizza ;-(');}Так что я изменил свой стиль до последнего.
Мне нравится этот стиль для цепочки очень много:
function foo(items) { return items .filter(item => item.checked) .map(item => item.value) ;}Я вижу те же преимущества рефакторинга, что и для Трейлинг запятые :
const food = [ 'pizza', 'burger', 'pasta',]
Но я, вероятно, даже более одинокий с этим стилем, чем я с брекетами. Никто никогда не отправит мне код для обзора с этим стилем, никто не может принять его. Поэтому я должен прекратить использовать его, чтобы быть ближе к реальному миру.
Есть еще одна вещь, которую никто не делает, кроме меня. Я всегда кладу два пробела перед предыдущим комментарием:
const volume = 200; // ml
Я думал, что это улучшает читаемость. Но это на самом деле делает кодовую базу непоследовательной, потому что другие разработчики помещают только одно пространство.
Какие разработчики JavaScript делают
К сожалению, JavaScript не имеет официального стиля кода. Есть несколько Популярные стили кода как Airbnb или Стандартный . Вы можете использовать их, чтобы ваш код выглядел знакомым для других разработчиков.
Вы могли бы использовать Eslint Для обеспечения соблюдения стиля кода и даже код автоформата в некоторых случаях. Но это не сделает вашу кодовую базу 100% последовательным. ESLINT с конфигурацией Airbnb будет нормализовать только мой первый пример и разрешить несоответствие в двух других примерах.
Какие разработчики JavaScript должны сделать
Некоторые языки имеют строгие стили кода и инструменты для форматирования кода. Таким образом, разработчики не тратят время спорить в стиле кода. Смотри на Refmt по причинам и Rustfmt для ржавчины.
Это похоже на JavaScript, наконец имеет решение к этой проблеме. Новый инструмент под названием Прекраснее Переформатируйте ваш код, используя свои собственные правила. Он полностью игнорирует, как был написан код в первую очередь.
Давайте Попробуйте красивее На моих примерах:
if (food === 'pizza') { alert('Pizza ;-)');} else { alert('Not pizza ;-(');}function foo(items) { return items.filter(item => item.checked).map(item => item.value);}const volume = 200; // mlВы можете не согласиться с этим стилем. Например, мне не нравится еще Размещение и запись функционных цепей в одной линии сомнительны. Но я вижу огромные преимущества в принятии красивее:
- Практически нет решений, чтобы сделать – красивее имеет несколько вариантов.
- Не споря о конкретных правилах, если вы работаете в команде.
- Не нужно изучать стиль кода вашего проекта для участников.
- Нет необходимости исправлять проблемы стиля, сообщаемых Eslint.
- Можно настроить AutoFormat в файле Сохранить.
Заключение
Прекрас уже был принят Некоторые популярные проекты как реагировать и бабел. И я начинаю Преобразовать все мои проекты от моего пользовательского стиля кода, чтобы красивее. Я порекомендую его вместо стиля кода Airbnb.
Сначала у меня было много «Тьфу, это уродливых» моментов с красивее. Но когда я думаю, что мне придется, например, например, вручную переформатируйте код JSX из одноразового на многострочную, когда добавляю еще один опорный, и он не подходит на одну строку – я понимаю, что это стоит того.
Прочитайте, как Настроить красивее в вашем проекте.
П. С. Посмотрите на мой новый инструмент Это упростит добавление Eslint, красивее и других инструментов для вашего проекта, а также сохраняя их конфиги в синхронизации.
Подписаться на мою рассылку: https://tinyletter.com/sapegin
Оригинал: “https://www.freecodecamp.org/news/why-robots-should-format-our-code-159fd06d17f7/”