[CIS-42] Markdown support for messages

[hugobernalstream]

🔗 Issue Links

https://stream-io.atlassian.net/browse/CIS-42

🎯 Goal

Add Markdown support for messages.

📝 Summary

• Add Markdown formatting for messages with proper Markdown syntax.
• Add a feature flag to enable/disable Markdown support.

🛠 Implementation

• Implement an Adapter over the SwiftyMarkdown library for Markdown support.
• Add a Regex validation to check for Markdown syntax before formatting the text.

🎨 Showcase

performance tests for containsMarkdown and format methods:

🧪 Manual Testing Notes

Markdown support is enabled by default.

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• Changelog is updated with client-facing changes
• New code is covered by unit tests
• This change follows zero ⚠️ policy (required)
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

🎁 Meme

[Stream-SDK-Bot]

	1 Error
🚫	Please start subject with capital letter. 9551990

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

[adamrushy]

Love the tests 😍 just a few questions

[emerge-tools]

⬆️ This change increases install size by 130.4 kB ⬆️

🗂 See the Emerge size breakdown

Item	Install size
➕ StreamChatUI.framework/StreamChatUI.SwiftyScanner.closeTag(withGroupID)	⬆️ 6.3 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyScanner.scanNonRepeatingTags	⬆️ 5.2 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyMarkdown.init(string)	⬆️ 4.2 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyScanner.scanRepeatingTags	⬆️ 3.9 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyTokeniser.process	⬆️ 3.8 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyMarkdown.attributedString(from)	⬆️ 3.8 kB
StreamChatUI.framework/Code Signature	⬆️ 3.1 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyScanner.scan	⬆️ 2.4 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyLineProcessor.processLineLevelAttributes	⬆️ 2.0 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyLineProcessor.processFrontMatter	⬆️ 1.8 kB
StreamChatUI.framework/Strings.Unmapped	⬆️ 1.8 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyMarkdown.font(for,characterOverride)	⬆️ 1.8 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyLineProcessor.process	⬆️ 1.8 kB
➕ StreamChatUI.framework/__C._dictionaryUpCast	⬆️ 1.7 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyTokeniser.init(with)	⬆️ 1.7 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyScanner.range(for)	⬆️ 1.7 kB
➕ StreamChatUI.framework/StreamChatUI.SwiftyMarkdown.Objc Metadata	⬆️ 1.6 kB
StreamChatUI.framework/DYLD.Lazy Bind	⬆️ 1.4 kB
StreamChatUI.framework/DYLD.Exports	⬆️ 1.3 kB
StreamChatUI.framework/Swift._ArrayBufferProtocol.replaceSubrange(with,elementsOf)	⬆️ 1.2 kB

🔎 See the full analysis (557ab61) merging into develop (ace2a6d)

Provide a baseSha and pullRequestNumber with your upload to ensure diffs are correct. Read more in the docs

[tbarbugli]

It is good to include documentation for new features. This is needed for customers + it makes development easier in general (easier to review and develop + when we release docs are already on the site).

Good to run (or mention in the PR that you did) UI performance tests on this feature. Even a manual test on large channels and/or channel list would be great.
Some stuff is actually very easy to test in code, you can bench tests containsMarkdown and format functions very easily with self.measure {}

[evsaev]

LGTM!

[bielikb]

Just a few comments related to docs + API

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information