deno fmt

Deno включает встроенный форматтер кода на основе dprint, который автоматически форматирует код, обеспечивая единообразный стиль. Общий обзор см. в разделе Проверка и форматирование кода.

Основные сведения об использовании

Форматирование всех поддерживаемых файлов в текущем каталоге:

deno fmt

Форматирование отдельных файлов или каталогов:

deno fmt main.ts src/

Режим наблюдения

Автоматическое повторное форматирование файлов при их изменении:

deno fmt --watch

Проверка форматирования в CI

Используйте --check, чтобы проверить форматирование файлов без их изменения. Команда завершится с ненулевым кодом возврата, если какие-либо файлы не отформатированы:

deno fmt --check

Добавьте --fail-fast, чтобы остановиться на первом неотформатированном файле, а не выводить сведения обо всех таких файлах. Это удобно для больших кодовых баз:

deno fmt --check --fail-fast

Форматирование stdin

Форматирование кода, переданного через stdin, — удобно для интеграции с редакторами:

cat main.ts | deno fmt -

Настройка форматтера

Настройте параметры форматирования в файле deno.json:

{
  "fmt": {
    "useTabs": false,
    "lineWidth": 80,
    "indentWidth": 2,
    "semiColons": true,
    "singleQuote": false,
    "proseWrap": "preserve"
  }
}

Полный список доступных параметров см. на странице Конфигурация.

Наследование настроек из .editorconfig

deno fmt также считывает файлы .editorconfig и использует их, чтобы задать параметры форматирования, которые вы не указали другим способом. Приоритет параметров, от высшего к низшему:

1. Флаги CLI (--indent-width, --use-tabs и т. д.)
2. Блок fmt в файле deno.json
3. .editorconfig
4. Встроенные значения по умолчанию

Таким образом, .editorconfig задаёт только те значения, которые вы ещё не настроили с помощью флага или deno.json. Такие свойства, как indent_style, indent_size и max_line_length, соответствуют параметрам deno fmt.

Включение и исключение файлов

Укажите, какие файлы нужно форматировать, в deno.json:

{
  "fmt": {
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/generated/**/*.ts"]
  }
}

Также можно исключить файлы из командной строки:

deno fmt --ignore=dist/,build/

Поддерживаемые типы файлов

Средства форматирования разметки (HTML, XML, SVG и форматы --unstable-component), а также таблиц стилей (CSS, SCSS и Less) были переработаны так, чтобы изменять только пробельные символы. Они никогда не переставляют и не переписывают токены и пропускают неизвестный синтаксис (расширения поставщиков, будущие at-правила, шаблонные выражения и даже некорректную разметку) без изменений, вместо того чтобы выдавать ошибку. Благодаря этому форматирование надёжнее работает с реальными файлами.

Исключение кода из форматирования

JavaScript / TypeScript / JSONC

Чтобы исключить код из форматирования, предварите его комментарием // deno-fmt-ignore:

// deno-fmt-ignore
export const identity = [
    1, 0, 0,
    0, 1, 0,
    0, 0, 1,
];

Чтобы исключить из форматирования весь файл, добавьте комментарий // deno-fmt-ignore-file в начало файла.

Markdown / HTML / CSS

Чтобы исключить следующий элемент из форматирования, предварите его комментарием <!--- deno-fmt-ignore -->:

<html>
  <body>
    <p>
      Hello there
      <!-- deno-fmt-ignore -->
    </p>
  </body>
</html>

Чтобы исключить из форматирования фрагмент кода, заключите его между комментариями <!-- deno-fmt-ignore-start --> и <!-- deno-fmt-ignore-end -->.

Чтобы исключить из форматирования весь файл, добавьте комментарий <!-- deno-fmt-ignore-file --> в начало файла.

YAML

Чтобы исключить следующий элемент из форматирования, предварите его комментарием # deno-fmt-ignore:

# deno-fmt-ignore aaaaaa: bbbbbbb

deno fmt [OPTIONS] [files]...

deno fmt myfile1.ts myfile2.ts

JavaScript, TypeScript, Markdown, JSON(C) and Jupyter Notebooks

HTML, CSS, SCSS, LESS, YAML, Svelte, Vue, Astro and Angular

cat file.ts | deno fmt -

deno fmt --check

// deno-fmt-ignore

// deno-fmt-ignore-file