Исполнение команд при сохранении файлов в редакторах кода

Зачем? — Для экономии времени за счёт:

• Автоформатирования кода (GDScript, C#, C++, Python, JSON, YAML, Markdown, lua, и любого другого, для которого есть форматтер)
• Автоисправления простых ошибок в файлах (к примеру, (1) python-овый linter «ruff» может исправлять ошибки/рекомендации, если ему дать аргумент --fix, (2) «prettier» может убирать лишние запятые из json-ов)
• Автозапуска тестов (см. Тесты + Запуск тестов при сохранении файлов)
• Автозапуска кодогенерации (позже опишу)
• Автозапуска билда
• И автоматизации пр. рутинных действий

В VSCode есть встроенный функционал Format on Save, что прогоняет форматтер

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

VSCode Расширение Run on Save

Простой пример:

// .vscode/settings.json
{
  // ...
  "runOnSave.commands": [
    {
      "match": ".json$",
      "command": "prettier -w ${file}"
    }
  ]
  // ...
}

При сохранении файлов, название которых оканчивается на .json (это regex matching), будет прогоняться по ним prettier -w

Этого можно было бы добиться и с помощью Format on Save. Но что-то посложнее — нет

Например:

{
  "runOnSave.commands": [
    {
      "match": ".pyi?$",
      "command": "uv run cog -n utf-8 -U -r -P --markers=\"{{{cog cog}}} {{{end}}}\" ${file} && uv run ruff format ${file} && uv run ruff check --select I ${file} --fix"
    }
  ]
}

В этом случае при сохранении python файла последовательно бы отрабатывали 3 экономящие моё время команды:

• uv run cog -n utf-8 -U -r -P --markers="{{{cog cog}}} {{{end}}}" ${file} (для кодогенерации внутри файла через использование python cogapp)
• uv run ruff format ${file} (для форматирования)
• uv run ruff check --select I ${file} --fix (для сортировки импортов)

На самом деле в cog я использую не {{{, а [[[. Заменил в примере, чтобы он не прогонялся

Godot GDScript разработягам, что используют VSCode

Среди форматтеров я остановился на gdscript-formatter

{
  "runOnSave.commands": [
    {
      "match": ".gd$",
      // Если не нравится, можно убрать `--reorder-code`
      "command": "uv run gdscript-formatter --reorder-code ${file}"
    },
  ]
}

Unity C# разработягам, что используют VSCode

Можно было бы установить CSharpier и навесить его на сохранение файлов

Практичный Пример 1 — Protobuf + proto-renumber + buf format — Big Brain Giga Chad Комбинация

Пока я прототипирую protobuf схемы данных, у меня номера полей идут вразнобой, т.к. я постоянно их перетаскиваю / дополняю

message Lib {
  repeated GRoom a = 4;
  float b = 2;
  float c = 8;
  float d = 7;
}

Рандомная последовательность слегка триггерит у меня желание их последовательно пронумеровать

Но больше всего моя ж*па взрывается, когда я, не заметив, добавляю поле с ранее забитым номером и падаю с ошибкой:

message Lib {
  float e = 2; // Ошибка!
  repeated GRoom a = 4;
  float b = 2; // <- уже есть поле с номером 2
  float c = 8;
  float d = 7;
}

Это не просто так в protobuf сделано.

Но когда я использую protobuf для, в сущности, просто типизации json-ов, мне не нужно опираться на сохранение последовательности номеров полей в proto файлах игровых данных

И однажды я нашёл proto-renumber. Он автоматом везде последовательно пронумеровывает поля

message Lib {
  float e = 1;
  repeated GRoom a = 2;
  float b = 3;
  float c = 4;
  float d = 5;
}

Кукуха сохранена. Я больше ни секунды не трачу на бесполезные думы о нумерации полей + изменения номеров

{
  "runOnSave.commands": [
    {
      "match": ".proto$",
      "command": "proto-renumber -replace ${file} && buf format -w ${file}"
    }
  ]
}

Практичный Пример 2 — Автозапуск билда

В репе моего github.io сайта (= этого сайта) я настроил автозапуск билда при изменении любого файла

Навешиваю на это livereload (локальный сервер с hot-reload-ом html-ок) и получаю удобный и быстрый flow работы без необходимости нажимать какие-либо кнопки

Ссылки

• Пример моих команд при сохранении файлов

• Расширение для VSCode — Run on Save by pucelle

• В IDE от JetBrains альтернативой «Run on Save» будут File Watchers

• Раньше я использовал Neovim и прописывал ряд обработчиков с помощью плагина conform

Hulvdan