oatmeal

oatmeal

oatmeal поставляется с готовым DevContainer со всем необходимым для работы над проектом. Однако если вы хотите разрабатывать полностью локально, следующие инструкции помогут вам настроить все необходимые инструменты.

oatmeal cargo cmd setup">

cargo install cargo-run-bin
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo cmd setup

Добавление бэкэнда

Каждый бэкэнд реализует признак Backend в своем собственном файле инфраструктуры. У этой черты есть документация о том, что ожидается от каждого метода. В качестве примера вы можете проверить Олламу.

Чтобы добавить серверную часть, необходимо выполнить следующие шаги:

1. Реализуйте черту для нового бэкэнда.
2. Обновите перечисление BackendName, указав новое имя Backend.
3. Обновите BackendManager, чтобы предоставить новый бэкэнд.
4. Написание тестов

Добавление редактора

Каждый редактор реализует признак Editor в своем собственном файле инфраструктуры. У этой черты есть документация о том, что ожидается от каждого метода. В качестве примера вы можете проверить Neovim.

Для добавления редактора необходимо выполнить следующие шаги:

1. Реализовать черту для нового редактора.
2. Обновите перечисление EditorName, указав новое имя редактора.
3. Обновите EditorManager, чтобы предоставить новый редактор.
4. Написание тестов

Добавление подсветки синтаксиса для языка

Выбор языка с подсветкой синтаксиса — это небольшое руководство, в котором необходимо выбрать несколько языков, а затем добавить их в assets.toml .

1. Найдите в Google проект .sublime-syntax на GitHub для вашего языка. у летучей мыши много!
2. Обновите файл assets.toml , включив в него новый репозиторий. Обязательно включите лицензию в массив файлов. Вы можете оставить nix-hash как пустую строку, и специалист по сопровождению обновит ее позже. Или, если у вас установлен докер, вы можете запустить cargo xtask hash-assets .
3. rm -rf .caches && cargo build
4. Проверьте, чтобы увидеть работу выделения.

Часто задаваемые вопросы

Почему oatmeal ?

Я ел миску oatmeal , когда писал первый коммит?. (На работе мне больше не разрешают называть вещи...)

Лицензия

Массачусетский технологический институт