Проверка кода и форматирование
В идеальном мире ваш код всегда чистый, согласованный и свободен от раздражающих ошибок. Это обещание встроенных инструментов проверки и форматирования Deno. Интегрируя эти функции непосредственно в среду выполнения, Deno исключает необходимость внешних зависимостей и сложных конфигураций в ваших проектах. Эти встроенные инструменты быстры и эффективны, не только экономя время, но и гарантируя, что каждая строка кода соответствует лучшим практикам.
С помощью deno fmt и deno lint, вы можете сосредоточиться на написании отличного кода, зная, что Deno позаботится о вас. Это как иметь бдительного помощника, который поддерживает вашу базу кода в отличном состоянии, позволяя вам сосредоточиться на том, что действительно важно: создание потрясающих приложений.
Проверка кода
Проверка кода — это процесс анализа вашего кода на предмет потенциальных ошибок, багов и стилистических проблем. Встроенный инструмент проверки Deno, deno lint, поддерживает рекомендуемый набор правил из ESLint, чтобы предоставить исчерпывающие отзывы о вашем коде. Это включает в себя выявление синтаксических ошибок, соблюдение соглашений об оформлении кода и выделение потенциальных проблем, которые могут привести к ошибкам.
Чтобы запустить инструмент проверки, используйте следующую команду в вашей консоли:
deno lint
По умолчанию, deno lint анализирует все файлы TypeScript и JavaScript в текущей директории и ее поддиректориях. Если вы хотите проверить конкретные файлы или директории, вы можете передать их в качестве аргументов команде. Например:
deno lint src/
Эта команда проверит все файлы в директории src/.
Инструмент проверки можно настроить в файле deno.json. Вы можете указать пользовательские правила, плагины и настройки, чтобы настроить процесс проверки кода под ваши потребности.
Вы можете просмотреть и найти список доступных правил и их использования на странице правил проверки Deno.
Форматирование
Форматирование — это процесс автоматической корректировки структуры вашего кода для соблюдения согласованного стиля. Встроенный форматировщик Deno, deno fmt, использует мощный движок dprint, чтобы гарантировать, что ваш код всегда чистый, удобочитаемый и согласованный.
Чтобы отформатировать свой код, просто выполните следующую команду в вашей консоли:
deno fmt
По умолчанию, deno fmt форматирует все файлы TypeScript и JavaScript в текущей директории и ее поддиректориях. Если вы хотите отформатировать определенные файлы или директории, вы можете передать их в качестве аргументов команде. Например:
deno fmt src/
Эта команда отформатирует все файлы в директории src/.
Проверка форматирования
Команда deno fmt --check используется для проверки, правильно ли отформатирован ваш код в соответствии с правилами форматирования по умолчанию Deno. Вместо изменения файлов, она проверяет их и сообщает обо всех проблемах с форматированием. Это особенно полезно для интеграции в конвейеры непрерывной интеграции (CI) или в хуки перед коммитом для обеспечения согласованности кода в вашем проекте.
Если есть проблемы с форматированием, deno fmt --check выведет список файлов, которые требуют форматирования. Если все файлы отформатированы правильно, она просто завершит работу без вывода.
Интеграция в CI
Вы можете добавить deno fmt --check в свой конвейер CI для автоматической проверки на наличие проблем с форматированием. Например, в рабочем процессе GitHub Actions:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: denoland/setup-deno@v2
with:
deno-version: v2.x
- run: deno fmt --check
Это гарантирует, что любые изменения в коде соответствуют стандартам форматирования проекта перед слиянием.
Доступные опции
| Правило | Описание | Значение по умолчанию | Возможные значения |
|---|---|---|---|
| indent-width | Определение ширины отступа | 2 | число |
| line-width | Определение максимальной ширины строки | 80 | число |
| no-semicolons | Не использовать точки с запятой, кроме случаев необходимости | false | true, false |
| prose-wrap | Определение способа обрезки текста | всегда | всегда, никогда, сохранить |
| single-quote | Использовать одинарные кавычки | false | true, false |
| unstable-component | Включить форматирование файлов Svelte, Vue, Astro и Angular | ||
| unstable-css | Включить форматирование файлов CSS, SCSS, Sass и Less | ||
| unstable-html | Включить форматирование HTML-файлов | ||
| unstable-yaml | Включить форматирование YAML-файлов | ||
| unstable-sql | Включить форматирование SQL-файлов | ||
| use-tabs | Использовать табуляцию вместо пробелов для отступов | false | true, false |
Форматировщик можно настроить в файле deno.json. Вы можете указать пользовательские настройки для настройки процесса форматирования под ваши потребности.
© 2018–2024 the Deno authors
Licensed under the MIT License.
https://docs.deno.com/runtime/fundamentals/linting_and_formatting