Пытаетесь настроить правила ESLint для своего проекта? Знаете ли вы лучшие правила ESlint для качества кода? Ознакомьтесь с правилами, которым следуют ведущие компании.
Как разработчик, вы хотите, чтобы ваш код был не только функциональным, но и удобным в сопровождении, масштабируемым и эффективным. Для этого необходимо следовать передовым отраслевым практикам и стандартам кодирования, которые, как было доказано, улучшают качество кода и уменьшают количество багов и ошибок. ESlint — это мощный инструмент, который может помочь вам добиться этого, применяя набор правил и рекомендаций для вашей кодовой базы. В этой статье мы более подробно рассмотрим некоторые из лучших правил ESlint для лучших практик и способы их использования для улучшения вашей кодовой базы.
Спасибо за внимание ко второй статье из серии «Лучшие практики написания кода»! Мы здесь, чтобы помочь вам улучшить свои навыки кодирования и добиться успеха в ваших проектах по программированию с помощью наших советов и методов экспертов. Если вы пропустили первую статью, вы можете найти ее по ссылке ниже.
Какие правила выбрать?
Это личное предпочтение. Использование табуляции или пробелов для отступов, двойных или одинарных кавычек, добавление точки с запятой в конце строки или нет, в конечном счете, является личным выбором разработчиков. Когда вы работаете над проектом в одиночку, принимать такие решения легко.
Однако при работе в команде может быть сложно прийти к единому мнению о наборе правил, которым нужно следовать, поскольку члены команды часто имеют разные предпочтения. Некоторые могут предпочесть одинарные кавычки, в то время как другие могут предпочесть двойные кавычки. Точно так же некоторые члены команды могут захотеть использовать точку с запятой в конце каждой строки, а другие — нет. Это может привести к бесконечным дебатам при попытке завершить набор правил, даже если выбранные правила не будут напрямую влиять на производительность проекта. Несмотря на это, очень важно установить согласованный набор правил, чтобы обеспечить удобство сопровождения и удобочитаемость кода.
Решение
Споры о стиле бессмысленны. Должно быть руководство по стилю, и вы должны следовать ему.
— Ребекка Мерфи
Ведущие компании часто следуют установленным наборам правил, когда речь идет об ESLint, и эти правила можно легко реализовать в вашем проекте всего за несколько кликов. Стандартный стиль JavaScript, также известный как standard, является одним из таких пакетов, который предлагает исчерпывающий набор рекомендаций по поддержанию качества и согласованности кода. Установив этот или другие подобные стандартные пакеты, вы можете сэкономить время и силы, решая, каким конкретным правилам следовать, и вместо этого сосредоточиться на разработке высококачественного кода, который соответствует общепризнанным рекомендациям.
Почему Стандарт?
Весь смысл standard заключается в том, чтобы сэкономить ваше время, избегая зацикливания на стиле кода. В Интернете много споров о табуляциях и пробелах и т. д., которые никогда не будут решены. Эти дебаты только отвлекают от работы. В конце концов, нужно просто что-нибудь выбрать, и в этом вся философия standard — это куча разумных мнений типа просто выбери что-нибудь.
Стандартный стиль JavaScript
Прелесть стандартного стиля JavaScript в том, что он простой. Никто не хочет поддерживать несколько файлов конфигурации в стиле сотен строк для каждого модуля/проекта, над которым они работают. Хватит этого безумия!
Этот модуль экономит ваше (и других!) время тремя способами:
– Без настройки. Самый простой способ обеспечить единообразие стиля в вашем проекте. Просто бросьте это.
— Автоматическое форматирование кода. Просто запустите standard --fix и попрощайтесь с беспорядочным или непоследовательным кодом.
— Выявляйте проблемы со стилем и ошибки программиста на ранней стадии: экономьте драгоценное время проверки кода, устраняя обмен мнениями между рецензентом и участником.
Когда мы принимаем стандартный стиль кодирования, мы придаем большее значение тому, чтобы наш код был понятным и следовал согласованным с сообществом практикам, чем выражению нашего собственного стиля кодирования.
Установить стандарт
Самый простой способ использовать стандартный стиль JavaScript — установить его глобально как программу командной строки Node. Выполните следующую команду в Терминале:
$ npm install standard --global
Или вы можете установить standard локально для использования в одном проекте:
$ npm install standard --save-dev
Использовать
После того, как вы установили standard, вы сможете использовать программу standard. Самым простым вариантом использования будет проверка стиля всех файлов JavaScript в текущем рабочем каталоге:
$ standard Error: Use JavaScript Standard Style lib/torrent.js:950:11: Expected '===' and instead saw '=='.
Если вы установили standard локально, вместо этого запустите npx:
$ npx standard
При желании вы можете передать каталог (или каталоги), используя шаблон glob. Обязательно заключайте в кавычки пути, содержащие шаблоны глобусов, чтобы они расширялись на standard вместо вашей оболочки:
$ standard "src/util/**/*.js" "test/**/*.js"
Запустить в npm-скрипте
Добавьте его в package.json
{
"name": "my-cool-package",
"devDependencies": {
"standard": "*"
},
"scripts": {
"test": "standard && node my-tests.js"
}
}
Стиль проверяется автоматически при запуске npm test
$ npm test Error: Use JavaScript Standard Style lib/torrent.js:950:11: Expected '===' and instead saw '=='.
Плагины редактора
— Visual Studio Code: установите vscode-standard. (Включает поддержку автоматического форматирования.)
— Atom: Установить linter-js-standard.
Есть поддержка других редакторов также. Вы можете ознакомиться со всем списком поддерживаемых редакторов здесь.
Хотите проверить правила, которым следует Стандарт?
С правилами можно ознакомиться здесь. Для JSX существуют отдельные правила, с которыми вы можете ознакомиться здесь.
Кто использует стандартный стиль JavaScript?
Стандарт используют node.js, npm, GitHub, express, Electron, mongoDB и т. д. Весь список можно посмотреть здесь.
Можем ли мы настроить правила ESLint?
Нет. Весь смысл standard заключается в том, чтобы сэкономить ваше время, избегая зацикливания на стиле кода.
Все равно хотите настроить?
Вы можете использовать eslint-config-standard, чтобы использовать правила, предоставленные standard, и переопределять некоторые правила или добавлять новые правила.
$ npm install eslint-config-standard --save-dev
В .eslintrc вы можете расширить правила standard, а также переопределить правила и добавить некоторые новые правила, такие как:
{
"extends": ["standard"],
"rules": [
"quotes": ["error", "double"],
"rest-spread-spacing": ["error", "always"],
"semi": ["error", "always"]
]
}
Каковы некоторые другие популярные правила ESLint?
Существуют правила ESLint, предоставленные airbnb и google. Вы можете установить и использовать эти правила, перейдя по этим ссылкам:
— airbnb — https://www.npmjs.com/package/eslint-config-airbnb
— google — https:// www.npmjs.com/package/eslint-config-google
Заключение
Весь код в любой кодовой базе должен выглядеть так, как будто его написал один человек, независимо от того, сколько людей внесли свой вклад.
В конечном счете, конкретные правила ESLint, которые вы выберете, могут быть не так важны, как обеспечение того, чтобы вы и ваша команда последовательно придерживались их на протяжении всего проекта. Независимо от того, решите ли вы использовать двойные или одинарные кавычки, разрешать или запрещать точку с запятой или выбирать между табуляциями и пробелами, ключ в том, чтобы установить четкий и последовательный стиль и придерживаться его. Хотя выбранные вами правила ESLint не будут напрямую влиять на производительность вашего проекта, решение о том, каким правилам следовать, может вызвать бесконечные споры между членами команды. Это связано с тем, что такие решения часто основаны на личных предпочтениях, а не на стандартных эмпирических правилах.
В заключение, правила ESLint служат важнейшим инструментом для поддержания качества кода и согласованности при разработке программного обеспечения. В этой статье мы изучили некоторые передовые методы, которым следуют ведущие компании, такие как Airbnb и Google, и узнали, как эти правила могут быть реализованы в наших собственных практиках кодирования. Соблюдение правил ESLint не только обеспечивает более высокий уровень качества кода, но также способствует лучшему сотрудничеству в команде и снижает вероятность ошибок и багов. Включив эти правила в наши процессы кодирования, мы можем создавать более эффективные, удобные в сопровождении и надежные программные продукты.
Спасибо за чтение, и обязательно следите за обновлениями следующих частей этой серии, следуя за мной.
