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