Автор оригинала: FreeCodeCamp Community Member.
Абхишек Джайн
или как никогда не беспокоиться о стиле кода снова
Eslint и Стилелинт действительно удивительные инструменты, которые позволяют вам обеспечить укрепление узоров кодирования среди ваших команд. Это имеет много преимуществ, таких как вывод лучшего и более последовательного кода, избавиться от бесполезных дифференциров в коммитах (новая линия, отступа, et al.) Среди многих других.
Но со временем это может оказаться немного хлопоткой среди разработчиков команды, которая находит его дополнительным умственным бременем, чтобы вручную добавить запястья, новых линий, углублений и т. Д. Просто для соответствия правилам льта. Это где инструмент форматирования кода, как Красивее приходит в.
Creettier может быть установлен для автоматического отформатирования кода в соответствии с некоторыми указанными правилами. Если вы используете VSCode, вы даже можете отформатировать свой код всякий раз, когда вы попадаете в Save (я уверен, что должны быть способы настроить это в других редакторах, но я не смотрел в него.)
Тем не менее, вы не хотите создавать новый файл Conreetier Config, поскольку у вас уже есть все правила, связанные с форматированием, указанные в Eslint и Stylint Конфигурация файлов. Итак, нам понадобится немного магии для этого. ✨
Давайте теперь погрузимся на шаг за шагом, как установить все это все это, а также как отформатировать весь ваш существующий код в соответствии с правилами Lint. В этом руководстве предполагается, что ваш проект уже есть Eslint и StyliNtiNt с их .eslintrc а также .stylelintrc файлы.
Часть 1: Форматирование существующей кодовой базы
Шаг 1
Установить Прекрас-эслин , который является инструментом, который форматирует ваш JavaScript, используя преток, а затем Eslint --fix Отказ --fix Функция Eslint, которая пытается автоматически исправить некоторые проблемы для вас.
npm install --save-dev prettier-eslint
Этот инструмент активирует эквивалентные параметры красивых конфигураций из существующих .eslintrc файл. Таким образом, вам не нужно создавать новый .Prettierrc файл в большинстве случаев.
Шаг 2
Установить Прекрас-эслин-Кли Отказ Это инструмент CLI, который поможет вам запустить все ваши файлы с помощью более красивого Eslint.
npm install --save-dev prettier-eslint-cli
Шаг 3
Установить Прекрас-стилелинт , который является инструментом, который форматирует ваши CSS/SCSS с престие, а затем Stylelint --fix Отказ Как eslint, --fix Является ли функция Stylient, которая пытается автоматически исправить некоторые проблемы для вас.
npm install prettier-stylelint --save-dev
Этот инструмент Также Попытки создания более красивого конфигурации на основе конфигурации Stylelint.
Обратите внимание, что в отличие от красивее – Eslint, вам не нужно устанавливать другой пакет для его CLI, поскольку это уже включено в него.
Шаг 4.
Написать скрипты внутри вашего Package.json Нацеливая на существующие файлы в вашей кодовой базе, которую вы хотите пробежать сквозь красивее – Eslint и strettier-Stylient.
"scripts": { "fix-code": "prettier-eslint --write 'src/**/*.{js,jsx}' ", "fix-styles": "prettier-stylelint --write 'src/**/*.{css,scss}' "}
Как видите, я нацелен на все мои существующие JS и JSX и все мои существующие CSS и SCSS соответственно.
--write Флаг пишет изменения в месте для файла в настоящее время отформатированного. Итак, будь осторожен и Убедитесь, что все ваши существующие файлы находятся под контролем источника, и что не изменено незарегистрированным Отказ
Шаг 5.
Запустите скрипты!
npm run fix-codenpm run fix-styles
Теперь вы можете зарегистрироваться, во всех этих новых изменениях как один большой коммит (может быть даже от временного пользователя GIT, если вы не хотите загрязнять свою собственную историю Git.)
Часть 2: Настройка VSCode
Теперь, когда ваша существующая кодовая база отформатирована, пришло время, чтобы убедиться, что весь код в отличии в отличии от отформатирован автоматически.
Шаг 1
Установите более красивые расширения ESLINT и STYLELINT для VSCODE:
Breettier – Code Formatter – Visual Studio Marketplace Marketplace Расширение для Visual Studio Code – VS Plugin для более красивых/красивых MarketPlace.visualstudio.com Eslint – Visual Studio Marketplace Расширение для Visual Studio Code – объединяет eslint javascript на VS-код. MarketPlace.visualstudio.com StyleLint – Visual Studio Marketplace Расширение для визуального студийного кода – Современные CSS/SCSS/менее Линтер marketplace.visualstudio.com
Шаг 2
Настройте несколько настроек VSCode:
"Crettier.eslintistegration": правда – рассказывает красивее использовать красивее-эсвет вместо более красивого
"Reettier.stylelintistegration": правда – рассказывает красивее использовать красивее-стилелинт вместо более красивого
"Eslint.autofixSave": false – Нам не нужен Eslint, чтобы исправить наш код для нас напрямую, так как красивее – Eslint будет работать Eslint --fix Для нас в любом случае.
«Редактор. Фрассформатсос»: правда – Запускается красивее с вышеуказанными параметрами на каждом файле сохранения, поэтому вам никогда не придется вручную принять команду VSCode Format.
Кроме того, вы можете зарегистрироваться вышеуказанные настройки рабочих мест для контроля источника, чтобы другие члены команды устанавливать свои редакторы. Вы можете сделать это, создав .vscode Папка в корне вашего проекта и положить все вышеуказанные правила в settings.json файл.
Необязательно, вы можете сказать красивее, чтобы игнорировать форматирование определенных шаблонов файлов. Чтобы сделать это, просто добавьте .Prettierignore Файл в корню вашего проекта, указав пути для игнорирования. Например:
strings.jsonscripts/*
Вот и все! Никогда не беспокоитесь о стайливе кода снова?
Эта статья ни в коем случае не предназначена для того, чтобы быть исчерпывающим руководством, а скорее введение к тому, что возможно с удивительными инструментами, упомянутыми здесь. Я рекомендую открыть официальные страницы GitHub для каждого, чтобы узнать больше о том, как более эффективно использовать эти инструменты для вашего определенного рабочего процесса.
Пожалуйста, напишите комментарий ниже для любой помощи, предложения и т. Д.
использованная литература
https://prettier.io/docs/en/https://stylelint.io/user-guide/https://eslint.org/https://github.com/prettier/prettier-vscode https://github.com/preettier/Prettier-eslint. https://github.com/prettier/prettier-eslint-cli https://github.com/hugomrdias/prettier-stylelint https://www.youtube.com/watch?v=yivjkid9m2c.
Оригинал: “https://www.freecodecamp.org/news/integrating-prettier-with-eslint-and-stylelint-99e74fede33f/”