Exclude some languages in code highlighting

[corvofeng]

Signed-off-by: corvofeng corvofeng@gmail.com

What does it do?

Only wrap some languages' code with <pre> and <code>, and do no render all tags(span, and br) in content, so that user could process those languages ​​freely.

How to test

git clone -b exclude_highlight_lang https://github.com/corvofeng/hexo.git
cd hexo
npm install
npm test

How to use?

config.yaml:

highlight:
  enable: true
  line_number: true
  auto_detect: false
  exclude_languages:
    - flowchartjs-code

Blog code:

```flowchartjs-code
st=>start: Start:>http://www.bing.com[blank]
e=>end:>http://www.bing.com
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: Yes
or No?:>http://www.google.com
io=>inputoutput: catch something...
para=>parallel: parallel tasks

st->op1->cond
cond(yes)->io->e
cond(no)->para
para(path1, bottom)->sub1(right)->op1
para(path2, top)->op1
```

You will get:

<code class="highlight flowchartjs-code">st=&gt;start: Start:&gt;http://www.bing.com[blank]
e=&gt;end:&gt;http://www.bing.com
op1=&gt;operation: My Operation
sub1=&gt;subroutine: My Subroutine
cond=&gt;condition: Yes
or No?:&gt;http://www.google.com
io=&gt;inputoutput: catch something...
para=&gt;parallel: parallel tasks

st-&gt;op1-&gt;cond
cond(yes)-&gt;io-&gt;e
cond(no)-&gt;para
para(path1, bottom)-&gt;sub1(right)-&gt;op1
para(path2, top)-&gt;op1</code>

Pull request tasks

• Add test cases for the changes.
• Passed the CI test.

[coveralls]

Coverage increased (+0.002%) to 98.301% when pulling bf18425 on corvofeng:exclude_highlight_lang into 1f9755e on hexojs:master.

[curbengh]

Requires #3827

[curbengh]

I just started testing this,

Only wrap some languages' code with <pre> and <code>, and do no render all tags(span, and br) in content, so that user could process those languages ​​freely.

By "render", you mean html escape?

I tried

if (options.exclude_languages) {
  if (options.exclude_languages.includes(options.lang)) {
    options.wrap = false;
<br>
    options.gutter = false;
    options.autoDetect = false;
  }
}

<br> is still escaped, even when highlight.enable is disabled.

Looks like exclude_wrap: [] option is more accurate?

[corvofeng]

I just started testing this,

Only wrap some languages' code with <pre> and <code>, and do no render all tags(span, and br) in content, so that user could process those languages ​​freely.

By "render", you mean html escape?

I tried

if (options.exclude_languages) {
  if (options.exclude_languages.includes(options.lang)) {
    options.wrap = false;
<br>
    options.gutter = false;
    options.autoDetect = false;
  }
}

<br> is still escaped, even when highlight.enable is disabled.

Looks like exclude_wrap: [] option is more accurate?

Well, in my blogs, when I work with my latest changes and hexo-util@1.8.0, I could get the proper result which does not include <br>. Would you like to use hexo clean firstly, and then check the result. This option should only work when the highlight is enabled

exclude_wrap is also fine, but I strongly recommend add languages or langs postfix because it is an array of a few languages.

[stevenjoezhang]

There will be other code highlighting engines added to Hexo: #4119
I suggest you implement this feature using custom tags, e.g.

{% flowchartjscode %}
st=>start: Start:>http://www.bing.com[blank]
e=>end:>http://www.bing.com
{% endflowchartjscode %}

This looks more clear than
```flowchartjs-code
st=>start: Start:>http://www.bing.com[blank]
e=>end:>http://www.bing.com
```

[corvofeng]

There will be other code highlighting engines added to Hexo: #4119
I suggest you implement this feature using custom tags, e.g.

{% flowchartjscode %}
st=>start: Start:>http://www.bing.com[blank]
e=>end:>http://www.bing.com
{% endflowchartjscode %}

This looks more clear than

st=>start: Start:>[http://www.bing.com[blank]](http://www.bing.com%5Bblank%5D)
e=>end:>http://www.bing.com

Well, I have downloaded that branch and tested it, and it may somehow achieve the function I requested. But I have a question: why not let the hexo user decide when the code should be rendered(in the hexo building or in the browser loading).

[stevenjoezhang]

Please make it compatible with #4119 thanks

[SukkaW]

@stevenjoezhang

Will, we could merge #4119 first, and then I will bring up the feature in another PR.

[corvofeng]

@SukkaW @stevenjoezhang @curbengh

I have rebased this PR based on the latest master branch, could anyone merge it or give me some advice? I don’t want to be forgotten after a long time, because I really need this feature.

[ghost]

LGTM

[github-actions]

How to test

git clone -b exclude_highlight_lang https://github.com/hexojs/hexo.git
cd hexo
npm install
npm test

[SukkaW]

The failed test is fixed in #4902, not caused by the PR itself. The change LGTM.

[D-Sketon]

I try to exclude java in highlight like this:

highlight:
  enable: true
  line_number: true
  auto_detect: false
  tab_replace: ''
  wrap: true
  hljs: false
  exclude_languages:
    - java 

But I find that tags still exist, is this expected behavior?🤔🤔