Skip to content

feat($code-highlight): add doc highlight #2618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

feat($code-highlight): add doc highlight #2618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54c3810
chore: update prismjs to 1.21.0
troy351 Sep 18, 2020
e47fd3b
feat($code-highlight): add doc highlight
troy351 Sep 19, 2020
53957d0
code-highlight: fixed test error
troy351 Sep 19, 2020
3451ec8
fix test error
troy351 Sep 19, 2020
18c9856
fixed lint error
troy351 Sep 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion packages/@vuepress/markdown/lib/highlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,30 @@ function getLangCodeFromExtension (extension) {
yml: 'yaml',
styl: 'stylus',
kt: 'kotlin',
rs: 'rust'
rs: 'rust',
cs: 'csharp',
fs: 'fsharp'
}

return extensionMap[extension] || extension
}

function getDocLangCodeFromLang (lang) {
const docMap = {
'js': 'jsdoc',
'javascript': 'jsdoc',
'typescript': 'jsdoc',
'markup': 'jsdoc',
'java': 'javadoc',
'php': 'phpdoc',
'csharp': 'xml-doc',
'fsharp': 'xml-doc',
'vbnet': 'xml-doc'
}

return docMap[lang]
}

Comment on lines +35 to +50
Copy link
Collaborator

@d-pollard d-pollard Oct 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do these come from? mind providing some context?

Copy link
Author

@troy351 troy351 Oct 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was from https://github.com/PrismJS/prism/blob/master/components.json , searching for the keyword doc" and arranged myself.
The original PrismJS PR: PrismJS/prism#1541 PrismJS/prism#2340

PS. I was trying to add "js":"javascript" into getLangCodeFromExtension just like "ts":"typescript" to avoid duplicate of line 37 & 38 but causing unexpected behavior, so I give up

module.exports = (str, lang) => {
if (!lang) {
return wrap(str, 'text')
Expand All @@ -46,6 +64,16 @@ module.exports = (str, lang) => {
logger.warn(chalk.yellow(`[vuepress] Syntax highlight for language "${lang}" is not supported.`))
}
}

const docLang = getDocLangCodeFromLang(lang)
if (docLang && !prism.languages[docLang]) {
Copy link
Collaborator

@d-pollard d-pollard Oct 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're doing this check here, wouldn't we also need to do the same check on line 77?

Copy link
Author

@troy351 troy351 Oct 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Loading the corresponding doc-language before the language itself, but not all language has its doc-language, I think it's fine here

try {
loadLanguages([docLang])
} catch (e) {
logger.warn(chalk.yellow(`[vuepress] Syntax highlight for language "${docLang}" is not supported.`))
}
}

if (prism.languages[lang]) {
const code = prism.highlight(str, prism.languages[lang], lang)
return wrap(code, rawLang)
Expand Down
2 changes: 1 addition & 1 deletion packages/@vuepress/markdown/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"markdown-it-chain": "^1.3.0",
"markdown-it-emoji": "^1.4.0",
"markdown-it-table-of-contents": "^0.4.0",
"prismjs": "^1.13.0"
"prismjs": "^1.21.0"
},
"publishConfig": {
"access": "public"
Expand Down