Спецификации кода JavaScript, о которых вы могли не знать

JavaScript React.js Airbnb ESLint
Спецификации кода JavaScript, о которых вы могли не знать

предисловие

Хорошая спецификация кода может улучшить читабельность кода и сделать обслуживание проекта более удобным. Помимо того, что мы сами устанавливаем спецификацию, мы также можем учиться на текущих популярных спецификациях кода, давайте подрастем, а затем посмотрим на детали.

Airbnb

Airbnb — одна из самых популярных спецификаций кода JavaScript, которая охватывает практически все аспекты JavaScript. Это также соглашение о коде, которое я использую для своих личных проектов. Если ваш проект основан на React, вы можете установитьeslint-config-airbnb, или вы можете выбрать самый простойeslint-config-airbnb-base.

eslint-config-airbnbСодержит спецификацию кода ECMAScript 6+ и React ESLint. во время установкиeslint-config-airbnb, он будет установлен вместе сeslint, eslint-plugin-import, eslint-plugin-react, and eslint-plugin-jsx-a11y. Если ваш проект не React, вы можете выбратьeslint-config-airbnb-base.

npm install eslint-config-airbnb

eslint-config-airbnb-baseСодержит спецификацию кода ESLint для ECMAScript 6+. При установке потребуетсяeslintа такжеeslint-plugin-import.

npm install eslint-config-airbnb-base

тогда в вашем.eslintrcПрисоединяйся"extends": "airbnb-base"Вот и все.

Полную спецификацию кода для Airbnb можно найти по адресуairbnb/javascriptчитать дальше.

Standard

В дополнение к спецификациям кода Airbnb многие высокотехнологичные компании используют спецификации кода Standard, включая NPM, Github, mongoDB, ZenDesk, но не ограничиваясь ими.

Вот некоторые из стандартных спецификаций, упомянутых на официальном сайте:

  • Два пробела - как отступ
  • Используйте одинарные кавычки для строк, если только не следует избегать escape-символов.
  • никаких ненужных переменных
  • не добавляйте точки с запятой
  • Никогда не используйте ( , [ при запуске
  • Это единственная возможная проблема с отсутствием точки с запятой — она автоматически проверит за вас!
  • После добавления ключевых слов пусто, если (условие) {...}
  • Имя функции плюс пустое имя функции (ARG) {...}
  • Uniform === вместо ==, но obj == null можно использовать для проверки null || undefined.
  • Обязательно сделайте исключения для параметра err в node.js
  • Обязательно добавляйте префикс окна ко всем глобальным переменным в браузере, кроме document и navigator.
  • Избегайте плохо названных глобальных переменных, таких как open, length, event и name.

ты можешь пройтиeslint-config-standardдля автоматической проверки и улучшения вашего кода.

npm install eslint-config-standard

Стандартная документация на традиционном китайском языке Стандартная документация на упрощенном китайском языке

Idiomatic

Идея состоит в том, что тот, кто улучшает код проекта, должен вести себя так, как будто код написал только один человек.

Вы можете автоматически вычитывать и улучшать свой код с помощью eslint-config-idiomatic.

npm install eslint-config-idiomatic

Idiomatic - Github

Примечание:

use version ^3.0.0 for ESLint version ^3.x.x. use version ^2.0.0 for ESLint version ^2.x.x. use version ^1.0.0 for ESLint version ^1.x.x.

Внутри вашего .eslintrc введите:

{
  "extends": "idiomatic"
}

Google

Вы можете программировать в том же стиле, что и инженер Google.

Вы можете автоматически вычитывать и улучшать свой код с помощью eslint-config-google.

npm install eslint eslint-config-google

мы можемGoogle - GitHub PagesПрочтите его спецификацию кода на .

jQuery

Если вы хотите помочь jQuery улучшить свой код, вы можетеофициальный сайт jqueryПрочтите его спецификацию кода на .

Суммировать

Прочитав книгу «Чистый код», я чувствую, что написание кода — это не только ремесло, но и искусство. Может быть, вы смотрите на прошлое и чувствуете, что это все JavaScript, но когда вы читаете некоторые проекты с открытым исходным кодом, вы чувствуете, насколько элегантным может быть код и насколько неэлегантным он может быть одновременно. . . Чтобы уменьшить вероятность того, что другие скажут WTF, давайте изучим, как сделать наш код более элегантным.

Если вы впервые используете спецификацию кода JavaScript, вы можете выбрать Airbnb в качестве спецификации кода. Документация Airbnb хороша, и добавить eslint в существующие проекты не так уж сложно.

Если мы хотим подробно поговорить о преимуществах и важности спецификации кода, мы можем обсудить это в следующей статье.

использованная литература

  1. Электронная книга «Чистый код»
  2. 5 руководств по стилю JavaScript , включая AirBnB, GitHub и Google
Категории