Module: Gitlab::Kroki
- Defined in:
- lib/gitlab/kroki.rb
Overview
Helper methods for Kroki
Constant Summary collapse
- BLOCKDIAG_FORMATS =
%w[ blockdiag seqdiag actdiag nwdiag packetdiag rackdiag ].freeze
- DIAGRAMS_FORMATS =
(::AsciidoctorExtensions::Kroki::SUPPORTED_DIAGRAM_NAMES - %w[mermaid]).freeze
- DIAGRAMS_FORMATS_WO_PLANTUML =
(DIAGRAMS_FORMATS - %w[plantuml]).freeze
Class Method Summary collapse
-
.formats(current_settings) ⇒ Object
Get the list of diagram formats that are currently enabled.
Class Method Details
.formats(current_settings) ⇒ Object
Get the list of diagram formats that are currently enabled
Returns an Array of diagram formats. If Kroki is not enabled, returns an empty Array.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/gitlab/kroki.rb', line 24 def self.formats(current_settings) return [] unless current_settings.kroki_enabled # If PlantUML is enabled, PlantUML diagrams will be processed by the PlantUML server. # In other words, the PlantUML server has precedence over Kroki since both can process PlantUML diagrams. diagram_formats = if current_settings.plantuml_enabled DIAGRAMS_FORMATS_WO_PLANTUML else DIAGRAMS_FORMATS end # Diagrams that require a companion container must be explicitly enabled from the settings diagram_formats.select do |diagram_type| current_settings.kroki_format_supported?(diagram_type) end end |