Fix #41 - Add auto_detection option to control hljs' language detection feature #43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add more test cases even with / without pre option
Phryxia
commented
Sep 17, 2022
| t.should("A Showdown extension for highlight the code blocks.", () => { | ||
| // Now you can Highlight code blocks | ||
| let html = converter.makeHtml(` | ||
| const CODEBLOCK_WITH_LANGUAGE = ` |
There was a problem hiding this comment.
Since it's repetitively used, I extracted as constant.
| \`\`\`` | ||
|
|
||
| // After requiring the module, use it as extension | ||
| const converter = new showdown.Converter({ |
There was a problem hiding this comment.
Since converter is not changed, I used const.
Comment on lines
+44
to
+47
| if (!lang && !auto_detection) { | ||
| return wholeMatch | ||
| } | ||
|
|
There was a problem hiding this comment.
Early return if auto_detection is false and there is no language information. This prevents redundant operations.
Phryxia
commented
Sep 18, 2022
| auto_detection: boolean | ||
| } | ||
|
|
||
| declare function showdownHighlight(options?: Partial<ShowdownHighlightOptions>): ShowdownExtension[]; |
There was a problem hiding this comment.
Since its implementation has default parameter and default destructured value, it should be optional. Also Boolean is not desirable for modern TypeScript declaration. #note
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue
#41
Changes
auto_detectionoption to enable/bypass hljs' language detectionauto_detectionistrue, it works equivalent to previous versionauto_detectionisfalse, originally matched HTML fragment will be returned without any changesclass="hljs"at alltrueto preserve compatibilityPartialconstexampleandDOCUMENTATION.For more details, please checkout my self review.
Note
blahrelated proper boilerplates in this repository. ButREAMDEsays no modification is allowed as it is generated fromblah. If I just runblah --readmeand this will erase almost everything. We should fix this, or just add manually toREADME.