Прекратите спорить о стиле кода. Сделайте это прямо сейчас:

$ npm install --save-dev prettier lint-staged husky

Сделайте .prettierrc - это то, что я использую на работе и в личных проектах, но продолжайте и украдите его. IDGAF.

{
  "printWidth": 80,
  "bracketSpacing": true,
  "useTabs": false,
  "singleQuote": true,
  "semi": true,
  "trailingComma": "none",
  "arrowParens": "avoid",
  "jsxBracketSameLine": true
}

Добавьте ключи husky и lint-staged в свой package.json. Замените \"src/**/*.js\" на любое место, где находится ваш JS:

{
  "name": "awesome-app",
  "version": "0.1.0",
  "description": "Lol sure",
  "main": "index.js",
  "author": "You <[email protected]>",
  "license": "MIT",
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.js": [
      "prettier --write \"src/**/*.js\"",
      "git add"
    ]
  },

}

[НЕОБЯЗАТЕЛЬНО]: запустите prettier, чтобы убедиться, что весь ваш текущий код стилизован и красочен:

$ npx prettier --write \"src/**/*.js\"

БУМ. ТЫ. ЯВЛЯЕТСЯ. СДЕЛАНО.

Больше «Почему» Объяснение

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

Объяснение инструментов

  • Prettier - самоуверенный форматтер кода. Этот инструмент выполняет основную часть работы по стилизации вашего кода в вашей команде.
  • Lint-staged - запускает любые линтеры для ваших файлов, которые должны быть зафиксированы в git.
  • Хаски - хуки Git стали проще и доступны для всех команд.

Комбинируя все три этих инструмента, вы можете легко автоматизировать свой стиль кода, независимо от того, насколько велика или мала ваша команда.

Потратьте 10 минут (или меньше) сегодня, чтобы автоматизировать это и перестать тратить время на проверку кода на «стиль кода».