Автор оригинала: FreeCodeCamp Community Member.
Стивеном Гилберта
Если вы хотите внести свой вклад в проекты с открытым исходным кодом, такие как FreeCodeCamp, сначала вам нужно будет настроить линтам.
Большинство проектов имеют свои собственные стандарты стилей для JavaScript, и они будут автоматически принудительными инструментами, такими как Eslint Отказ
Давайте настроим Eslint для запуска Атом один из самых популярных редакторов кодов.
Прежде чем мы начнем, вот быстрые головы, которые я делаю несколько предположений:
- Вы следовали Руководящие принципы вклада лагеря Free Code до части, которая читает Установка свита.
- И так вы установили необходимые Предпосылки (особенно Node.js и NPM).
- У вас есть хотя бы основное понимание использования командная строка и Гит Отказ
- Вы используете Атом В качестве текстового редактора (хотя эта статья должна быть полезной, даже если вы не должны просто проверить свой Text Editor’s Документация для инструкций относительно Eslint)
Что именно отличается?
И Eslint это Ребячий инструмент специфично для кода JavaScript. Вы используете ESLINT, чтобы найти проблемный код («ошибки»), написанные в JavaScript.
Кстати, «ES» в названии Eslint поступает из «Ecmascript», которое является официальным названием языка JavaScript Core.
Представьте себе Eslint как ваша бабушка, рассказывая вам, как жить своей жизнью. Она указывает на ваши ошибки и говорит вам очистить их. Вы слушаете бабушку, потому что бабушка знает.
Эти «ошибки» могут быть Цель , что означает, что они вызваны кодом, с которым не соответствует, скажем, синтаксис JavaScript (или любой язык программирования, которого вы отличаете). Таким образом, вы бы сказали, что Linter выбирает синтаксические ошибки.
Я говорю «объективные ошибки», потому что эти ошибки присущи сам JavaScript. Если вы оставите полутолон в конце переменных декларации, это объективно ошибка в соответствии с писателями JavaScript – даже если она не останавливает свою программу от работы (см. Автоматическая вставка полутока ) Отказ
Или эти ошибки могут быть субъективный , что означает Вы (Не Технический комитет 39 , стандарты Ecmascript) определили набор правил, которые должен следовать ваш код. Эти правила кодирования обычно суммируются в A Руководство по стилю JavaScript , который является документом, объявляющим своего рода кодировку лучших практик. Бесплатный кодовый лагерь среди многих других программных проектов используют гиды стилей.
Airbnb’s Руководство по стилю JavaScript является одним из самых популярных для разработчиков JavaScript, а гида стиль бесплатного кодового лагеря основана на нем.
Целью следующего руководства «Стиль» состоит в том, чтобы иметь «написание стандарта», чтобы разработчики вашего проекта следуют, чтобы сдерживать код чистыми, простыми и последовательными. Это похоже на концепцию AP Stylebook Журналисты следуют. Единственное отличие состоит в том, что Stylebook AP является руководством стилей для английской грамматики, а руководство по стилю Airbnb предназначено для JavaScript.
После того, как вы устроили, как должен быть написан код для вашего программного обеспечения (значение, вы выбрали руководство по стилю или создали один из ваших собственных), вы готовы настроить свой Правила львая для Eslint.
Way Work Eslint работает, вы расскажите, какие правила (т. Е. Вы принимаете правила вашего стиля руководства и преобразовать их в Правила льмина ) Это должно знать о том, и что он должен выглядеть, поэтому Eslint может коснуться вас на плече И дайте вам знать, когда вы пишете проблемный код.
Рассказать Eslint о своих правилах льмина, вы настраиваете их в Config файл называется .eslintrc или eslintconfig или Package.json Какой ESLINT будет ищет и читает автоматически. И, как вы разрабатываете, Eslint предупредит вас о проблеме неисправностей, который не подчиняется этим правилам, поэтому вы можете сделать изменения – как вы кодируете. Что похоже на имение бабушкиной программы с вами.
Где Eslint Сияние – это « ». Другими словами, вы можете смешивать и соответствовать как объективным, так и субъективным правилам.
У вас есть Варианты Когда дело доходит до линтных инструментов JavaScript, но в этой статье мы ориентируемся на ESLINT, потому что бесплатный код Code указывает его в его руководящих принципах. И он широко используется в другом месте.
У вас также есть Варианты Когда дело доходит до гидов стиля JavaScript. Airbnb – это хороший, чтобы стать знакомым, потому что он имеет над 45 000 звезд на Github Во время этого письма и растет в использовании.
Настройка льминает для FreeCodeCamp
Есть два способа установки Eslint: глобально и локально Отказ Мы собираемся сосредоточиться на установке этого локально , что означает для вашего местного рабочего каталога, то есть ваш бесплатный кодовый лагерь клонирован репозиторий.
1: Откройте свой бесплатный код Code Clone в текстовом редакторе (это предполагает, что у вас действительно клонированный код бесплатного кода на ваш компьютер)
2: в терминале, CD (Изменить каталог) в свой бесплатный каталог Code Camp
3: Тип NPM установить ESLINT --save-dev в терминал
4: В вашем текстовом редакторе Atom перейдите в Предпочтения > ;> Инста ll> & g t; и тип li Nter-Eslint в поле поиска пакетов поиска
Примечание. Вы также можете установить атомные пакеты из командной строки, используя APM команда. Смотри Эти инструкции Например.
5: установить Linter-Eslint и Линтер Отказ
6: в вашем каталоге бесплатного кода Camp, закрыть из любого
А теперь в следующий раз вы пишете JavaScript, вы должны увидеть работу Eslint!
Примечание: я оставил важный шаг: Настройка Eslint . То есть часть, где вы настраиваете Eslint и расскажу о своих правилах льмина. Я сделал это потому, что когда вы клонируете бесплатный код хранилища кодового лагеря, это Уже Поставляется с файлами конфигурации ESLINT, например, см. Eslintrc и Package.json Отказ И поэтому вам не нужно делать какие-либо конфигурации.
В случае, если вы работаете над проектом, где вам нужно настроить ESLINT, я указываю на следующие ссылки:
- Настройка Eslint . Отказ
- Начните с Eslint v1.0
- NPM, Eslint.
- Airbnb’s Расширяемый общий Eslint Config
Обернуть:
- Редин – это процесс проверки проблемного кода.
- Eslint – это один из таких инструментов, который выполняет ответ.
- Eslint может быть отличным инструментом обучения, потому что он заставляет вас писать чистый, последовательный код и разработать хорошие привычки кодирования.
- Многие проекты с открытым исходным кодом просят вас запустить Eslint.
- У вас должен быть настроен ESLINT в вашем текстовом редакторе, чтобы способствовать бесплатным кодовым лагере.
- Если вы не используете атом, проверьте свой Текстовый редактор Документы для того, как установить Eslint.
- Оставайся курсом.
Если у вас есть вопросы, вы можете твитнуть меня в @Gilbertginsberg Или найти меня в Gilbertindex Отказ