Skip to content
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

(parser) plugin callbacks for highlight #2395

Merged
merged 7 commits into from
Mar 1, 2020
Merged

(parser) plugin callbacks for highlight #2395

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4596e04
callbacks for highlight
joshgoebel Feb 6, 2020
acae743
wrap it up much nicer
joshgoebel Feb 9, 2020
5f14e52
autoHighlight calls private _highlight interally
joshgoebel Feb 10, 2020
29e1d7b
simpler naming
joshgoebel Feb 19, 2020
686ec44
docs
joshgoebel Feb 29, 2020
cad4aa7
update api docs
joshgoebel Feb 29, 2020
779790d
add readme
joshgoebel Mar 1, 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
Prev Previous commit
Next Next commit
wrap it up much nicer
  • Loading branch information
@joshgoebel
joshgoebel committed Mar 1, 2020
commit acae7434913c0c907a5e94b1ab3f8a9d1faa32b2
35 changes: 21 additions & 14 deletions src/highlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,16 +94,30 @@ const HLJS = function(hljs) {
* @property {boolean} illegal - indicates whether any illegal matches were found
*/
function highlight(languageName, code, ignore_illegals, continuation) {
var codeToHighlight;
var context = {
originalCode: code,
language: languageName
}
// the plugin can change the desired language or the code to be highlighted
// just be changing the object it was passed
fire("before:highlight", context);
codeToHighlight = context.originalCode;
languageName = context.language;

// a before plugin can usurp the result completely by providing it's own
// in which case we don't even need to call highlight
var result = context.result ?
context.result :
_highlight(context.language, context.originalCode, ignore_illegals, continuation);

result.originalCode = context.originalCode;
// the plugin can change anything in result to suite it
fire("after:highlight", result);

return result;
}

// private highlight that's used internally and does not fire callbacks
function _highlight(languageName, code, ignore_illegals, continuation) {
var codeToHighlight = code;

function endOfMode(mode, lexeme) {
if (regex.startsWith(mode.endRe, lexeme)) {
Expand Down Expand Up @@ -167,7 +181,7 @@ const HLJS = function(hljs) {
}

var result = explicit ?
highlight(top.subLanguage, mode_buffer, true, continuations[top.subLanguage]) :
_highlight(top.subLanguage, mode_buffer, true, continuations[top.subLanguage]) :
highlightAuto(mode_buffer, top.subLanguage.length ? top.subLanguage : undefined);

// Counting embedded language score towards the host language may be disabled
Expand Down Expand Up @@ -340,7 +354,6 @@ const HLJS = function(hljs) {
var relevance = 0;
var match, processedCount, index = 0;

var returnValue;
try {
while (true) {
top.terminators.lastIndex = index;
Expand All @@ -356,7 +369,7 @@ const HLJS = function(hljs) {
emitter.finalize();
result = emitter.toHTML();

returnValue = {
return {
relevance: relevance,
value: result,
language: languageName,
Expand All @@ -366,7 +379,7 @@ const HLJS = function(hljs) {
};
} catch (err) {
if (err.message && err.message.includes('Illegal')) {
returnValue = {
return {
illegal: true,
illegalBy: {
msg: err.message,
Expand All @@ -379,7 +392,7 @@ const HLJS = function(hljs) {
emitter: emitter,
};
} else if (SAFE_MODE) {
returnValue = {
return {
relevance: 0,
value: escape(codeToHighlight),
emitter: emitter,
Expand All @@ -391,12 +404,6 @@ const HLJS = function(hljs) {
throw err;
}
}

returnValue.originalCode = codeToHighlight;
// the plugin can change anything in returnValue to suite it
fire("after:highlight", returnValue);

return returnValue;
}

/*
Expand Down