mirror of
https://github.com/chatwoot/chatwoot.git
synced 2026-06-13 21:01:16 +08:00
# Pull Request Template ## Description Fixes https://linear.app/chatwoot/issue/CW-6903/signature-delimiter-renders-as-h2-when-using-enter-line-before **1**. Fixes an issue where the signature delimiter `--` gets parsed as an H2 when using **Enter** (new paragraph) before or after it, causing it to render as a bold `\` in the message bubble. * Ensures `--` renders as plain text * Aligns renderer with parser behavior (both disable `lheading`) * Prevents stray `\` from appearing as heading text **2**. Also fixes a related editor issue where toggling signature **off** leaves behind a stray `\` or `-- \`. * Strips blank paragraph markers (`\`) and dangling hard breaks (`\<newline>`) from ProseMirror serializer * Applied in both `appendSignature` and `removeSignature` * Replaces `trimEnd()` with shared helpers (`trimTrailingBlanks` / `stripTrailingBlankMarkers`) ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? #### Screenshots **Before** <img width="194" height="204" alt="image" src="https://github.com/user-attachments/assets/b286ab50-7f89-4910-a552-1568902b93b3" /> **After** <img width="194" height="220" alt="image" src="https://github.com/user-attachments/assets/658cd543-bce2-46e2-a319-35e5374f1aef" /> **Editor** https://linear.app/chatwoot/issue/CW-6903/signature-delimiter-renders-as-in-h2-when-using-enter-line#comment-5814b882 ### Steps #### Editor 1. Enable agent signature 2. Add and remove new lines around the signature using Enter/shift enter 3. Toggle signature off 4. Notice stray `\` or `-- \` remains #### Bubble 1. Enable agent signature 2. Send a message using Enter between lines 3. Verify `--` renders correctly (no H2, no bold `\`) ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Muhsin Keloth <[email protected]>
105 lines
2.7 KiB
JavaScript
105 lines
2.7 KiB
JavaScript
import mila from 'markdown-it-link-attributes';
|
|
import mentionPlugin from './markdownIt/link';
|
|
import MarkdownIt from 'markdown-it';
|
|
|
|
const setImageHeight = inlineToken => {
|
|
const imgSrc = inlineToken.attrGet('src');
|
|
if (!imgSrc) return;
|
|
const url = new URL(imgSrc);
|
|
const height = url.searchParams.get('cw_image_height');
|
|
if (!height) return;
|
|
inlineToken.attrSet('style', `height: ${height};`);
|
|
};
|
|
|
|
const processInlineToken = blockToken => {
|
|
blockToken.children.forEach(inlineToken => {
|
|
if (inlineToken.type === 'image') {
|
|
setImageHeight(inlineToken);
|
|
}
|
|
});
|
|
};
|
|
|
|
const imgResizeManager = md => {
|
|
// Custom rule for image resize in markdown
|
|
// If the image url has a query param cw_image_height, then add a style attribute to the image
|
|
md.core.ruler.after('inline', 'add-image-height', state => {
|
|
state.tokens.forEach(blockToken => {
|
|
if (blockToken.type === 'inline') {
|
|
processInlineToken(blockToken);
|
|
}
|
|
});
|
|
});
|
|
};
|
|
|
|
const createMarkdownInstance = (linkify = true) => {
|
|
return MarkdownIt({
|
|
html: false,
|
|
xhtmlOut: true,
|
|
breaks: true,
|
|
langPrefix: 'language-',
|
|
linkify,
|
|
typographer: true,
|
|
quotes: '\u201c\u201d\u2018\u2019',
|
|
maxNesting: 20,
|
|
})
|
|
.disable(['lheading'])
|
|
.use(mentionPlugin)
|
|
.use(imgResizeManager)
|
|
.use(mila, {
|
|
attrs: {
|
|
class: 'link',
|
|
rel: 'noreferrer noopener nofollow',
|
|
target: '_blank',
|
|
},
|
|
});
|
|
};
|
|
|
|
const TWITTER_USERNAME_REGEX = /(^|[^@\w])@(\w{1,15})\b/g;
|
|
const TWITTER_USERNAME_REPLACEMENT = '$1[@$2](http://twitter.com/$2)';
|
|
const TWITTER_HASH_REGEX = /(^|\s)#(\w+)/g;
|
|
const TWITTER_HASH_REPLACEMENT = '$1[#$2](https://twitter.com/hashtag/$2)';
|
|
|
|
class MessageFormatter {
|
|
constructor(
|
|
message,
|
|
isATweet = false,
|
|
isAPrivateNote = false,
|
|
linkify = true
|
|
) {
|
|
this.message = message || '';
|
|
this.isAPrivateNote = isAPrivateNote;
|
|
this.isATweet = isATweet;
|
|
this.linkify = linkify;
|
|
this.md = createMarkdownInstance(linkify);
|
|
}
|
|
|
|
formatMessage() {
|
|
let updatedMessage = this.message;
|
|
if (this.isATweet && !this.isAPrivateNote) {
|
|
updatedMessage = updatedMessage.replace(
|
|
TWITTER_USERNAME_REGEX,
|
|
TWITTER_USERNAME_REPLACEMENT
|
|
);
|
|
updatedMessage = updatedMessage.replace(
|
|
TWITTER_HASH_REGEX,
|
|
TWITTER_HASH_REPLACEMENT
|
|
);
|
|
}
|
|
return this.md.render(updatedMessage);
|
|
}
|
|
|
|
get formattedMessage() {
|
|
return this.formatMessage();
|
|
}
|
|
|
|
get plainText() {
|
|
const strippedOutHtml = new DOMParser().parseFromString(
|
|
this.formattedMessage,
|
|
'text/html'
|
|
);
|
|
return strippedOutHtml.body.textContent || '';
|
|
}
|
|
}
|
|
|
|
export default MessageFormatter;
|