2018-10-06 19:10:08 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2015-12-15 09:51:16 -05:00
|
|
|
module Banzai
|
|
|
|
module Pipeline
|
|
|
|
class GfmPipeline < BasePipeline
|
2019-01-23 06:21:12 -05:00
|
|
|
# These filters transform GitLab Flavored Markdown (GFM) to HTML.
|
|
|
|
# The nodes and marks referenced in app/assets/javascripts/behaviors/markdown/editor_extensions.js
|
|
|
|
# consequently transform that same HTML to GFM to be copied to the clipboard.
|
|
|
|
# Every filter that generates HTML from GFM should have a node or mark in
|
|
|
|
# app/assets/javascripts/behaviors/markdown/editor_extensions.js.
|
2017-01-16 18:11:15 -05:00
|
|
|
# The GFM-to-HTML-to-GFM cycle is tested in spec/features/copy_as_gfm_spec.rb.
|
2015-12-15 09:51:16 -05:00
|
|
|
def self.filters
|
2016-03-01 15:54:35 -05:00
|
|
|
@filters ||= FilterArray[
|
2017-01-15 19:07:02 -05:00
|
|
|
Filter::PlantumlFilter,
|
2018-11-28 14:02:01 -05:00
|
|
|
# Must always be before the SanitizationFilter to prevent XSS attacks
|
|
|
|
Filter::SpacedLinkFilter,
|
2015-12-15 09:51:16 -05:00
|
|
|
Filter::SanitizationFilter,
|
2019-02-20 18:51:55 -05:00
|
|
|
Filter::AssetProxyFilter,
|
2017-04-02 13:39:41 -04:00
|
|
|
Filter::SyntaxHighlightFilter,
|
2016-12-08 19:15:08 -05:00
|
|
|
Filter::MathFilter,
|
2017-12-20 06:39:40 -05:00
|
|
|
Filter::ColorFilter,
|
2020-11-28 16:09:37 -05:00
|
|
|
Filter::KrokiFilter,
|
2017-11-21 22:12:04 -05:00
|
|
|
Filter::MermaidFilter,
|
2016-04-03 01:00:06 -04:00
|
|
|
Filter::VideoLinkFilter,
|
2019-10-09 08:06:13 -04:00
|
|
|
Filter::AudioLinkFilter,
|
2017-07-24 13:36:52 -04:00
|
|
|
Filter::ImageLazyLoadFilter,
|
2016-07-12 13:31:20 -04:00
|
|
|
Filter::ImageLinkFilter,
|
2020-02-18 19:09:15 -05:00
|
|
|
*metrics_filters,
|
2015-12-15 09:51:16 -05:00
|
|
|
Filter::TableOfContentsFilter,
|
2020-02-10 04:08:56 -05:00
|
|
|
Filter::TableOfContentsTagFilter,
|
2015-12-15 09:51:16 -05:00
|
|
|
Filter::AutolinkFilter,
|
|
|
|
Filter::ExternalLinkFilter,
|
2018-12-13 14:17:19 -05:00
|
|
|
Filter::SuggestionFilter,
|
2019-01-04 21:54:02 -05:00
|
|
|
Filter::FootnoteFilter,
|
2018-07-13 06:32:49 -04:00
|
|
|
*reference_filters,
|
2019-06-06 12:49:08 -04:00
|
|
|
Filter::EmojiFilter,
|
2021-02-05 10:09:28 -05:00
|
|
|
Filter::CustomEmojiFilter,
|
2018-07-13 06:32:49 -04:00
|
|
|
Filter::TaskListFilter,
|
|
|
|
Filter::InlineDiffFilter,
|
|
|
|
Filter::SetDirectionFilter
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2020-02-18 19:09:15 -05:00
|
|
|
def self.metrics_filters
|
|
|
|
[
|
|
|
|
Filter::InlineMetricsFilter,
|
2020-07-13 11:09:08 -04:00
|
|
|
Filter::InlineGrafanaMetricsFilter,
|
|
|
|
Filter::InlineClusterMetricsFilter
|
2020-02-18 19:09:15 -05:00
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2018-07-13 06:32:49 -04:00
|
|
|
def self.reference_filters
|
|
|
|
[
|
2021-04-15 14:09:01 -04:00
|
|
|
Filter::References::UserReferenceFilter,
|
|
|
|
Filter::References::ProjectReferenceFilter,
|
|
|
|
Filter::References::DesignReferenceFilter,
|
|
|
|
Filter::References::IssueReferenceFilter,
|
|
|
|
Filter::References::ExternalIssueReferenceFilter,
|
|
|
|
Filter::References::MergeRequestReferenceFilter,
|
|
|
|
Filter::References::SnippetReferenceFilter,
|
|
|
|
Filter::References::CommitRangeReferenceFilter,
|
|
|
|
Filter::References::CommitReferenceFilter,
|
|
|
|
Filter::References::LabelReferenceFilter,
|
|
|
|
Filter::References::MilestoneReferenceFilter,
|
|
|
|
Filter::References::AlertReferenceFilter,
|
|
|
|
Filter::References::FeatureFlagReferenceFilter
|
2015-12-15 09:51:16 -05:00
|
|
|
]
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.transform_context(context)
|
2018-05-18 06:25:59 -04:00
|
|
|
context[:only_path] = true unless context.key?(:only_path)
|
2015-12-15 09:51:16 -05:00
|
|
|
|
2019-02-20 18:51:55 -05:00
|
|
|
Filter::AssetProxyFilter.transform_context(context)
|
2015-12-15 09:51:16 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2020-04-09 08:09:24 -04:00
|
|
|
|
2021-05-11 17:10:21 -04:00
|
|
|
Banzai::Pipeline::GfmPipeline.prepend_mod_with('Banzai::Pipeline::GfmPipeline')
|