Форматеры

Dropstone использует форматеры для конкретных языков программирования.

Dropstone может форматировать файлы после их создания или редактирования с помощью форматеров для конкретных языков. Форматеры отключены по умолчанию; включите их в конфигурации, прежде чем Dropstone начнет их использовать.

Встроенные

Dropstone поставляется с несколькими встроенными форматерами для популярных языков и фреймворков. Ниже приведен список форматеров, поддерживаемых расширений файлов и необходимых команд или параметров конфигурации.

Форматер	Расширения	Требования
air	.R	доступна команда `air`
biome	.js, .jsx, .ts, .tsx, .html, .css, .md, .json, .yaml и другие	файл конфигурации `biome.json(c)`
cargofmt	.rs	доступна команда `cargo fmt`
clang-format	.c, .cpp, .h, .hpp, .ino и другие	файл конфигурации `.clang-format`
cljfmt	.clj, .cljs, .cljc, .edn	доступна команда `cljfmt`
dart	.dart	доступна команда `dart`
dfmt	.d	доступна команда `dfmt`
gleam	.gleam	доступна команда `gleam`
gofmt	.go	доступна команда `gofmt`
htmlbeautifier	.erb, .html.erb	доступна команда `htmlbeautifier`
ktlint	.kt, .kts	доступна команда `ktlint`
mix	.ex, .exs, .eex, .heex, .leex, .neex, .sface	доступна команда `mix`
nixfmt	.nix	доступна команда `nixfmt`
ocamlformat	.ml, .mli	доступна команда `ocamlformat` и файл конфигурации `.ocamlformat`
ormolu	.hs	доступна команда `ormolu`
pint	.php	зависимость `laravel/pint` в `composer.json`
prettier	.js, .jsx, .ts, .tsx, .html, .css, .md, .json, .yaml и другие	зависимость `prettier` в `package.json`
rubocop	.rb, .rake, .gemspec, .ru	доступна команда `rubocop`
ruff	.py, .pyi	доступна команда `ruff` с конфигурацией
rustfmt	.rs	доступна команда `rustfmt`
shfmt	.sh, .bash	доступна команда `shfmt`
standardrb	.rb, .rake, .gemspec, .ru	доступна команда `standardrb`
terraform	.tf, .tfvars	доступна команда `terraform`
uv	.py, .pyi	доступна команда `uv`
zig	.zig, .zon	доступна команда `zig`

Когда форматеры включены, Dropstone будет использовать prettier для совпадающих файлов, если в вашем проекте есть prettier в package.json.

Как это работает

Когда Dropstone создает или редактирует файл и форматеры включены, он:

Проверяет расширение файла для всех включенных форматеров.
Запускает соответствующую команду форматера для файла.
Применяет изменения форматирования.

Этот процесс происходит в фоновом режиме для включенных форматеров.

Конфигурация

Вы можете включить и настроить форматеры через раздел formatter в конфигурации Dropstone.

Чтобы включить все встроенные форматеры, установите formatter в true.

{
  "$schema": "https://dropstone.io/schema/config.json",
  "formatter": true
}

Используйте объект, чтобы сохранить встроенные форматеры включенными при настройке переопределений или пользовательских форматеров.

{
  "$schema": "https://dropstone.io/schema/config.json",
  "formatter": {}
}

Каждая конфигурация форматера поддерживает следующие параметры:

Свойство	Тип	Описание
`disabled`	boolean	Установите значение `true`, чтобы отключить форматер
`command`	string[]	Команда для запуска форматирования. Обязательна для пользовательских форматеров; опциональна для встроенных.
`environment`	object	Переменные окружения для установки при запуске форматера
`extensions`	string[]	Расширения файлов, которые должен обрабатывать этот форматер

Давайте рассмотрим несколько примеров.

Отключение форматеров

Если formatter опущен, все форматеры отключены. Чтобы отключить все форматеры после того, как другая конфигурация их включила, установите formatter в false:

{
  "$schema": "https://dropstone.io/schema/config.json",
  "formatter": false
}

Чтобы отключить конкретный форматер, установите disabled в true:

{
  "$schema": "https://dropstone.io/schema/config.json",
  "formatter": {
    "prettier": {
      "disabled": true
    }
  }
}

Пользовательские форматеры

Вы можете настроить встроенные форматеры с параметрами, такими как environment или extensions. Чтобы добавить пользовательский форматер, укажите command и extensions:

{
  "$schema": "https://dropstone.io/schema/config.json",
  "formatter": {
    "prettier": {
      "command": ["npx", "prettier", "--write", "$FILE"],
      "environment": {
        "NODE_ENV": "development"
      },
      "extensions": [".js", ".ts", ".jsx", ".tsx"]
    },
    "custom-markdown-formatter": {
      "command": ["deno", "fmt", "$FILE"],
      "extensions": [".md"]
    }
  }
}

Заполнитель $FILE в команде будет заменен на путь к форматируемому файлу.

LSP

VS Code Extension