Включить операцию рендеринга asciidoc в InteliJ Idea

Документирование остальных API с использованием spring-restdocs в InteliJ Idea — это хорошо, но мне не хватает визуализированных «включающих» фрагментов макроса операция.

== Get Comments sorted

To get sorted according single attribute and with no specific ordering (asc-ending is default), you can refer to this example:

operation::comments/getSortedDescending[snippets='http-request,path-parameters,http-response']

Я ожидаю, что каким-то образом я смогу включить артефакт spring-restdocs-asciidoc для использования при рендеринге вещей в InteliJ Idea с плагином asciidoctor.

Связанная проблема https://github.com/asciidoctor/asciidoctor-intellij-plugin/issues/310

Вы можете связаться с поставщиком плагина: plugins.jetbrains.com/plugin/7391-asciidoc

y.bedrov 25.07.2019 13:42
Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
2
1
310
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Я просмотрел spring-restdocs-asciidoctor. operation::[] — это расширение, который отображает содержимое. Он зависит от атрибута snippets, который необходимо установить.

Подключаемый модуль IntelliJ для AsciiDoc поддерживает как рубиновые расширения, так и атрибуты для превью в качестве экспериментальных параметров.

Чтобы заставить его работать, я сделал следующее:

  • проверить проект
  • работает gradlew asciidoctor для создания фрагментов
  • добавьте файл .asciidoctorconfig, чтобы указать путь к сгенерированным фрагментам
  • добавьте каталог .asciidoctor и поместите расширение в этот каталог
  • подтвердите предупреждающее сообщение "Этот проект содержит расширения Asciidoctor..." в среде IDE

Вам необходимо подтверждать предупреждающее сообщение каждый раз, когда вы перезапускаете IDE. Поскольку он будет запускать код Ruby локально, это проблема безопасности. Возможно, мы улучшим его в будущем, поэтому вам нужно будет подтвердить его только после изменения кода расширения.

Изменения в следующей ветке: https://github.com/ahus1/spring-restdocs/tree/poc_extension_intellij

Он также поддерживает расширения Java, и вам необходимо скопировать файлы JAR в .asciidoctor/lib. В прошлые выходные я играл с этим, чтобы интегрировать предварительную обработку Jamal в плагин IntelliJ Asciidoc, и он отлично работает.

Peter Verhas 28.03.2022 18:34

Другие вопросы по теме